lib/ezutils/classes/ezmoduleoperationinfo.php

Show:

inherited

Classes
- \eZModuleOperationInfo

Table of Contents

File containing the eZModuleOperationInfo class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: lib
Version: 4.6.0

\eZModuleOperationInfo
jump to top

Package: lib

File containing the eZModuleOperationInfo class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Constants

 
                ERROR_NO_CLASS
                = 5

 
                ERROR_NO_CLASS_METHOD
                = 6

 
                ERROR_CLASS_INSTANTIATE_FAILED
                = 7

 
                ERROR_MISSING_PARAMETER
                = 8

 
                STATUS_CONTINUE
                = 1

 
                STATUS_CANCELLED
                = 2

 
                STATUS_HALTED
                = 3

 
                STATUS_REPEAT
                = 4

 
                STATUS_QUEUED
                = 5

Properties


                 $FunctionList= ''

Details

Type: n/a


                 $IsValid= ''

Details

Type: n/a

\eZOperationMemento
                 $Memento= ''

Details

Type: \eZOperationMemento


                 $ModuleName= ''

Details

Type: n/a


                 $UseTriggers= 'false'

Default valuefalseDetails

Type: n/a

Methods

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

Parameters

Name	Type	Description
$methodName
$classObject
$parameterArray

Details

Deprecated: use call_user_func_array() instead

eZModuleOperationInfo(
          string $moduleName, bool $useTriggers
              =
              true
          )
        
        :
          void

Constructor

Parameters

Name	Type	Description
$moduleName	string
$useTriggers	bool

execute(
          string $operationName, array $operationParameters, array $mementoData
              =
              null
          )
        
        :
          mixed

Executes the operation

Parameters

Name	Type	Description
$operationName	string
$operationParameters	array
$mementoData	array

Returns

Type	Description
mixed	the operation execution result, or null if an error occured

executeBody(
          string $includeFile, string $className, array $bodyStructure, array $operationKeys, array $operationParameterDefinitions, array $operationParameters, array $mementoData, int $bodyCallCount, string $operationName, array $currentLoopData
              =
              null
          )
        
        :
          array

Executes the operation body

Parameters

Name	Type	Description
$includeFile	string	Path to the file where the operation class is defined
$className	string	Name of the class holding the operation methods (@see $includeFile)
$bodyStructure	array
$operationKeys	array
$operationParameterDefinitions	array
$operationParameters	array
$mementoData	array
$bodyCallCount	int
$operationName	string
$currentLoopData	array

Returns

Type	Description
array

executeClassMethod(
          string $includeFile, string $className, string $methodName, mixed $operationParameterDefinitions, mixed $operationParameters
          )
        
        :
          array

Executes a class method in an operation body

Parameters

Name	Type	Description
$includeFile	string	The file where the class /p>
$className	string	The class where the method is implemented
$methodName	string	The method to call
$operationParameterDefinitions	mixed	The method parameters definition
$operationParameters	mixed	The method parameters values

Returns

Type	Description
array

executeTrigger(
          array $bodyReturnValue, array $body, array $operationParameterDefinitions, array $operationParameters, int $bodyCallCount, array $currentLoopData, bool $triggerRestored, string $operationName, array $operationKeys
          )
        
        :

Executes an operation trigger

Parameters

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

isValid(
          
          )
        
        :
          bool

???

Returns

Type	Description
bool

loadDefinition(
          
          )
        
        :
          bool

Loads the operations definition for the current module

Returns

Type	Description
bool	true if the operations were loaded, false if an error occured

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

Parameters

Name	Type	Description
$keyDefinition
$parameterDefinition
$operationParameters

makeOperationKeyArray(
           $operationDefinition,  $operationParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$operationDefinition
$operationParameters

objectForClass(
          string $className
          )
        
        :
          \$className

Helper method that keeps and returns the instances of operation objects

Parameters

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

Returns

Type	Description
\$className

Details

Private
Todo: Use a static variable instead of globals

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

Parameters

Name	Type	Description
$bodyName
$bodyKeys
$operationKeys
$operationParameterDefinitions
$operationParameters
$bodyCallCount
$currentLoopData
$operationName

restoreBodyMementoData(
           $bodyName,  $mementoData,  $operationParameters,  $bodyCallCount,  $currentLoopData
          )
        
        :
          void

Parameters

Name	Type	Description
$bodyName
$mementoData
$operationParameters
$bodyCallCount
$currentLoopData

storeBodyMemento(
          string $bodyName, array $bodyKeys, array $operationKeys, array $operationParameterDefinitions, array $operationParameters, int $bodyCallCount, array $currentLoopData, string $operationName
          )
        
        :
          \The

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

Parameters

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

Returns

Type	Description
\The	memento

storeOperationMemento(
           $operationKeys,  $operationParameterDefinitions,  $operationParameters,  $bodyCallCount,  $operationName
          )
        
        :
          void

Parameters

Name	Type	Description
$operationKeys
$operationParameterDefinitions
$operationParameters
$bodyCallCount
$operationName

lib/ezutils/classes/ezmoduleoperationinfo.php

\eZModuleOperationInfojump to top

Constants

Properties

Methods

\eZModuleOperationInfo
jump to top