Class cGenericDb

Class cGenericDb. Handles the generic execution of callbacks.

Direct known subclasses

Indirect known subclasses

ArticleForum, ArticleForumCollection, cApiArticleCollection, cApiShortUrlCollection, cApiStat, cApiStatCollection, cApiSystemProperty, cApiSystemPropertyCollection, cApiTemplate, cApiTemplateCollection, cApiTemplateConfiguration, cApiTemplateConfigurationCollection, cApiType, cApiArticleLanguage, cApiTypeCollection, cApiUpload, cApiUploadCollection, cApiUploadMeta, cApiUploadMetaCollection, cApiUser, cApiUserCollection, cApiUserPasswordRequest, cApiUserPasswordRequestCollection, cApiUserProperty, cApiArticleLanguageCollection, cApiUserPropertyCollection, Item, ItemCollection, Newsletter, NewsletterCollection, NewsletterJob, NewsletterJobCollection, NewsletterLog, NewsletterLogCollection, NewsletterRecipient, cApiArticleLanguageVersion, NewsletterRecipientCollection, NewsletterRecipientGroup, NewsletterRecipientGroupCollection, NewsletterRecipientGroupMember, NewsletterRecipientGroupMemberCollection, NoteCollection, NoteItem, PifaField, PifaFieldCollection, PifaForm, cApiArticleLanguageVersionCollection, PifaFormCollection, PimPlugin, PimPluginCollection, PimPluginRelations, PimPluginRelationsCollection, TODOCollection, TODOItem, Workflow, WorkflowAction, WorkflowActions, cApiArticleSpecification, WorkflowAllocation, WorkflowAllocations, WorkflowArtAllocation, WorkflowArtAllocations, WorkflowItem, WorkflowItems, Workflows, WorkflowTask, WorkflowTasks, WorkflowUserSequence, cApiArticleSpecificationCollection, WorkflowUserSequences, cApiCategory, cApiCategoryArticle, cApiCategoryArticleCollection, ArticleForumItem, cApiCategoryCollection, cApiCategoryLanguage, cApiCategoryLanguageCollection, cApiCategoryTree, cApiCategoryTreeCollection, cApiClient, cApiClientCollection, cApiClientLanguage, cApiClientLanguageCollection, cApiCommunication, cApiAction, cApiCommunicationCollection, cApiContainer, cApiContainerCollection, cApiContainerConfiguration, cApiContainerConfigurationCollection, cApiContent, cApiContentCollection, cApiContentVersion, cApiContentVersionCollection, cApiDbfs, cApiActionCollection, cApiDbfsCollection, cApiFile, cApiFileCollection, cApiFileInformation, cApiFileInformationCollection, cApiFrameFile, cApiFrameFileCollection, cApiFrontendGroup, cApiFrontendGroupCollection, cApiFrontendGroupMember, cApiActionlog, cApiFrontendGroupMemberCollection, cApiFrontendPermission, cApiFrontendPermissionCollection, cApiFrontendUser, cApiFrontendUserCollection, cApiGroup, cApiGroupCollection, cApiGroupMember, cApiGroupMemberCollection, cApiGroupProperty, cApiActionlogCollection, cApiGroupPropertyCollection, cApiInUse, cApiInUseCollection, cApiIso3166, cApiIso3166Collection, cApiIso6392, cApiIso6392Collection, cApiKeyword, cApiKeywordCollection, cApiLanguage, cApiArea, cApiLanguageCollection, cApiLayout, cApiLayoutCollection, cApiMailLog, cApiMailLogCollection, cApiMailLogSuccess, cApiMailLogSuccessCollection, cApiMetaTag, cApiMetaTagCollection, cApiMetaTagVersion, cApiAreaCollection, cApiMetaTagVersionCollection, cApiMetaType, cApiMetaTypeCollection, cApiModule, cApiModuleCollection, cApiNavMain, cApiNavMainCollection, cApiNavSub, cApiNavSubCollection, cApiOnlineUser, cApiArticle, cApiOnlineUserCollection, cApiPathresolveCache, cApiPathresolveCacheCollection, cApiProperty, cApiPropertyCollection, cApiRight, cApiRightCollection, cApiSearchTracking, cApiSearchTrackingCollection, cApiShortUrl

Package: Core\GenericDB
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Dominik Ziegler
Located at classes/genericdb/class.genericdb.php

Methods summary
`public static`	# `register( string $event, mixed $callback, mixed $class )` Registers a new callback. Registers a new callback. Example: cGenericDb::register(cGenericDb::CREATE_SUCCESS, 'itemCreateHandler', 'cApiArticle'); cGenericDb::register(cGenericDb::CREATE_SUCCESS, array('cCallbackHandler', 'executeCreateHandle'), 'cApiArticle'); Parameters `$event` `string` $event Callback event, must be a valid value of a cGenericDb event constant `$callback` `mixed` $callback Callback to register `$class` `mixed` $class Class name for registering callback (can be string of array with names of the concrete Item classes) Throws `cInvalidArgumentException` if event or class are not set or the callback is not callable
`public static`	# `unregister( string $event, mixed $class )` Unregisters all callbacks for a specific event in a class. Unregisters all callbacks for a specific event in a class. Example: cGenericDb::unregister(cGenericDb::CREATE_SUCCESS, 'cApiArticle'); Parameters `$event` `string` $event Callback event, must be a valid value of a cGenericDb event constant `$class` `mixed` $class Class name for unregistering callback (can be string of array with names of the concrete Item classes) Throws `cInvalidArgumentException` if the event or the class are not set
`final protected`	# `_executeCallbacks( string $event, string $class, array $arguments = array() )` Executes all callbacks for a specific event in a class. Executes all callbacks for a specific event in a class. Parameters `$event` `string` $event Callback event, must be a valid value of a cGenericDb event constant `$class` `string` $class Class name for executing callback `$arguments` `array` $arguments [optional] Arguments to pass to the callback function Throws `cInvalidArgumentException` if the event or class is not set

Constants summary
`integer`	`CREATE_BEFORE`	`10`	# Callbacks are executed before a item is created. Expected parameters for callback: none Callbacks are executed before a item is created. Expected parameters for callback: none
`integer`	`CREATE_FAILURE`	`11`	# Callbacks are executed if item could not be created. Expected parameters for callback: none Callbacks are executed if item could not be created. Expected parameters for callback: none
`integer`	`CREATE_SUCCESS`	`12`	# Callbacks are executed if item could be created successfully. Expected parameters for callback: ID of created item Callbacks are executed if item could be created successfully. Expected parameters for callback: ID of created item
`integer`	`STORE_BEFORE`	`20`	# Callbacks are executed before store process is executed. Expected parameters for callback: Item instance Callbacks are executed before store process is executed. Expected parameters for callback: Item instance
`integer`	`STORE_FAILURE`	`21`	# Callbacks are executed if store process failed. This is also likely to happen if query would not change anything in database! Expected parameters for callback: Item instance Callbacks are executed if store process failed. This is also likely to happen if query would not change anything in database! Expected parameters for callback: Item instance
`integer`	`STORE_SUCCESS`	`22`	# Callbacks are executed if store process saved the values in the database. Expected parameters for callback: Item instance Callbacks are executed if store process saved the values in the database. Expected parameters for callback: Item instance
`integer`	`DELETE_BEFORE`	`30`	# Callbacks are executed before deleting an item. Expected parameters for callback: ID of them item to delete Callbacks are executed before deleting an item. Expected parameters for callback: ID of them item to delete
`integer`	`DELETE_FAILURE`	`31`	# Callbacks are executed if deletion of an item fails. Expected parameters for callback: ID of them item to delete Callbacks are executed if deletion of an item fails. Expected parameters for callback: ID of them item to delete
`integer`	`DELETE_SUCCESS`	`32`	# Callbacks are executed if item was deleted successfully. Expected parameters for callback: ID of them item to delete Callbacks are executed if item was deleted successfully. Expected parameters for callback: ID of them item to delete

Properties summary
`private static array`	`$_callbacks`	`array()`	# Callback stack. Callback stack.

Packages

Classes

Class cGenericDb

Direct known subclasses

Indirect known subclasses

Parameters

Throws

Parameters

Throws

Parameters

Throws