Class cApiCecRegistry

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,

Package: Core\CEC
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Timo A. Hummel
Author: Murat Purc <murat@purc.de>
See: cApiCecHook::executeAndReturn() - Callbacks, which should be processed untill a defined break condition achieves,
See: cApiCecHook::executeWhileBreakCondition()
Located at classes/class.cec.php

Methods summary
`protected`	# `__construct( )` Constructor to create an instance of this class. Constructor to create an instance of this class.
`private`	# `__clone( )` Prevent cloning Prevent cloning
`public static cApiCecRegistry`	# `getInstance( )` Returns a instance of cApiCecRegistry Returns a instance of cApiCecRegistry Returns `cApiCecRegistry`
`public`	# `registerChain( string $sChainName )` Registers a chain (adds the chain to the internal chain holder) NOTE: The number of parameter is not restricted. You can pass as much parameter as you want. Registers a chain (adds the chain to the internal chain holder) NOTE: The number of parameter is not restricted. You can pass as much parameter as you want. Deprecated [2014-08-07] This method is deprecated and is not needed any longer Parameters `$sChainName` `string` $sChainName
`public`	# `unregisterChain( string $sChainName )` Unregisters a chain Unregisters a chain Deprecated [2014-08-07] This method is deprecated and is not needed any longer Parameters `$sChainName` `string` $sChainName Throws `cInvalidArgumentException` if the given chain does not exist
`public boolean`	# `isChainRegistered( string $sChainName )` Checks if a chain is registered or not. Checks if a chain is registered or not. Deprecated [2014-08-07] This method is deprecated and is not needed any longer Parameters `$sChainName` `string` $sChainName Returns `boolean`
`public array`	# `getRegisteredChainNames( )` Returns list of registered chain names Returns list of registered chain names Deprecated [2014-08-07] This method is deprecated and is not needed any longer Returns `array`
`protected null`	# `_addChain( string $sChainName, array $aParameters = array() )` Adds the chain to the internal chain holder Adds the chain to the internal chain holder Deprecated [2014-08-07] This method is deprecated and is not needed any longer Parameters `$sChainName` `string` $sChainName Chain name `$aParameters` `array` $aParameters [optional] Chain parameter Returns `null`
`public boolean`	# `addChainFunction( string $sChainName, string $sFunctionName )` Adds a chain function which is to invoke. Adds a chain function which is to invoke. Parameters `$sChainName` `string` $sChainName Chain name `$sFunctionName` `string` $sFunctionName 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. Returns `boolean` True on success, otherwise false Throws `cInvalidArgumentException` if the given chain is not registered or the given callback is not callable
`public boolean`	# `chainFunctionExists( string $sChainName, string $sFunctionName )` Checks if a chain function exists. Checks if a chain function exists. Parameters `$sChainName` `string` $sChainName Chain name `$sFunctionName` `string` $sFunctionName Name of function to check Returns `boolean`
`public`	# `removeChainFunction( string $sChainName, string $sFunctionName )` Removes a chain function. Removes a chain function. Parameters `$sChainName` `string` $sChainName Chain name `$sFunctionName` `string` $sFunctionName Name of function to remove from chain.
`public cIterator`	# `getIterator( string $sChainName )` Returns the iterator for a desired chain. Returns the iterator for a desired chain. Parameters `$sChainName` `string` $sChainName Chain name Returns `cIterator`
`protected`	# `_resetIterator( string $sChainName )` Resets the chain iterator. Resets the chain iterator. Parameters `$sChainName` `string` $sChainName
`public`	# `flushAddedChains( )` Flushs added chains Flushs added chains

Properties summary
`private array`	`$_aChains`		# List of available chains List of available chains
`private static cApiCecRegistry`	`$_instance`	`NULL`	# Self instance Self instance

Packages

Classes

Class cApiCecRegistry

Returns

Deprecated

Parameters

Deprecated

Parameters

Throws

Deprecated

Parameters

Returns

Deprecated

Returns

Deprecated

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Parameters