CEC registry class.
Used to register chains and chain functions to invoke.
Following 3 types of CEC functions/callbacks are supported at the moment: - Callbacks, which should only be invoked. They don't return a value and have no break conditions, @see cApiCecHook::execute() - Callbacks, which should return a value and/or should modify a passed parameter,
see | - Callbacks, which should be processed untill a defined break condition achieves, |
---|---|
see | \global\cApiCecHook::executeWhileBreakCondition() |
author | Timo A. Hummel |
author | Murat Purc |
package | CONTENIDO Backend Classes |
subpackage | CEC |
addChainFunction(string $sChainName, string $sFunctionName) : bool
string
Chain name
string
Name of function/callback to invoke. Feasible values are: - "ClassName->methodName" to invoke a method of a ClassName instance. A instance of the clas will be created here. - "ClassName::methodName" to invoke a static method of ClassName. - "FunctionName" to invoke a function. NOTE: Necessary files must be manually included before or by defined autoloader.
\cInvalidArgumentException |
if the given chain is not registered or the given callback is not callable |
---|
bool
True on success, otherwhise falsechainFunctionExists(string $sChainName, string $sFunctionName) : bool
string
Chain name
string
Name of function to check
bool
getIterator(string $sChainName) : \cIterator
todo | : cIterator should be replaced by ArrayIterator (@see http://www.php.net/spl) but ArrayIterator uses rewind() instead of reset()... |
---|
string
Chain name
getRegisteredChainNames() : array
array
isChainRegistered(string $sChainName) : bool
string
bool
registerChain(string $sChainName) : void
string
removeChainFunction(string $sChainName, string $sFunctionName)
string
Chain name
string
Name of function to remove from chain.
unregisterChain(string $sChainName) : void
string
\cInvalidArgumentException |
if the given chain does not exist |
---|
__construct() : void
_addChain(string $sChainName, array $aParameters) : void
string
Chain name
array
Chain parameter
_resetIterator(string $sChainName) : void
string
__clone() : void
$_aChains : array
$_instance : \cApiCecRegistry