CONTENIDO_API 4.8.16 CL
Back to top  

CEC chain item class.

author Timo A. Hummel
author Murat Purc
package Contenido Backend classes
subpackage CEC

 Methods

Constructor, sets the CEC chain item properties.

__construct(string $sChainName, string $sFunctionName, array $aParameters) : void

Parameters

$sChainName

string

$sFunctionName

string

$aParameters

array

Invokes the CEC function/callback.

execute() : mixed

Returns

mixedIf available, the result of the CEC function/callback

Returns the callback

getCallback() : string | array

Returns

stringarray

Returns the chain name

getChainName() : string

Returns

string

Returns the function name

getFunctionName() : string

Returns

string

Returns the function name

getParameters() : array

Returns

array

Will be invoked by execute() method. If temporary arguments where set before, it returns them and resets the property.

getTemporaryArguments() : void

Sets the callback

setCallback($callback) : string | array

Parameters

$callback

Returns

stringarray

Sets the chain name

setChainName(string $sChainName) : void

Parameters

$sChainName

string

Sets the function name

setFunctionName(string $sFunctionName) : void

Parameters

$sFunctionName

string

Sets the callback parameters

setParameters(array $aParameters) : void

Parameters

$aParameters

array

Another way to set the arguments before invoking execute() method.

setTemporaryArguments(array $args) : void

Parameters

$args

array

 Properties

 

Parameter to pass to the function

$_aParameters : array

 

Callback name. Contains either the function name to invoke, or a indexed array (class/object and method) and it's method to execute.

$_mCallback : array | string

 

Temporary arguments holder

$_mTemporaryArguments : array | null

 

Chain name

$_sChainName : string

 

Name of function to invoke

$_sFunctionName : string