Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • PHP
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SIWECOS
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • cApiCecChainItem
  • cApiCecHook
  • cApiCecRegistry
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class cApiCecChainItem

CEC chain item class.

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>
Located at classes/class.cec.php
Methods summary
public
# __construct( string $sChainName, string $sFunctionName, array $aParameters )

Constructor to create an instance of this class.

Constructor to create an instance of this class.

Sets the CEC chain item properties.

Parameters

$sChainName
string
$sChainName
$sFunctionName
string
$sFunctionName
$aParameters
array
$aParameters

Throws

cInvalidArgumentException
public
# setChainName( string $sChainName )

Sets the chain name

Sets the chain name

Parameters

$sChainName
string
$sChainName
public string
# getChainName( )

Returns the chain name

Returns the chain name

Returns

string
public
# setFunctionName( string $sFunctionName )

Sets the function name

Sets the function name

Parameters

$sFunctionName
string
$sFunctionName
public string
# getFunctionName( )

Returns the function name

Returns the function name

Returns

string
public
# setParameters( array $aParameters )

Sets the callback parameters

Sets the callback parameters

Deprecated

[2014-08-07] This method is deprecated and is not needed any longer

Parameters

$aParameters
array
$aParameters
public array
# getParameters( )

Returns the function name

Returns the function name

Deprecated

[2014-08-07] This method is deprecated and is not needed any longer

Returns

array
public
# setCallback( string|array $callback )

Sets the callback

Sets the callback

Parameters

$callback
string|array
$callback

Throws

cInvalidArgumentException
if the given callback is not a string or an array
public string|array
# getCallback( )

Returns the callback

Returns the callback

Returns

string|array
public
# setTemporaryArguments( array $args = array() )

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

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

Parameters

$args
array
$args [optional]
public array
# getTemporaryArguments( )

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

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

Returns

array
public mixed
# execute( )

Invokes the CEC function/callback.

Invokes the CEC function/callback.

Returns

mixed
If available, the result of the CEC function/callback
Properties summary
protected string $_sChainName
#

Chain name

Chain name

protected string $_sFunctionName
#

Name of function to invoke

Name of function to invoke

protected array $_mCallback
#

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

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

protected array $_aParameters
#

Parameter to pass to the function

Parameter to pass to the function

protected array $_mTemporaryArguments
#

Temporary arguments holder

Temporary arguments holder

CMS CONTENIDO 4.10.1 API documentation generated by ApiGen 2.8.0