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
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • cApiCecChainItem
  • cApiCecHook
  • cApiCecRegistry
  • Overview
  • Package
  • Class
  • Todo
  • Download

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

Constructor

private
# __clone( )

Prevent cloning

Prevent cloning

public static cApiCecRegistry
# getInstance( )

Returns a instance of cApiCecRegistry

Returns a instance of cApiCecRegistry

Returns

cApiCecRegistry
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
Chain name
$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, otherwhise 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
Chain name
$sFunctionName
Name of function to check

Returns

boolean
public
# removeChainFunction( string $sChainName, string $sFunctionName )

Removes a chain function.

Removes a chain function.

Parameters

$sChainName
Chain name
$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
Chain name

Returns

cIterator

Todo

: cIterator should be replaced by ArrayIterator (@see http://www.php.net/spl) but ArrayIterator uses rewind() instead of reset()...


protected
# _resetIterator( string $sChainName )

Resets the chain iterator.

Resets the chain iterator.

Parameters

$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

Self instance

Self instance

# NULL
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen