Class cRegistry

This class contains functions for global interaction in CONTENIDO.

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

Methods summary
`public static string`	# `getBackendPath( )` Function which returns path after the last possible place changing via configuration file. Function which returns path after the last possible place changing via configuration file. Returns `string` path Author konstantinos.katikakis
`public static string`	# `getBackendUrl( )` Function which returns the backend URL after the last possible place changing via configuration file. Function which returns the backend URL after the last possible place changing via configuration file. Returns `string` URL Author konstantinos.katikakis
`public static string`	# `getFrontendPath( )` Function which returns path after the last possible place changing via configuration file. The path point to the current client Function which returns path after the last possible place changing via configuration file. The path point to the current client Returns `string` path Author konstantinos.katikakis
`public static string`	# `getFrontendUrl( )` Function which returns URL after the last possible place changing via configuration file. The path point to the current client Function which returns URL after the last possible place changing via configuration file. The path point to the current client Returns `string` URL Author konstantinos.katikakis
`public static string`	# `getBackendSessionId( )` Returns the CONTENIDO Session ID stored in the global variable "contenido". Returns the CONTENIDO Session ID stored in the global variable "contenido". Returns `string`
`public static string`	# `getBackendLanguage( )` Returns the CONTENIDO backend language stored in the global variable "belang" Returns the CONTENIDO backend language stored in the global variable "belang" Returns `string`
`public static boolean`	# `isBackendEditMode( )` Checks if the edit mode in backend is active or not stored in the global variable "edit" Checks if the edit mode in backend is active or not stored in the global variable "edit" Returns `boolean`
`public static integer`	# `getLanguageId( )` Returns the current language ID stored in the global variable "lang". Returns the current language ID stored in the global variable "lang". Returns `integer`
`public static cApiLanguage`	# `getLanguage( )` Returns the loaded cApiLanguage object for the current language. Returns the loaded cApiLanguage object for the current language. Returns `cApiLanguage` Throws `cInvalidArgumentException`
`public static integer`	# `getClientId( )` Returns the current client ID stored in the global variable "client". Returns the current client ID stored in the global variable "client". Returns `integer`
`public static cApiClient`	# `getClient( )` Returns the loaded cApiClient object for the current client. Returns the loaded cApiClient object for the current client. Returns `cApiClient` Throws `cInvalidArgumentException`
`public static integer`	# `getArticleId( boolean $autoDetect = false )` Returns the article id stored in the global variable "idart". Returns the article id stored in the global variable "idart". Parameters `$autoDetect` `boolean` $autoDetect [optional, default: false] If true, the value is tried to detected automatically. Returns `integer`
`public static cApiArticle`	# `getArticle( )` Returns the loaded cApiArticle object for the current article. Returns the loaded cApiArticle object for the current article. Returns `cApiArticle` Throws `cInvalidArgumentException`
`public static integer`	# `getArticleLanguageId( boolean $autoDetect = false )` Returns the article language id stored in the global variable "idartlang". Returns the article language id stored in the global variable "idartlang". Parameters `$autoDetect` `boolean` $autoDetect [optional, default: false] If true, the value is tried to detected automatically. Returns `integer`
`public static cApiArticleLanguage`	# `getArticleLanguage( )` Returns the loaded cApiArticleLanguage object for the current article. Returns the loaded cApiArticleLanguage object for the current article. Returns `cApiArticleLanguage` Throws `cInvalidArgumentException`
`public static integer`	# `getCategoryId( boolean $autoDetect = false )` Returns the category id stored in the global variable "idcat". Returns the category id stored in the global variable "idcat". Parameters `$autoDetect` `boolean` $autoDetect [optional, default: false] If true, the value is tried to detected automatically. Returns `integer`
`public static cApiCategory`	# `getCategory( )` Returns the loaded cApiCategory object for the current category. Returns the loaded cApiCategory object for the current category. Returns `cApiCategory` Throws `cInvalidArgumentException`
`public static integer`	# `getCategoryLanguageId( boolean $autoDetect = false )` Returns the category language id stored in the global variable "idcatlang". Returns the category language id stored in the global variable "idcatlang". Parameters `$autoDetect` `boolean` $autoDetect [optional, default: false] If true, the value is tried to detected automatically. Returns `integer`
`public static cApiCategoryLanguage`	# `getCategoryLanguage( )` Returns the loaded cApiCategoryLanguage object for the current category. Returns the loaded cApiCategoryLanguage object for the current category. Returns `cApiCategoryLanguage` Throws `cInvalidArgumentException`
`public static integer`	# `getCategoryArticleId( boolean $autoDetect = false )` Returns the category/article relation id stored in the global variable "idcatart". Returns the category/article relation id stored in the global variable "idcatart". Parameters `$autoDetect` `boolean` $autoDetect [optional; default: false] If true, the value is tried to detected automatically. Returns `integer`
`public static cApiCategoryArticle`	# `getCategoryArticle( )` Returns the loaded cApiCategoryArticle object for the current category/article relation. Returns the loaded cApiCategoryArticle object for the current category/article relation. Returns `cApiCategoryArticle` Throws `cInvalidArgumentException`
`public static integer`	# `getCurrentModuleId( )` Returns the current module ID. Note: This function will work only within module code. Returns the current module ID. Note: This function will work only within module code. Returns `integer`
`public static integer`	# `getCurrentContainerId( )` Returns the current container ID. Note: This function will work only within module code. Returns the current container ID. Note: This function will work only within module code. Returns `integer`
`public static string`	# `getFrame( )` Returns the current frame id stored in the global variable "frame". Returns the current frame id stored in the global variable "frame". Returns `string` Author thomas.stauer
`public static cSession`	# `getSession( )` Return the session object stored in the global variable "sess". Return the session object stored in the global variable "sess". Returns `cSession`
`public static cAuth`	# `getAuth( )` Returns the auth object stored in the global variable "auth". Returns the auth object stored in the global variable "auth". Returns `cAuth`
`public static string`	# `getArea( )` Returns the area stored in the global variable "area". Returns the area stored in the global variable "area". Returns `string` Author thomas.stauer
`public static string`	# `getAction( )` Returns the action stored in the global variable "action". Returns the action stored in the global variable "action". Returns `string` Author jann.diekmann
`public static string`	# `getChangeLang( )` Returns the language when switching languages. Must be set for URL-Build. Stored in the global variable "changelang". Returns the language when switching languages. Must be set for URL-Build. Stored in the global variable "changelang". Returns `string` Author jann.diekmann
`public static array`	# `getErrSite( )` Returns the global "idcat" and "idart" of the Error-Site stored in the Client Configurations Returns the global "idcat" and "idart" of the Error-Site stored in the Client Configurations Returns `array` Author jann.diekmann
`public static cPermission`	# `getPerm( )` Returns the permission object stored in the global variable "perm". Returns the permission object stored in the global variable "perm". Returns `cPermission`
`public static array`	# `getConfig( )` Returns the configuration array stored in the global variable "cfg". Returns the configuration array stored in the global variable "cfg". Returns `array`
`public static mixed`	# `getConfigValue( string $sectionName = NULL, string $optionName = NULL, string $defaultValue = NULL )` This function returns either a full configuration section or the value for a certain configuration option if a $optionName is given. In this case a $default value can be given which will be returned if this option is not defined. This function returns either a full configuration section or the value for a certain configuration option if a $optionName is given. In this case a $default value can be given which will be returned if this option is not defined. Parameters `$sectionName` `string` $sectionName [optional] `$optionName` `string` $optionName [optional] `$defaultValue` `string` $defaultValue [optional] Returns `mixed`
`public static array`	# `getClientConfig( integer $clientId = 0 )` Returns the client configuration array stored in the global variable "cfgClient". If no client ID is specified or is 0 the complete array is returned. Returns the client configuration array stored in the global variable "cfgClient". If no client ID is specified or is 0 the complete array is returned. Parameters `$clientId` `integer` $clientId [optional] Client ID Returns `array`
`public static cDb`	# `getDb( )` Returns a new CONTENIDO database object. Returns a new CONTENIDO database object. Returns `cDb` Todo perhaps its better to instantiate only one object and reset it on call
`public static string`	# `getDbTableName( string $index )` Fetches the database table name with its prefix. Fetches the database table name with its prefix. Parameters `$index` `string` $index name of the index Returns `string`
`public static cApiCecRegistry`	# `getCecRegistry( )` Return the global CONTENIDO Execution Chain Registry. Return the global CONTENIDO Execution Chain Registry. Returns `cApiCecRegistry`
`public static`	# `setAppVar( string $key, mixed $value )` Setter for an application variable. Setter for an application variable. Parameters `$key` `string` $key `$value` `mixed` $value
`public static mixed`	# `getAppVar( string $key, mixed $default = NULL )` Getter for an application variable. Getter for an application variable. Parameters `$key` `string` $key `$default` `mixed` $default [optional] Default value to return, if the application variable doesn't exists Returns `mixed`
`public static`	# `unsetAppVar( string $key )` Unsets an existing application variable. Unsets an existing application variable. Parameters `$key` `string` $key
`final protected static mixed`	# `_fetchGlobalVariable( string $variableName, mixed $defaultValue = NULL )` Fetches the global variable requested. If variable is not set, the default value is returned. Fetches the global variable requested. If variable is not set, the default value is returned. Parameters `$variableName` `string` $variableName name of the global variable `$defaultValue` `mixed` $defaultValue [optional] default value Returns `mixed`
`final protected static Item`	# `_fetchItemObject( string $apiClassName, integer $objectId )` Fetches the corresponding Item object for the specific class name and its primary key value. Fetches the corresponding Item object for the specific class name and its primary key value. Parameters `$apiClassName` `string` $apiClassName name of the api class `$objectId` `integer` $objectId primary key value Returns `Item` Throws `cInvalidArgumentException` if the given objectId is not greater than 0 or the given class does not exist
`final public static`	# `bootstrap( array $features )` Bootstraps the CONTENIDO framework and initializes the global variables sess, auth and perm. Bootstraps the CONTENIDO framework and initializes the global variables sess, auth and perm. Parameters `$features` `array` $features array with class name definitions
`final public static`	# `shutdown( boolean $debugShowAll = true )` Shutdowns the CONTENIDO framework on page close. Shutdowns the CONTENIDO framework on page close. Parameters `$debugShowAll` `boolean` $debugShowAll [optional] Throws `cInvalidArgumentException` Author frederic.schneider
`public static`	# `addOkMessage( string $message )` Stores an ok message in the cRegistry. Stores an ok message in the cRegistry. Parameters `$message` `string` $message Author frederic.schneider
`public static`	# `addInfoMessage( string $message )` Stores an information massage in the cRegistry. Stores an information massage in the cRegistry. Parameters `$message` `string` $message Author konstantinos.katikakis
`public static`	# `addErrorMessage( string $message )` Stores an error massage in the cRegistry. Stores an error massage in the cRegistry. Parameters `$message` `string` $message Author konstantinos.katikakis
`public static`	# `addWarningMessage( string $message )` Stores an warning massage in the cRegistry. Stores an warning massage in the cRegistry. Parameters `$message` `string` $message Author konstantinos.katikakis
`public static`	# `appendLastOkMessage( string $message )` Appends the last ok message that will be outputted Appends the last ok message that will be outputted Parameters `$message` `string` $message Author frederic.schneider
`public static`	# `appendLastInfoMessage( string $message )` Appends the last info message that will be outputted Appends the last info message that will be outputted Parameters `$message` `string` $message Author mischa.holz
`public static`	# `appendLastErrorMessage( string $message )` Appends the last error message that will be outputted Appends the last error message that will be outputted Parameters `$message` `string` $message Author mischa.holz
`public static`	# `appendLastWarningMessage( string $message )` Appends the last warning that will be outputted Appends the last warning that will be outputted Parameters `$message` `string` $message Author mischa.holz
`public static array`	# `getOkMessages( )` Return an array with ok message Return an array with ok message Returns `array` Author frederic.schneider
`public static array`	# `getInfoMessages( )` Returns an array with information messages. Returns an array with information messages. Returns `array` Author konstantinos.katikakis
`public static array`	# `getErrorMessages( )` Returns an array with error messages. Returns an array with error messages. Returns `array` Author konstantinos.katikakis
`public static array`	# `getWarningMessages( )` Returns an array with warning messages. Returns an array with warning messages. Returns `array` Author konstantinos.katikakis
`public static boolean`	# `isTrackingAllowed( )` Returns true if the DNT header is set and equal to 1. Returns false if the DNT header is unset or not equal to 1. Returns true if the DNT header is set and equal to 1. Returns false if the DNT header is unset or not equal to 1. Returns `boolean` whether tracking is allowed by the DNT header
`public static string\|boolean`	# `getEncoding( )` Returns the actual encoding (standard: utf-8) Returns the actual encoding (standard: utf-8) Returns `string\|boolean` name of encoding or false if no language found

Properties summary
`protected static array`	`$_appVars`	`array()`	# Container for application variables. Meant to set and get application wide variables as an alternative to store them in global scope. Container for application variables. Meant to set and get application wide variables as an alternative to store them in global scope.
`protected static array`	`$_okMessages`	`array()`	# Container for ok messages. Container for ok messages. Author frederic.schneider
`protected static array`	`$_infoMessages`	`array()`	# Container for information messages. Container for information messages. Author konstantinos.katikakis
`protected static array`	`$_errMessages`	`array()`	# Container for error messages. Container for error messages. Author konstantinos.katikakis
`protected static array`	`$_warnMessages`	`array()`	# Container for warning messages. Container for warning messages. Author konstantinos.katikakis

Packages

Classes

Functions

Class cRegistry

Returns

Author

Returns

Author

Returns

Author

Returns

Author

Returns

Returns

Returns

Returns

Returns

Throws

Returns

Returns

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Returns

Throws

Returns

Returns

Returns

Author

Returns

Returns

Returns

Author

Returns

Author

Returns

Author

Returns

Author

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Todo

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Throws

Parameters

Parameters

Throws

Author

Parameters