UniversalClassLoader
class UniversalClassLoader
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
Turns on searching the include for class files. Allows easy loading of installed PEAR packages
Can be used to check if the autoloader uses the include path to check for classes.
Gets the configured namespaces.
Gets the configured class prefixes.
Gets the directory(ies) to use as a fallback for namespaces.
Gets the directory(ies) to use as a fallback for class prefixes.
Registers the directory to use as a fallback for namespaces.
Registers a directory to use as a fallback for namespaces.
Registers directories to use as a fallback for class prefixes.
Registers a directory to use as a fallback for class prefixes.
Registers an array of namespaces
Registers a namespace.
Registers an array of classes using the PEAR naming convention.
Registers a set of classes using the PEAR naming convention.
Registers this instance as an autoloader.
Loads the given class or interface.
Finds the path to the file where the class is defined.
Details
at line line 75
useIncludePath(Boolean $useIncludePath)
Turns on searching the include for class files. Allows easy loading of installed PEAR packages
at line line 86
Boolean
getUseIncludePath()
Can be used to check if the autoloader uses the include path to check for classes.
at line line 96
array
getNamespaces()
Gets the configured namespaces.
at line line 106
array
getPrefixes()
Gets the configured class prefixes.
at line line 116
array
getNamespaceFallbacks()
Gets the directory(ies) to use as a fallback for namespaces.
at line line 126
array
getPrefixFallbacks()
Gets the directory(ies) to use as a fallback for class prefixes.
at line line 138
registerNamespaceFallbacks(array $dirs)
Registers the directory to use as a fallback for namespaces.
at line line 148
registerNamespaceFallback(string $dir)
Registers a directory to use as a fallback for namespaces.
at line line 160
registerPrefixFallbacks(array $dirs)
Registers directories to use as a fallback for class prefixes.
at line line 170
registerPrefixFallback(string $dir)
Registers a directory to use as a fallback for class prefixes.
at line line 182
registerNamespaces(array $namespaces)
Registers an array of namespaces
at line line 197
registerNamespace(string $namespace, array|string $paths)
Registers a namespace.
at line line 209
registerPrefixes(array $classes)
Registers an array of classes using the PEAR naming convention.
at line line 224
registerPrefix(string $prefix, array|string $paths)
Registers a set of classes using the PEAR naming convention.
at line line 236
register(Boolean $prepend = false)
Registers this instance as an autoloader.
at line line 248
Boolean|null
loadClass(string $class)
Loads the given class or interface.
at line line 264
string|null
findFile(string $class)
Finds the path to the file where the class is defined.