class ClassLoader (View source)

ClassLoader implements a PSR-0, PSR-4 and classmap class loader.

$loader = new \Composer\Autoload\ClassLoader();

// register classes with namespaces
$loader->add('Symfony\Component', __DIR__.'/component');
$loader->add('Symfony',           __DIR__.'/framework');

// activate the autoloader
$loader->register();

// to enable searching the include path (eg. for PEAR packages)
$loader->setUseIncludePath(true);

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.

This class is loosely based on the Symfony UniversalClassLoader.

Methods

getPrefixes()

No description

getPrefixesPsr4()

No description

getFallbackDirs()

No description

getFallbackDirsPsr4()

No description

getClassMap()

No description

addClassMap(array $classMap)

No description

add(string $prefix, array|string $paths, bool $prepend = false)

Registers a set of PSR-0 directories for a given prefix, either appending or prepending to the ones previously set for this prefix.

addPsr4(string $prefix, array|string $paths, bool $prepend = false)

Registers a set of PSR-4 directories for a given namespace, either appending or prepending to the ones previously set for this namespace.

set(string $prefix, array|string $paths)

Registers a set of PSR-0 directories for a given prefix, replacing any others previously set for this prefix.

setPsr4(string $prefix, array|string $paths)

Registers a set of PSR-4 directories for a given namespace, replacing any others previously set for this namespace.

setUseIncludePath(bool $useIncludePath)

Turns on searching the include path for class files.

bool
getUseIncludePath()

Can be used to check if the autoloader uses the include path to check for classes.

setClassMapAuthoritative(bool $classMapAuthoritative)

Turns off searching the prefix and fallback directories for classes that have not been registered with the class map.

bool
isClassMapAuthoritative()

Should class lookup fail if not found in the current class map?

setApcuPrefix(string|null $apcuPrefix)

APCu prefix to use to cache found/not-found classes, if the extension is enabled.

string|null
getApcuPrefix()

The APCu prefix in use, or null if APCu caching is not enabled.

register(bool $prepend = false)

Registers this instance as an autoloader.

unregister()

Unregisters this instance as an autoloader.

bool|null
loadClass(string $class)

Loads the given class or interface.

string|false
findFile(string $class)

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

Details

getPrefixes()

getPrefixesPsr4()

getFallbackDirs()

getFallbackDirsPsr4()

getClassMap()

addClassMap(array $classMap)

Parameters

array $classMap Class to filename map

add(string $prefix, array|string $paths, bool $prepend = false)

Registers a set of PSR-0 directories for a given prefix, either appending or prepending to the ones previously set for this prefix.

Parameters

string $prefix The prefix
array|string $paths The PSR-0 root directories
bool $prepend Whether to prepend the directories

addPsr4(string $prefix, array|string $paths, bool $prepend = false)

Registers a set of PSR-4 directories for a given namespace, either appending or prepending to the ones previously set for this namespace.

Parameters

string $prefix The prefix/namespace, with trailing '\'
array|string $paths The PSR-4 base directories
bool $prepend Whether to prepend the directories

Exceptions

InvalidArgumentException

set(string $prefix, array|string $paths)

Registers a set of PSR-0 directories for a given prefix, replacing any others previously set for this prefix.

Parameters

string $prefix The prefix
array|string $paths The PSR-0 base directories

setPsr4(string $prefix, array|string $paths)

Registers a set of PSR-4 directories for a given namespace, replacing any others previously set for this namespace.

Parameters

string $prefix The prefix/namespace, with trailing '\'
array|string $paths The PSR-4 base directories

Exceptions

InvalidArgumentException

setUseIncludePath(bool $useIncludePath)

Turns on searching the include path for class files.

Parameters

bool $useIncludePath

bool getUseIncludePath()

Can be used to check if the autoloader uses the include path to check for classes.

Return Value

bool

setClassMapAuthoritative(bool $classMapAuthoritative)

Turns off searching the prefix and fallback directories for classes that have not been registered with the class map.

Parameters

bool $classMapAuthoritative

bool isClassMapAuthoritative()

Should class lookup fail if not found in the current class map?

Return Value

bool

setApcuPrefix(string|null $apcuPrefix)

APCu prefix to use to cache found/not-found classes, if the extension is enabled.

Parameters

string|null $apcuPrefix

string|null getApcuPrefix()

The APCu prefix in use, or null if APCu caching is not enabled.

Return Value

string|null

register(bool $prepend = false)

Registers this instance as an autoloader.

Parameters

bool $prepend Whether to prepend the autoloader or not

unregister()

Unregisters this instance as an autoloader.

bool|null loadClass(string $class)

Loads the given class or interface.

Parameters

string $class The name of the class

Return Value

bool|null True if loaded, null otherwise

string|false findFile(string $class)

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

Parameters

string $class The name of the class

Return Value

string|false The path if found, false otherwise