eZPublish  3.8
eZWizardBase Class Reference

The class eZWizardBase does. More...

Public Member Functions

attribute ($attr)
 
 attributes ()
 
 cleanup ()
 
 eZWizardBase (&$tpl, &$module, $storageName=false)
 
 hasAttribute ($attr)
 
 hasMetaData ($key)
 
 hasVariable ($key)
 
 initialize ()
 
 metaData ($key)
 
 nextStep ()
 
 previousStep ()
 
 process ()
 
 run ()
 
 savePersistentData ()
 
 setMetaData ($key, $value)
 
 setVariable ($key, $value)
 
variable ($key)
 
 variableList ()
 

Public Attributes

 $ErrorList = array()
 
 $HTTP
 
 $MetaData = array()
 
 $MetaDataName = '_meta'
 
 $Module
 
 $StepArray = array()
 
 $StepList = array()
 
 $StepTemplateBase = 'design:wizard/step'
 
 $StorageName = 'eZWizard'
 
 $Tpl
 
 $VariableList = array()
 
 $VariableListName = '_data'
 
 $WarningList = array()
 
 $WizardURL = ''
 

Private Member Functions

 postCheck ()
 
 preCheck ()
 
 skip ()
 
 stepTemplate ()
 

Detailed Description

The class eZWizardBase does.

Member Function Documentation

& eZWizardBase::attribute (   $attr)
eZWizardBase::attributes ( )

Referenced by hasAttribute().

eZWizardBase::cleanup ( )

Cleanup variables used during wizard

eZWizardBase::eZWizardBase ( $tpl,
$module,
  $storageName = false 
)

Constructor

Parameters
Templateclass
Module
StorageName, optional.
eZWizardBase::hasAttribute (   $attr)
eZWizardBase::hasMetaData (   $key)

Check if has metadata value

Referenced by initialize().

eZWizardBase::hasVariable (   $key)

Check if wizard variable exists

Parameters
variablekey
Returns
variable value
eZWizardBase::initialize ( )

Set needed variables.

Referenced by eZWizardBase().

eZWizardBase::metaData (   $key)

Get metadata

Referenced by nextStep(), previousStep(), run(), and stepTemplate().

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().

eZWizardBase::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 ( )

Save persistent data

Referenced by nextStep(), previousStep(), setMetaData(), and setVariable().

eZWizardBase::setMetaData (   $key,
  $value 
)

Store meta data.

Parameters
key
value

Referenced by initialize(), nextStep(), and previousStep().

eZWizardBase::setVariable (   $key,
  $value 
)

Store variable. Variable/value will be available in current and next wizard steps.

Parameters
key
value
eZWizardBase::skip ( )
private

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
key
Returns
value
eZWizardBase::variableList ( )

Return variable list.

Returns
variable list

Referenced by attribute().

Member Data Documentation

eZWizardBase::$ErrorList = array()

Referenced by attribute().

eZWizardBase::$HTTP
eZWizardBase::$MetaData = array()
eZWizardBase::$MetaDataName = '_meta'
eZWizardBase::$Module
eZWizardBase::$StepArray = array()
eZWizardBase::$StepList = array()
eZWizardBase::$StepTemplateBase = 'design:wizard/step'
eZWizardBase::$StorageName = 'eZWizard'
eZWizardBase::$Tpl
eZWizardBase::$VariableList = array()

Referenced by variableList().

eZWizardBase::$VariableListName = '_data'
eZWizardBase::$WarningList = array()

Referenced by attribute().

eZWizardBase::$WizardURL = ''

Referenced by attribute().


The documentation for this class was generated from the following file: