CEC chain item class.

deprecated [2012-02-25] Use cApiCecChainItem instead.
author Timo A. Hummel
author Murat Purc
package CONTENIDO Backend Classes

 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
Inherited
inherited_from \cApiCecChainItem::execute()

Returns

mixedIf available, the result of the CEC function/callback

Returns the callback

getCallback() : string
Inherited
inherited_from \cApiCecChainItem::getCallback()

Returns

stringarray

Returns the chain name

getChainName() : string
Inherited
inherited_from \cApiCecChainItem::getChainName()

Returns

string

Returns the function name

getFunctionName() : string
Inherited
inherited_from \cApiCecChainItem::getFunctionName()

Returns

string

Returns the function name

getParameters() : array
Inherited
inherited_from \cApiCecChainItem::getParameters()

Returns

array

Will be invoked by execute() method.

getTemporaryArguments() : void
Inherited

If temporary arguments where set before, it returns them and resets the property.

inherited_from \cApiCecChainItem::getTemporaryArguments()

Sets the callback

setCallback($callback) : string
Inherited
inherited_from \cApiCecChainItem::setCallback()

Parameters

$callback

Exceptions

\cInvalidArgumentException if the given callback is not a string or an array

Returns

stringarray

Sets the chain name

setChainName(string $sChainName) : void
Inherited
inherited_from \cApiCecChainItem::setChainName()

Parameters

$sChainName

string

Sets the function name

setFunctionName(string $sFunctionName) : void
Inherited
inherited_from \cApiCecChainItem::setFunctionName()

Parameters

$sFunctionName

string

Sets the callback parameters

setParameters(array $aParameters) : void
Inherited
inherited_from \cApiCecChainItem::setParameters()

Parameters

$aParameters

array

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

setTemporaryArguments(array $args) : void
Inherited
inherited_from \cApiCecChainItem::setTemporaryArguments()

Parameters

$args

array

 Properties

 

$_aParameters : array
Inherited
inherited_from \cApiCecChainItem::$$_aParameters
 

$_mCallback : array
Inherited

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

inherited_from \cApiCecChainItem::$$_mCallback
 

$_mTemporaryArguments : array
Inherited
inherited_from \cApiCecChainItem::$$_mTemporaryArguments
 

$_sChainName : string
Inherited
inherited_from \cApiCecChainItem::$$_sChainName
 

$_sFunctionName : string
Inherited
inherited_from \cApiCecChainItem::$$_sFunctionName