The class eZWizardBase does.
More...
The class eZWizardBase does.
eZWizardBase::attribute |
( |
|
$attr | ) |
|
eZWizardBase::attributes |
( |
| ) |
|
eZWizardBase::cleanup |
( |
| ) |
|
Cleanup variables used during wizard
eZWizardBase::eZWizardBase |
( |
|
$tpl, |
|
|
& |
$module, |
|
|
|
$storageName = false |
|
) |
| |
Constructor
- Parameters
-
$tpl | Template class |
$module | Module |
$storageName | Storage Name, optional. |
eZWizardBase::hasAttribute |
( |
|
$attr | ) |
|
eZWizardBase::hasMetaData |
( |
|
$key | ) |
|
eZWizardBase::hasVariable |
( |
|
$key | ) |
|
Check if wizard variable exists
- Parameters
-
- Returns
- variable value
eZWizardBase::initialize |
( |
| ) |
|
eZWizardBase::metaData |
( |
|
$key | ) |
|
eZWizardBase::nextStep |
( |
| ) |
|
Increate Step counter
Referenced by run().
eZWizardBase::postCheck |
( |
| ) |
|
|
private |
Post check current step to check that it's safe to continue to next step. Return false if current step should be processed once again, and set warning message
- Returns
- true if everything ok false if not
Referenced by run().
eZWizardBase::preCheck |
( |
| ) |
|
|
private |
Pre check current step to check that it's safe to execute current step. Return false if current step should not be processed, and set warning message
- Returns
- true if everything ok false if not
Referenced by run().
eZWizardBase::previousStep |
( |
| ) |
|
Go back to previous step
Referenced by run().
eZWizardBase::process |
( |
| ) |
|
Process the current step, and present the HTML.
- Returns
- Module Result
Referenced by run().
Will run the wizard, and continue from the current step. This method will run postCheck, redirect to next, etc. depending on the current state.
return Module Result or module redirect.
eZWizardBase::savePersistentData |
( |
| ) |
|
eZWizardBase::setMetaData |
( |
|
$key, |
|
|
|
$value |
|
) |
| |
eZWizardBase::setVariable |
( |
|
$key, |
|
|
|
$value |
|
) |
| |
Store variable. Variable/value will be available in current and next wizard steps.
- Parameters
-
Return true to skip current step. Current step will not be processed.
- Returns
- true skip current step. false - perform current step.
Referenced by run().
eZWizardBase::stepTemplate |
( |
| ) |
|
|
private |
Get Step template name.
- Returns
- current step template
Referenced by attribute().
& eZWizardBase::variable |
( |
|
$key | ) |
|
Get stored wizard values.
- Parameters
-
- Returns
- value
eZWizardBase::variableList |
( |
| ) |
|
Return variable list.
- Returns
- variable list
Referenced by attribute().
eZWizardBase::$ErrorList = array() |
eZWizardBase::$MetaData = array() |
eZWizardBase::$MetaDataName = '_meta' |
eZWizardBase::$StepArray = array() |
eZWizardBase::$StepList = array() |
eZWizardBase::$StepTemplateBase = 'design:wizard/step' |
eZWizardBase::$StorageName = 'eZWizard' |
eZWizardBase::$VariableList = array() |
eZWizardBase::$VariableListName = '_data' |
eZWizardBase::$WarningList = array() |
eZWizardBase::$WizardURL = '' |
const eZWizardBase::STAGE_POST = 1 |
const eZWizardBase::STAGE_PRE = 0 |
The documentation for this class was generated from the following file: