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

  • cAjaxRequest
  • cAutoload
  • cBackend
  • cEffectiveSetting
  • cGuiScrollListAlltranslations
  • cHTMLValidator
  • cMailer
  • cModuleFileTranslation
  • cModuleHandler
  • cModuleSearch
  • cModuleSynchronizer
  • cModuleTemplateHandler
  • CodeMirror
  • cPasswordRequest
  • cPermission
  • cRegistry
  • cSystemPurge
  • cSystemtest
  • cTinymce4Configuration
  • cTinyMCE4Editor
  • cTinyMCEEditor
  • cWYSIWYGEditor
  • FrontendList
  • HtmlParser
  • TreeItem
  • UploadList
  • UploadSearchResultList

Functions

  • addArtspec
  • addSortImages
  • backToMainArea
  • buildArticleSelect
  • buildCategorySelect
  • buildCategorySelectRights
  • buildHeapTable
  • buildStackString
  • buildTree
  • buildUserOrGroupPermsFromRequest
  • callPluginStore
  • cApiCatGetLevelNode
  • cApiImageCheckCachedImageValidity
  • cApiImageCheckImageEditingPosibility
  • cApiImageGetCacheFileName
  • cApiImageGetTargetDimensions
  • cApiImageIsAnimGif
  • cApiImgScale
  • cApiImgScaleGetMD5CacheFile
  • cApiImgScaleHQ
  • cApiImgScaleImageMagick
  • cApiImgScaleLQ
  • cApiIsImageMagickAvailable
  • cApiStrCleanURLCharacters
  • cApiStrNormalizeLineEndings
  • cApiStrRecodeString
  • cApiStrReplaceDiacritics
  • cApiStrTrimAfterWord
  • cApiStrTrimHard
  • cApiStrTrimSentence
  • cDeprecated
  • cDie
  • cError
  • checkLangInClients
  • checkPathInformation
  • cInclude
  • compareUrlStrings
  • conChangeTemplateForCat
  • conCopyArticle
  • conCopyArtLang
  • conCopyContainerConf
  • conCopyContent
  • conCopyMetaTags
  • conCopyTemplateConfiguration
  • conCreateLocationString
  • conDeeperCategoriesArray
  • conDeleteart
  • conEditArt
  • conEditFirstTime
  • conFetchCategoryTree
  • conFlagOnOffline
  • conGenerateCode
  • conGenerateCodeForAllArts
  • conGenerateCodeForAllArtsInCategory
  • conGenerateCodeForAllartsUsingLayout
  • conGenerateCodeForAllartsUsingMod
  • conGenerateCodeForAllArtsUsingTemplate
  • conGenerateCodeForArtInAllCategories
  • conGenerateCodeForClient
  • conGetAvailableMetaTagTypes
  • conGetCategoryArticleId
  • conGetCategoryAssignments
  • conGetContainerConfiguration
  • conGetContentFromArticle
  • conGetHtmlTranslationTable
  • conGetMetaValue
  • conGetTemplateConfigurationIdForArticle
  • conGetTemplateConfigurationIdForCategory
  • conGetTopmostCat
  • conGetUsedModules
  • conHtmlentities
  • conHtmlEntityDecode
  • conHtmlSpecialChars
  • conIsLocked
  • conLock
  • conLockBulkEditing
  • conMakeArticleIndex
  • conMakeCatOnline
  • conMakeInlineScript
  • conMakeOnline
  • conMakeOnlineBulkEditing
  • conMakePublic
  • conMakeStart
  • conMoveArticles
  • conPhp54Check
  • conRemoveOldCategoryArticle
  • conSaveContentEntry
  • conSetCodeFlag
  • conSetCodeFlagBulkEditing
  • conSetMetaValue
  • conSyncArticle
  • copyRightsForElement
  • createBulkEditingFunction
  • createRandomName
  • createRightsForElement
  • cWarning
  • dbGetColumns
  • dbGetIndexes
  • dbGetPrimaryKeyName
  • dbTableExists
  • dbUpgradeTable
  • defineIfNotDefined
  • deleteArtspec
  • deleteRightsForElement
  • deleteSystemProperty
  • displayDatetime
  • emptyLogFile
  • endAndLogTiming
  • extractNumber
  • generateDisplayFilePath
  • generateJs
  • getAllClientsAndLanguages
  • getArtLang
  • getArtspec
  • getAvailableContentTypes
  • getCanonicalDay
  • getCanonicalMonth
  • getDirectorySize
  • getEffectiveSetting
  • getEffectiveSettingsByType
  • getEncodingByLanguage
  • getFileContents
  • getFileInformation
  • getFileType
  • getGroupOrUserName
  • getIDForArea
  • getJsHelpContext
  • getLanguageNamesByClient
  • getLanguagesByClient
  • getmicrotime
  • getNamedFrame
  • getParam
  • getParentAreaId
  • getSearchResults
  • getStrExpandCollapseButton
  • getSystemProperties
  • getSystemPropertiesByType
  • getSystemProperty
  • getTemplateSelect
  • getUplExpandCollapseButton
  • htmldecode
  • htmlentities_iso88592
  • humanReadableSize
  • includePlugins
  • insertEmptyStrRow
  • ipMatch
  • isAlphanumeric
  • isArchive
  • isArtInMultipleUse
  • isFunctionDisabled
  • isGroup
  • isIPv4
  • isRunningFromWeb
  • isStartArticle
  • isUtf8
  • isValidMail
  • langActivateDeactivateLanguage
  • langDeleteLanguage
  • langEditLanguage
  • langGetTextDirection
  • langNewLanguage
  • langRenameLanguage
  • layDeleteLayout
  • layEditLayout
  • machineReadableSize
  • mailLogBulkEditingFunctions
  • mailLogDecodeAddresses
  • markSubMenuItem
  • mask
  • modDeleteModule
  • modEditModule
  • phpInfoToHtml
  • plugin_include
  • prCreateURLNameLocationString
  • prDeleteCacheFileContent
  • prGetCacheFileContent
  • prResolvePathViaCategoryNames
  • prResolvePathViaURLNames
  • prWriteCacheFileContent
  • putFileContents
  • recursiveCopy
  • removeFileInformation
  • renderBackendBreadcrumb
  • renderLabel
  • renderSelectProperty
  • renderTextProperty
  • saveGroupRights
  • saveRights
  • scanDirectory
  • scanPlugins
  • sendEncodingHeader
  • set_magic_quotes_gpc
  • setArtspecDefault
  • setArtspecOnline
  • setSystemProperty
  • showTree
  • startTiming
  • statCreateLocationString
  • statDisplayTopChooser
  • statDisplayYearlyTopChooser
  • statGetAvailableMonths
  • statGetAvailableYears
  • statResetStatistic
  • statsArchive
  • statsDisplayInfo
  • statsOverviewAll
  • statsOverviewTop
  • statsOverviewTopYear
  • statsOverviewYear
  • strAssignTemplate
  • strBuildSqlValues
  • strCheckTreeForErrors
  • strCopyCategory
  • strCopyTree
  • strDeeperCategoriesArray
  • strDeleteCategory
  • strHasArticles
  • strHasStartArticle
  • strMakePublic
  • strMakeVisible
  • strMoveCatTargetallowed
  • strMoveDownCategory
  • strMoveSubtree
  • strMoveUpCategory
  • strNewCategory
  • strNewTree
  • strNextBackwards
  • strNextDeeper
  • strNextDeeperAll
  • strNextPost
  • strOrderedPostTreeList
  • strRemakeTreeTable
  • strRenameCategory
  • strRenameCategoryAlias
  • strSortPrePost
  • strSyncCategory
  • systemHavePerm
  • tplAutoFillModules
  • tplBrowseLayoutForContainers
  • tplcfgDuplicate
  • tplDeleteTemplate
  • tplDuplicateTemplate
  • tplEditTemplate
  • tplGetContainerDefault
  • tplGetContainerMode
  • tplGetContainerName
  • tplGetContainerNumbersInLayout
  • tplGetContainerTypes
  • tplGetInUsedData
  • tplIsTemplateInUse
  • tplPreparseLayout
  • tplProcessSendContainerConfiguration
  • updateClientCache
  • updateFileInformation
  • uplCreateFriendlyName
  • uplDirectoryListRecursive
  • uplGetDirectoriesToExclude
  • uplGetFileExtension
  • uplGetFileIcon
  • uplGetFileTypeDescription
  • uplGetThumbnail
  • uplHasFiles
  • uplHasSubdirs
  • uplmkdir
  • uplRecursiveDBDirectoryList
  • uplRecursiveDirectoryList
  • uplRenameDirectory
  • uplSearch
  • uplSyncDirectory
  • uplSyncDirectoryDBFS
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class cAutoload

Implements autoload feature for a CONTENIDO project.

Autoloading for CONTENIDO is provided via a generated class map configuration file, which is available inside data/config/{environment}/ folder. - data/config/{environment}/config.autoloader.php

Autoloading is extendable by adding a additional class map file inside the same folder, which could contain further class map settings or could overwrite settings of main class map file. - data/config/{environment}/contenido/includes/config.autoloader.local.php

You can also add additional class map configuration by using function following functions: - cAutoload::addClassmapConfig(array $config) - cAutoload::addClassmapConfigFile($configFile)

Read also docs/techref/backend/backend.autoloader.html to get involved in CONTENIDO autoloader mechanism.

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Murat Purc murat@purc.de
Located at classes/class.autoload.php
Methods summary
public static
# initialize( array $cfg )

Initialization of CONTENIDO autoloader, is to call at least once.

Initialization of CONTENIDO autoloader, is to call at least once.

Registers itself as a __autoload implementation, includes the class map file, and if exists, the user defined class map file, containing the includes.

Parameters

$cfg
The CONTENIDO cfg array
public static
# addClassmapConfig( array $config )

Adding additional autoloader class map configuration. NOTE: Since this autoloader is implemented for CONTENIDO, it doesn't support to load classfiles being located outside of the CONTENIDO installation folder.

Adding additional autoloader class map configuration. NOTE: Since this autoloader is implemented for CONTENIDO, it doesn't support to load classfiles being located outside of the CONTENIDO installation folder.

Parameters

$config

Assoziative class map array as follows:

// Structure is: "Classname" => "Path to classfile from CONTENIDO
       installation folder"
       $config = array(
       'myPluginsClass' =>
       'contenido/plugins/myplugin/classes/class.myPluginClass.php',
       'myPluginsOtherClass' =>



           'contenido/plugins/myplugin/classes/class.myPluginsOtherClass.php',
       );
public static
# addClassmapConfigFile( string $configFile )

Adding additional autoloader class map configuration file. NOTE: Since this autoloader is implemented for CONTENIDO, it doesn't support to load classfiles being located outside of the CONTENIDO installation folder.

Adding additional autoloader class map configuration file. NOTE: Since this autoloader is implemented for CONTENIDO, it doesn't support to load classfiles being located outside of the CONTENIDO installation folder.

Parameters

$configFile

Full path to class map configuration file. The provided file must return a class map configuration array as follows:

// Structure is: "Classname" => "Path to classfile from CONTENIDO
       installation folder"
       return array(
       'myPluginsClass' =>
       'contenido/plugins/myplugin/classes/class.myPluginClass.php',
       'myPluginsOtherClass' =>



           'contenido/plugins/myplugin/classes/class.myPluginsOtherClass.php',
       'myCmsClass' => 'cms/includes/class.myCmsClass.php',
       );
public static
# autoload( string $className )

The main __autoload() implementation. Tries to include the file of passed classname.

The main __autoload() implementation. Tries to include the file of passed classname.

Parameters

$className
The classname

Throws

cBadMethodCallException
If autoloader wasn't initialized before
public static boolean
# isAutoloadable( string $file )

Checks, if passed filename is a file, which will be included by the autoloader.

Checks, if passed filename is a file, which will be included by the autoloader.

Parameters

$file

Filename or Filename with a part of the path, e. g. - class.foobar.php - classes/class.foobar.php - contenido/classes/class.foobar.php

Returns

boolean
public static array
# getLoadedClasses( )

Returns the loaded classes (@see cAutoload::$_loadedClasses)

Returns the loaded classes (@see cAutoload::$_loadedClasses)

Returns

array
public static array
# getErrors( )

Returns the errorlist containing invalid classes (@see cAutoload::$_errors)

Returns the errorlist containing invalid classes (@see cAutoload::$_errors)

Returns

array
private static Ambigous
# _getContenidoClassFile( string $className )

Returns the path to a CONTENIDO class file by processing the given classname

Returns the path to a CONTENIDO class file by processing the given classname

Parameters

$className

Returns

Ambigous
<(string, NULL), NULL, string> Path and filename or NULL
private static null
# _validateClassAndFile( string $className, string $filePathName )

Validates the given class and the file

Validates the given class and the file

Parameters

$className
$filePathName

Returns

null
unknown if validation was successfull, otherwise NULL
private static array
# _normalizeConfig( array $config )

Normalizes the passed configuration array by returning a new copy of it which contains the keys in lowercase. This prevents errors by trying to load class 'foobar' if the real class name is 'FooBar'.

Normalizes the passed configuration array by returning a new copy of it which contains the keys in lowercase. This prevents errors by trying to load class 'foobar' if the real class name is 'FooBar'.

Parameters

$config

Returns

array
private static
# _loadFile( string $filePathName, boolean $beQuiet = false )

Loads the desired file by invoking require_once method

Loads the desired file by invoking require_once method

Parameters

$filePathName
$beQuiet

Flag to prevent thrown warnings/errors by using the error control operator @

Constants summary
string ERROR_FILE_NOT_FOUND

Identifier for error if class file could not be found.

Identifier for error if class file could not be found.

# 'file_not_found'
string ERROR_CLASS_EXISTS

Identifier for error if class already exists.

Identifier for error if class already exists.

# 'class_exists'
Properties summary
private static string $_conRootPath

CONTENIDO root path. Path to the folder which contains the CONTENIDO installation.

CONTENIDO root path. Path to the folder which contains the CONTENIDO installation.

# NULL
private static array $_includeFiles

Array of interface/class names with related files to include

Array of interface/class names with related files to include

# NULL
private static boolean $_initialized

Flag containing initialized status

Flag containing initialized status

# NULL
private static array $_loadedClasses

Array to store loaded classnames and the paths to the class files. $_loadedClasses['classname'] = '/path/to/the/class.php';

Array to store loaded classnames and the paths to the class files. $_loadedClasses['classname'] = '/path/to/the/class.php';

# array()
private static array $_errors

Array to store invalid classnames and the paths to the class files. $_errors[pos] = array('class' => classname, 'file' => file, 'error' => errorType);

Array to store invalid classnames and the paths to the class files. $_errors[pos] = array('class' => classname, 'file' => file, 'error' => errorType);

# array()
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen