Composer\Autoload\ClassLoader Class Reference

Public Member Functions
	getPrefixes ()
	getPrefixesPsr4 ()
	getFallbackDirs ()
	getFallbackDirsPsr4 ()
	getClassMap ()
	addClassMap (array $classMap)
	add ($prefix, $paths, $prepend=false)
	addPsr4 ($prefix, $paths, $prepend=false)
	set ($prefix, $paths)
	setPsr4 ($prefix, $paths)
	setUseIncludePath ($useIncludePath)
	getUseIncludePath ()
	setClassMapAuthoritative ($classMapAuthoritative)
	isClassMapAuthoritative ()
	setApcuPrefix ($apcuPrefix)
	getApcuPrefix ()
	register ($prepend=false)
	unregister ()
	loadClass ($class)
	findFile ($class)

Detailed Description

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.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

See also

https://www.php-fig.org/psr/psr-0/

https://www.php-fig.org/psr/psr-4/

Member Function Documentation

add()

Composer\Autoload\ClassLoader::add	(		$prefix,
			$paths,
			$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

addClassMap()

Composer\Autoload\ClassLoader::addClassMap

(

array

$classMap

)

Parameters

array

$classMap

Class to filename map

addPsr4()

Composer\Autoload\ClassLoader::addPsr4	(		$prefix,
			$paths,
			$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

findFile()

Composer\Autoload\ClassLoader::findFile

(

$class

)

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

Parameters

string

$class

The name of the class

Returns

string|false The path if found, false otherwise

getApcuPrefix()

Composer\Autoload\ClassLoader::getApcuPrefix

(

)

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

Returns

string|null

getUseIncludePath()

Composer\Autoload\ClassLoader::getUseIncludePath

(

)

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

Returns

bool

isClassMapAuthoritative()

Composer\Autoload\ClassLoader::isClassMapAuthoritative

(

)

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

Returns

bool

loadClass()

Composer\Autoload\ClassLoader::loadClass

(

$class

)

Loads the given class or interface.

Parameters

string

$class

The name of the class

Returns

bool|null True if loaded, null otherwise

register()

Composer\Autoload\ClassLoader::register

(

$prepend = false

)

Registers this instance as an autoloader.

Parameters

bool

$prepend

Whether to prepend the autoloader or not

set()

Composer\Autoload\ClassLoader::set	(		$prefix,
			$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

setApcuPrefix()

Composer\Autoload\ClassLoader::setApcuPrefix

(

$apcuPrefix

)

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

Parameters

string | null

$apcuPrefix

setClassMapAuthoritative()

Composer\Autoload\ClassLoader::setClassMapAuthoritative

(

$classMapAuthoritative

)

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

Parameters

bool

$classMapAuthoritative

setPsr4()

Composer\Autoload\ClassLoader::setPsr4	(		$prefix,
			$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

setUseIncludePath()

Composer\Autoload\ClassLoader::setUseIncludePath

(

$useIncludePath

)

Turns on searching the include path for class files.

Parameters

bool

$useIncludePath

unregister()

Composer\Autoload\ClassLoader::unregister

(

)

Unregisters this instance as an autoloader.

---

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

• vendor/composer/ClassLoader.php