The class eZModuleOperationInfo does. More...

Public Member Functions
	callClassMethod ($methodName, $classObject, $parameterArray)
	execute ($operationName, $operationParameters, $mementoData=null)
	Executes the operation.
	executeBody ($includeFile, $className, $bodyStructure, $operationKeys, $operationParameterDefinitions, $operationParameters, &$mementoData, &$bodyCallCount, $operationName, $currentLoopData=null)
	Executes the operation body.
	executeClassMethod ($includeFile, $className, $methodName, $operationParameterDefinitions, $operationParameters)
	Executes a class method in an operation body.
	executeTrigger (&$bodyReturnValue, $body, $operationParameterDefinitions, $operationParameters, &$bodyCallCount, $currentLoopData, $triggerRestored, $operationName, &$operationKeys)
	Executes an operation trigger.
	eZModuleOperationInfo ($moduleName, $useTriggers=true)
	Constructor.
	isValid ()
	???
	loadDefinition ()
	Loads the operations definition for the current module.
	makeKeyArray ($keyDefinition, $parameterDefinition, $operationParameters)
	makeOperationKeyArray ($operationDefinition, $operationParameters)
	removeBodyMemento ($bodyName, $bodyKeys, $operationKeys, $operationParameterDefinitions, $operationParameters, &$bodyCallCount, $currentLoopData, $operationName)
	restoreBodyMementoData ($bodyName, &$mementoData, &$operationParameters, &$bodyCallCount, &$currentLoopData)
	storeBodyMemento ($bodyName, $bodyKeys, $operationKeys, $operationParameterDefinitions, $operationParameters, &$bodyCallCount, $currentLoopData, $operationName)
	Packs the current body data (memento) for save & re-use.
	storeOperationMemento ($operationKeys, $operationParameterDefinitions, $operationParameters, &$bodyCallCount, $operationName)
Public Attributes
	$FunctionList
	$IsValid
	$ModuleName
	$UseTriggers = false
const	ERROR_CLASS_INSTANTIATE_FAILED = 7
const	ERROR_MISSING_PARAMETER = 8
const	ERROR_NO_CLASS = 5
const	ERROR_NO_CLASS_METHOD = 6
const	STATUS_CANCELLED = 2
const	STATUS_CONTINUE = 1
const	STATUS_HALTED = 3
const	STATUS_REPEAT = 4
Private Member Functions
	objectForClass ($className)
	Helper method that keeps and returns the instances of operation objects.

Detailed Description

The class eZModuleOperationInfo does.

Definition at line 40 of file ezmoduleoperationinfo.php.

Member Function Documentation

eZModuleOperationInfo::callClassMethod	(	$	methodName,
		$	classObject,
		$	parameterArray
	)

Deprecated:: use call_user_func_array() instead

Definition at line 868 of file ezmoduleoperationinfo.php.

eZModuleOperationInfo::execute	(	$	operationName,
		$	operationParameters,
		$	mementoData = `null`
	)

Executes the operation.

Parameters:

string	$operationName
array	$operationParameters
array	$mementoData

Returns:: mixed the operation execution result, or null if an error occured

Definition at line 148 of file ezmoduleoperationinfo.php.

eZModuleOperationInfo::executeBody	(	$	includeFile,
		$	className,
		$	bodyStructure,
		$	operationKeys,
		$	operationParameterDefinitions,
		$	operationParameters,
		&$	mementoData,
		&$	bodyCallCount,
		$	operationName,
		$	currentLoopData = `null`
	)

Executes the operation body.

Parameters:

string	$includeFile	Path to the file where the operation class is defined
string	$className	Name of the class holding the operation methods (

See also:: $includeFile)

Parameters:

array	$bodyStructure
array	$operationKeys
array	$operationParameterDefinitions
array	$operationParameters
array	$mementoData
int	$bodyCallCount
string	$operationName
array	$currentLoopData

Returns:: array

Definition at line 373 of file ezmoduleoperationinfo.php.

Referenced by execute().

eZModuleOperationInfo::executeClassMethod	(	$	includeFile,
		$	className,
		$	methodName,
		$	operationParameterDefinitions,
		$	operationParameters
	)

Executes a class method in an operation body.

Parameters:

string	$includeFile	The file where the class & method are defined
string	$className	The class where the method is implemented
string	$methodName	The method to call
mixed	$operationParameterDefinitions	The method parameters definition
mixed	$operationParameters	The method parameters values

Returns:: array

Definition at line 786 of file ezmoduleoperationinfo.php.

Referenced by executeBody().

eZModuleOperationInfo::executeTrigger	(	&$	bodyReturnValue,
		$	body,
		$	operationParameterDefinitions,
		$	operationParameters,
		&$	bodyCallCount,
		$	currentLoopData,
		$	triggerRestored,
		$	operationName,
		&$	operationKeys
	)

Executes an operation trigger.

Parameters:

array	$bodyReturnValue	The current return value
array	$body	Body data for the trigger being executed
array	$operationParameterDefinitions	Operation parameters definition
array	$operationParameters	Operation parameters values
int	$bodyCallCount	Number of times the body was called
array	$currentLoopData	Memento data for the operation
bool	$triggerRestored	Boolean that indicates if operation data (memento) was restored
string	$operationName	The operation name
array	$operationKeys	Additional parameters. Only used by looping so far.

Returns:

Definition at line 611 of file ezmoduleoperationinfo.php.

Referenced by executeBody().

eZModuleOperationInfo::eZModuleOperationInfo	(	$	moduleName,
		$	useTriggers = `true`
	)

Constructor.

Parameters:

string	$moduleName
bool	$useTriggers

Definition at line 57 of file ezmoduleoperationinfo.php.

eZModuleOperationInfo::isValid ( )

???

Returns:: bool

Definition at line 71 of file ezmoduleoperationinfo.php.

eZModuleOperationInfo::loadDefinition ( )

Loads the operations definition for the current module.

Returns:: bool true if the operations were loaded, false if an error occured

Definition at line 80 of file ezmoduleoperationinfo.php.

eZModuleOperationInfo::makeKeyArray	(	$	keyDefinition,
		$	parameterDefinition,
		$	operationParameters
	)

Definition at line 120 of file ezmoduleoperationinfo.php.

Referenced by makeOperationKeyArray(), removeBodyMemento(), storeBodyMemento(), and storeOperationMemento().

eZModuleOperationInfo::makeOperationKeyArray	(	$	operationDefinition,
		$	operationParameters
	)

Definition at line 109 of file ezmoduleoperationinfo.php.

Referenced by execute().

eZModuleOperationInfo::objectForClass ( $ className ) [private]

Helper method that keeps and returns the instances of operation objects.

Parameters:

string $className The class the method should return an object for

Returns:: $className

Todo:: Use a static variable instead of globals

Definition at line 851 of file ezmoduleoperationinfo.php.

Referenced by executeClassMethod().

eZModuleOperationInfo::removeBodyMemento	(	$	bodyName,
		$	bodyKeys,
		$	operationKeys,
		$	operationParameterDefinitions,
		$	operationParameters,
		&$	bodyCallCount,
		$	currentLoopData,
		$	operationName
	)

Definition at line 696 of file ezmoduleoperationinfo.php.

eZModuleOperationInfo::restoreBodyMementoData	(	$	bodyName,
		&$	mementoData,
		&$	operationParameters,
		&$	bodyCallCount,
		&$	currentLoopData
	)

Definition at line 736 of file ezmoduleoperationinfo.php.

Referenced by executeBody().

eZModuleOperationInfo::storeBodyMemento	(	$	bodyName,
		$	bodyKeys,
		$	operationKeys,
		$	operationParameterDefinitions,
		$	operationParameters,
		&$	bodyCallCount,
		$	currentLoopData,
		$	operationName
	)

Packs the current body data (memento) for save & re-use.

Parameters:

string	$bodyName
array	$bodyKeys
array	$operationKeys
array	$operationParameterDefinitions
array	$operationParameters
int	$bodyCallCount
array	$currentLoopData
string	$operationName

Returns:: The memento

Definition at line 716 of file ezmoduleoperationinfo.php.

Referenced by executeTrigger().

eZModuleOperationInfo::storeOperationMemento	(	$	operationKeys,
		$	operationParameterDefinitions,
		$	operationParameters,
		&$	bodyCallCount,
		$	operationName
	)