A class/interface/trait autoloader for PHP. More...

Public Member Functions
	__construct (Config $config)
	Constructor. More...

	getClassMap ()
	Get the class map. More...

	getNamespaces ()
	Gets the configured namespaces. More...

	getPrefixes ()
	Gets the configured class prefixes. More...

	registerNamespaces (array $namespaces)
	Registers an array of namespaces. More...

	registerNamespace ($namespace, $paths)
	Registers a namespace. More...

	registerPrefixes (array $classes)
	Registers an array of classes using the PEAR naming convention. More...

	registerPrefix ($prefix, $paths)
	Registers a set of classes using the PEAR naming convention. More...

	addFallback ($path)
	Add a directory to search if no registered directory is found. More...

	register ()
	Registers this instance as an autoloader. More...

	loadClass ($class)
	Loads the given class or interface, possibly updating the class map. More...

	findFile ($class)
	Finds the path to the file where the class is defined. More...

Protected Attributes
	$namespaces = []

	$prefixes = []

	$fallbacks = []

	$config

	$map

	$missing = []

Detailed Description

A class/interface/trait autoloader for PHP.

It is able to load classes that use either:

The technical interoperability standards for PHP 5.3 namespaces and class names (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md);
The PEAR naming convention for classes (http://pear.php.net/).

Classes from a sub-namespace or a sub-hierarchy of PEAR classes can be looked for in a list of locations to ease the vendoring of a sub-set of classes for large projects.

All discovered files are stored in the internal class map and the map is queried before attempting to find a file.

Contains code from Symfony2's UniversalClassLoader.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition at line 48 of file ClassLoader.php.

Constructor & Destructor Documentation

Elgg\ClassLoader::__construct ( Config $config )

Constructor.

Parameters

\Elgg\Config $config Site config

Definition at line 76 of file ClassLoader.php.

Member Function Documentation

Elgg\ClassLoader::addFallback ( $path )

Add a directory to search if no registered directory is found.

Parameters

string $path The directory

Returns: void

Definition at line 167 of file ClassLoader.php.

Elgg\ClassLoader::findFile ( $class )

Finds the path to the file where the class is defined.

Parameters

string $class The name of the class

Returns: string|null The path, if found

Definition at line 217 of file ClassLoader.php.

Elgg\ClassLoader::getClassMap ( )

Get the class map.

Returns

Definition at line 88 of file ClassLoader.php.

Elgg\ClassLoader::getNamespaces ( )

Gets the configured namespaces.

Returns: array A hash with namespaces as keys and directories as values

Definition at line 97 of file ClassLoader.php.

Elgg\ClassLoader::getPrefixes ( )

Gets the configured class prefixes.

Returns: array A hash with class prefixes as keys and directories as values

Definition at line 106 of file ClassLoader.php.

Elgg\ClassLoader::loadClass ( $class )

Loads the given class or interface, possibly updating the class map.

Parameters

string $class The name of the class

Returns: void

Definition at line 187 of file ClassLoader.php.

Elgg\ClassLoader::register ( )

Registers this instance as an autoloader.

Returns: void

Definition at line 176 of file ClassLoader.php.

Elgg\ClassLoader::registerNamespace	(	$namespace,
		$paths
	)

Registers a namespace.

Parameters

string	$namespace	The namespace
array \| string	$paths	The location(s) of the namespace

Returns: void

Definition at line 131 of file ClassLoader.php.

Elgg\ClassLoader::registerNamespaces ( array $namespaces )

Registers an array of namespaces.

Parameters

array $namespaces An array of namespaces (namespaces as keys and locations as values)

Returns: void

Definition at line 117 of file ClassLoader.php.

Elgg\ClassLoader::registerPrefix	(	$prefix,
		$paths
	)

Registers a set of classes using the PEAR naming convention.

Parameters

string	$prefix	The classes prefix
array \| string	$paths	The location(s) of the classes

Returns: void

Definition at line 156 of file ClassLoader.php.

Elgg\ClassLoader::registerPrefixes ( array $classes )

Registers an array of classes using the PEAR naming convention.

Parameters

array $classes An array of classes (prefixes as keys and locations as values)

Returns: void

Definition at line 142 of file ClassLoader.php.

Member Data Documentation

Elgg\ClassLoader::$config

protected

Definition at line 59 of file ClassLoader.php.

Elgg\ClassLoader::$fallbacks = []

protected

Definition at line 54 of file ClassLoader.php.

Elgg\ClassLoader::$map

protected

Definition at line 64 of file ClassLoader.php.

Elgg\ClassLoader::$missing = []

protected

Definition at line 69 of file ClassLoader.php.

Elgg\ClassLoader::$namespaces = []

protected

Definition at line 50 of file ClassLoader.php.

Elgg\ClassLoader::$prefixes = []

protected

Definition at line 52 of file ClassLoader.php.

The documentation for this class was generated from the following file:

engine/classes/Elgg/ClassLoader.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation