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 = ''
const	STAGE_POST = 1
const	STAGE_PRE = 0
Private Member Functions
	postCheck ()
	preCheck ()
	skip ()
	stepTemplate ()

Detailed Description

The class eZWizardBase does.

Definition at line 40 of file ezwizardbase.php.

Member Function Documentation

eZWizardBase::attribute ( $ attr )

Definition at line 100 of file ezwizardbase.php.

eZWizardBase::attributes ( )

Definition at line 84 of file ezwizardbase.php.

Referenced by hasAttribute().

eZWizardBase::cleanup ( )

Cleanup variables used during wizard

Definition at line 340 of file ezwizardbase.php.

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

Constructor

Parameters:

$tpl	Template class
$module	Module
$storageName	Storage Name, optional.

Definition at line 52 of file ezwizardbase.php.

eZWizardBase::hasAttribute ( $ attr )

Definition at line 95 of file ezwizardbase.php.

eZWizardBase::hasMetaData ( $ key )

Check if has metadata value

Definition at line 271 of file ezwizardbase.php.

Referenced by initialize().

eZWizardBase::hasVariable ( $ key )

Check if wizard variable exists

Parameters:

$key	key of the variable

Returns:: variable value

Definition at line 311 of file ezwizardbase.php.

eZWizardBase::initialize ( )

Set needed variables.

Definition at line 71 of file ezwizardbase.php.

Referenced by eZWizardBase().

eZWizardBase::metaData ( $ key )

Get metadata

Definition at line 263 of file ezwizardbase.php.

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

eZWizardBase::nextStep ( )

Increate Step counter

Definition at line 363 of file ezwizardbase.php.

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

Definition at line 211 of file ezwizardbase.php.

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

Definition at line 197 of file ezwizardbase.php.

Referenced by run().

eZWizardBase::previousStep ( )

Go back to previous step

Definition at line 351 of file ezwizardbase.php.

Referenced by run().

eZWizardBase::process ( )

Process the current step, and present the HTML.

Returns:: Module Result

Definition at line 241 of file ezwizardbase.php.

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.

Definition at line 154 of file ezwizardbase.php.

eZWizardBase::savePersistentData ( )

Save persistent data

Definition at line 383 of file ezwizardbase.php.

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

eZWizardBase::setMetaData	(	$	key,
		$	value
	)

Store meta data.

Parameters:

key
value

Definition at line 251 of file ezwizardbase.php.

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

Definition at line 282 of file ezwizardbase.php.

eZWizardBase::skip ( ) [private]

Return true to skip current step. Current step will not be processed.

Returns:: true skip current step. false - perform current step.

Definition at line 230 of file ezwizardbase.php.

Referenced by run().

eZWizardBase::stepTemplate ( ) [private]

Get Step template name.

Returns:: current step template

Definition at line 332 of file ezwizardbase.php.

Referenced by attribute().

& eZWizardBase::variable ( $ key )

Get stored wizard values.

Parameters:

key

Returns:: value

Definition at line 295 of file ezwizardbase.php.

eZWizardBase::variableList ( )

Return variable list.

Returns:: variable list

Definition at line 321 of file ezwizardbase.php.

Referenced by attribute().

Member Data Documentation

eZWizardBase::$ErrorList = array()

Definition at line 390 of file ezwizardbase.php.

eZWizardBase::$HTTP

Definition at line 396 of file ezwizardbase.php.

eZWizardBase::$MetaData = array()

Definition at line 403 of file ezwizardbase.php.

eZWizardBase::$MetaDataName = '_meta'

Definition at line 405 of file ezwizardbase.php.

eZWizardBase::$Module

Definition at line 398 of file ezwizardbase.php.

eZWizardBase::$StepArray = array()

Definition at line 412 of file ezwizardbase.php.

eZWizardBase::$StepList = array()

Definition at line 394 of file ezwizardbase.php.

eZWizardBase::$StepTemplateBase = 'design:wizard/step'

Definition at line 409 of file ezwizardbase.php.

eZWizardBase::$StorageName = 'eZWizard'

Definition at line 404 of file ezwizardbase.php.

eZWizardBase::$Tpl

Definition at line 397 of file ezwizardbase.php.

eZWizardBase::$VariableList = array()

Definition at line 402 of file ezwizardbase.php.

eZWizardBase::$VariableListName = '_data'

Definition at line 406 of file ezwizardbase.php.

eZWizardBase::$WarningList = array()

Definition at line 391 of file ezwizardbase.php.

eZWizardBase::$WizardURL = ''

Definition at line 399 of file ezwizardbase.php.

const eZWizardBase::STAGE_POST = 1

Definition at line 43 of file ezwizardbase.php.

Referenced by nextStep(), and run().

const eZWizardBase::STAGE_PRE = 0

Definition at line 42 of file ezwizardbase.php.

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

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

ezwizardbase.php

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation