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` `array` $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` `array` $config Assoziative class map array as follows: <pre> // 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', ); </pre>
`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` `string` $configFile Full path to class map configuration file. The provided file must return a class map configuration array as follows: <pre> // 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', ); </pre>
`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` `string` $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` `string` $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 string\|null`	# `_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` `string` $className Returns `string\|null` string if validation was successfull, otherwise NULL
`private static string\|null`	# `_validateClassAndFile( string $className, string $filePathName )` Validates the given class and the file Validates the given class and the file Parameters `$className` `string` $className `$filePathName` `string` $filePathName Returns `string\|null` string 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` `array` $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` `string` $filePathName `$beQuiet` `boolean` $beQuiet [optional] Flag to prevent thrown warnings/errors by using the error control operator @

Constants summary
`string`	`ERROR_FILE_NOT_FOUND`	`'file_not_found'`	# Identifier for error if class file could not be found. Identifier for error if class file could not be found.
`string`	`ERROR_CLASS_EXISTS`	`'class_exists'`	# Identifier for error if class already exists. Identifier for error if class already exists.

Properties summary
`private static string`	`$_conRootPath`	`NULL`	# CONTENIDO root path. Path to the folder which contains the CONTENIDO installation. CONTENIDO root path. Path to the folder which contains the CONTENIDO installation.
`private static array`	`$_includeFiles`	`NULL`	# Array of interface/class names with related files to include Array of interface/class names with related files to include
`private static boolean`	`$_initialized`	`NULL`	# Flag containing initialized status Flag containing initialized status
`private static array`	`$_loadedClasses`	`array()`	# 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';
`private static array`	`$_errors`	`array()`	# 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);

Packages

Classes

Functions

Class cAutoload

Parameters

Parameters

Parameters

Parameters

Throws

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters