class UniversalClassLoader
deprecated
since version 2.4, to be removed in 3.0. Use the {@link ClassLoader} class instead.
UniversalClassLoader implements a "universal" autoloader for PHP 5.3.
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.
Example usage:
$loader = new UniversalClassLoader();
// register classes with namespaces
$loader->registerNamespaces(array(
'Symfony\Component' => __DIR__.'/component',
'Symfony' => __DIR__.'/framework',
'Sensio' => array(__DIR__.'/src', __DIR__.'/vendor'),
));
// register a library using the PEAR naming convention
$loader->registerPrefixes(array(
'Swift_' => __DIR__.'/Swift',
));
// to enable searching the include path (e.g. for PEAR packages)
$loader->useIncludePath(true);
// activate the autoloader
$loader->register();
In this example, if you try to use a class in the Symfony\Component namespace or one of its children (Symfony\Component\Console for instance), the autoloader will first look for the class under the component/ directory, and it will then fallback to the framework/ directory if not found before giving up.
Methods
useIncludePath(bool $useIncludePath) Turns on searching the include for class files. Allows easy loading of installed PEAR packages. | ||
bool | getUseIncludePath() Can be used to check if the autoloader uses the include path to check for classes. | |
array | getNamespaces() Gets the configured namespaces. | |
array | getPrefixes() Gets the configured class prefixes. | |
array | getNamespaceFallbacks() Gets the directory(ies) to use as a fallback for namespaces. | |
array | getPrefixFallbacks() Gets the directory(ies) to use as a fallback for class prefixes. | |
registerNamespaceFallbacks(array $dirs) Registers the directory to use as a fallback for namespaces. | ||
registerNamespaceFallback(string $dir) Registers a directory to use as a fallback for namespaces. | ||
registerPrefixFallbacks(array $dirs) Registers directories to use as a fallback for class prefixes. | ||
registerPrefixFallback(string $dir) Registers a directory to use as a fallback for class prefixes. | ||
registerNamespaces(array $namespaces) Registers an array of namespaces. | ||
registerNamespace(string $namespace, array|string $paths) Registers a namespace. | ||
registerPrefixes(array $classes) Registers an array of classes using the PEAR naming convention. | ||
registerPrefix(string $prefix, array|string $paths) Registers a set of classes using the PEAR naming convention. | ||
register(bool $prepend = false) Registers this instance as an autoloader. | ||
bool|null | loadClass(string $class) Loads the given class or interface. | |
string|null | findFile(string $class) Finds the path to the file where the class is defined. |
Details
useIncludePath(bool $useIncludePath)
Turns on searching the include for class files. Allows easy loading of installed PEAR packages.
bool getUseIncludePath()
Can be used to check if the autoloader uses the include path to check for classes.
array getNamespaces()
Gets the configured namespaces.
array getPrefixes()
Gets the configured class prefixes.
array getNamespaceFallbacks()
Gets the directory(ies) to use as a fallback for namespaces.
array getPrefixFallbacks()
Gets the directory(ies) to use as a fallback for class prefixes.
registerNamespaceFallbacks(array $dirs)
Registers the directory to use as a fallback for namespaces.
registerNamespaceFallback(string $dir)
Registers a directory to use as a fallback for namespaces.
registerPrefixFallbacks(array $dirs)
Registers directories to use as a fallback for class prefixes.
registerPrefixFallback(string $dir)
Registers a directory to use as a fallback for class prefixes.
registerNamespaces(array $namespaces)
Registers an array of namespaces.
registerNamespace(string $namespace, array|string $paths)
Registers a namespace.
registerPrefixes(array $classes)
Registers an array of classes using the PEAR naming convention.
registerPrefix(string $prefix, array|string $paths)
Registers a set of classes using the PEAR naming convention.
register(bool $prepend = false)
Registers this instance as an autoloader.
bool|null loadClass(string $class)
Loads the given class or interface.
string|null findFile(string $class)
Finds the path to the file where the class is defined.
Please login to continue.