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

Collaboration diagram for Composer\Autoload\ClassLoader:

Public Member Functions
	getPrefixes ()

	getPrefixesPsr4 ()

	getFallbackDirs ()

	getFallbackDirsPsr4 ()

	getClassMap ()

	addClassMap (array $classMap)

	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. More...

	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. More...

	set ($prefix, $paths)
	Registers a set of PSR-0 directories for a given prefix, replacing any others previously set for this prefix. More...

	setPsr4 ($prefix, $paths)
	Registers a set of PSR-4 directories for a given namespace, replacing any others previously set for this namespace. More...

	setUseIncludePath ($useIncludePath)
	Turns on searching the include path for class files. More...

	getUseIncludePath ()
	Can be used to check if the autoloader uses the include path to check for classes. More...

	setClassMapAuthoritative ($classMapAuthoritative)
	Turns off searching the prefix and fallback directories for classes that have not been registered with the class map. More...

	isClassMapAuthoritative ()
	Should class lookup fail if not found in the current class map? More...

	setApcuPrefix ($apcuPrefix)
	APCu prefix to use to cache found/not-found classes, if the extension is enabled. More...

	getApcuPrefix ()
	The APCu prefix in use, or null if APCu caching is not enabled. More...

	register ($prepend=false)
	Registers this instance as an autoloader. More...

	unregister ()
	Unregisters this instance as an autoloader. More...

	loadClass ($class)
	Loads the given class or interface. More...

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

Private Member Functions
	findFileWithExtension ($class, $ext)

Private Attributes
	$prefixLengthsPsr4 = array()

	$prefixDirsPsr4 = array()

	$fallbackDirsPsr4 = array()

	$prefixesPsr0 = array()

	$fallbackDirsPsr0 = array()

	$useIncludePath = false

	$classMap = array()

	$classMapAuthoritative = false

	$missingClasses = array()

	$apcuPrefix

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: http://www.php-fig.org/psr/psr-0/; http://www.php-fig.org/psr/psr-4/

Definition at line 43 of file ClassLoader.php.

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

Definition at line 109 of file ClassLoader.php.

    {
        if (!$prefix) {
            if ($prepend) {
                $this->fallbackDirsPsr0 = array_merge(
                    (array) $paths,
                    $this->fallbackDirsPsr0
                );
            } else {
                $this->fallbackDirsPsr0 = array_merge(
                    $this->fallbackDirsPsr0,
                    (array) $paths
                );
            }
 
            return;
        }
 
        $first = $prefix[0];
        if (!isset($this->prefixesPsr0[$first][$prefix])) {
            $this->prefixesPsr0[$first][$prefix] = (array) $paths;
 
            return;
        }
        if ($prepend) {
            $this->prefixesPsr0[$first][$prefix] = array_merge(
                (array) $paths,
                $this->prefixesPsr0[$first][$prefix]
            );
        } else {
            $this->prefixesPsr0[$first][$prefix] = array_merge(
                $this->prefixesPsr0[$first][$prefix],
                (array) $paths
            );
        }
    }

◆ addClassMap()

Composer\Autoload\ClassLoader::addClassMap ( array $classMap )

Parameters

array $classMap Class to filename map

Definition at line 92 of file ClassLoader.php.

    {
        if ($this->classMap) {
            $this->classMap = array_merge($this->classMap, $classMap);
        } else {
            $this->classMap = $classMap;
        }
    }

References Composer\Autoload\ClassLoader\$classMap.

◆ 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

InvalidArgumentException

Definition at line 156 of file ClassLoader.php.

    {
        if (!$prefix) {
            // Register directories for the root namespace.
            if ($prepend) {
                $this->fallbackDirsPsr4 = array_merge(
                    (array) $paths,
                    $this->fallbackDirsPsr4
                );
            } else {
                $this->fallbackDirsPsr4 = array_merge(
                    $this->fallbackDirsPsr4,
                    (array) $paths
                );
            }
        } elseif (!isset($this->prefixDirsPsr4[$prefix])) {
            // Register directories for a new namespace.
            $length = strlen($prefix);
            if ('\\' !== $prefix[$length - 1]) {
                throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
            }
            $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
            $this->prefixDirsPsr4[$prefix] = (array) $paths;
        } elseif ($prepend) {
            // Prepend directories for an already registered namespace.
            $this->prefixDirsPsr4[$prefix] = array_merge(
                (array) $paths,
                $this->prefixDirsPsr4[$prefix]
            );
        } else {
            // Append directories for an already registered namespace.
            $this->prefixDirsPsr4[$prefix] = array_merge(
                $this->prefixDirsPsr4[$prefix],
                (array) $paths
            );
        }
    }

◆ 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

Definition at line 335 of file ClassLoader.php.

    {
        // class map lookup
        if (isset($this->classMap[$class])) {
            return $this->classMap[$class];
        }
        if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) {
            return false;
        }
        if (null !== $this->apcuPrefix) {
            $file = apcu_fetch($this->apcuPrefix.$class, $hit);
            if ($hit) {
                return $file;
            }
        }
 
        $file = $this->findFileWithExtension($class, '.php');
 
        // Search for Hack files if we are running on HHVM
        if (false === $file && defined('HHVM_VERSION')) {
            $file = $this->findFileWithExtension($class, '.hh');
        }
 
        if (null !== $this->apcuPrefix) {
            apcu_add($this->apcuPrefix.$class, $file);
        }
 
        if (false === $file) {
            // Remember that this class does not exist.
            $this->missingClasses[$class] = true;
        }
 
        return $file;
    }

References $file, defined, and Composer\Autoload\ClassLoader\findFileWithExtension().

Referenced by Composer\Autoload\ClassLoader\loadClass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findFileWithExtension()

Composer\Autoload\ClassLoader::findFileWithExtension	(	$class,
		$ext
	)

private

Definition at line 370 of file ClassLoader.php.

    {
        // PSR-4 lookup
        $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;
 
        $first = $class[0];
        if (isset($this->prefixLengthsPsr4[$first])) {
            $subPath = $class;
            while (false !== $lastPos = strrpos($subPath, '\\')) {
                $subPath = substr($subPath, 0, $lastPos);
                $search = $subPath.'\\';
                if (isset($this->prefixDirsPsr4[$search])) {
                    foreach ($this->prefixDirsPsr4[$search] as $dir) {
                        $length = $this->prefixLengthsPsr4[$first][$search];
                        if (file_exists($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) {
                            return $file;
                        }
                    }
                }
            }
        }
 
        // PSR-4 fallback dirs
        foreach ($this->fallbackDirsPsr4 as $dir) {
            if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
                return $file;
            }
        }
 
        // PSR-0 lookup
        if (false !== $pos = strrpos($class, '\\')) {
            // namespaced class name
            $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
                . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
        } else {
            // PEAR-like class name
            $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
        }
 
        if (isset($this->prefixesPsr0[$first])) {
            foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
                if (0 === strpos($class, $prefix)) {
                    foreach ($dirs as $dir) {
                        if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
                            return $file;
                        }
                    }
                }
            }
        }
 
        // PSR-0 fallback dirs
        foreach ($this->fallbackDirsPsr0 as $dir) {
            if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
                return $file;
            }
        }
 
        // PSR-0 include paths.
        if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
            return $file;
        }
 
        return false;
    }

References $file.

Referenced by Composer\Autoload\ClassLoader\findFile().

Here is the caller graph for this function:

◆ getApcuPrefix()

Composer\Autoload\ClassLoader::getApcuPrefix ( )

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

Returns: string|null

Definition at line 290 of file ClassLoader.php.

    {
        return $this->apcuPrefix;
    }

References Composer\Autoload\ClassLoader\$apcuPrefix.

◆ getClassMap()

Composer\Autoload\ClassLoader::getClassMap ( )

Definition at line 84 of file ClassLoader.php.

    {
        return $this->classMap;
    }

References Composer\Autoload\ClassLoader\$classMap.

◆ getFallbackDirs()

Composer\Autoload\ClassLoader::getFallbackDirs ( )

Definition at line 74 of file ClassLoader.php.

    {
        return $this->fallbackDirsPsr0;
    }

References Composer\Autoload\ClassLoader\$fallbackDirsPsr0.

◆ getFallbackDirsPsr4()

Composer\Autoload\ClassLoader::getFallbackDirsPsr4 ( )

Definition at line 79 of file ClassLoader.php.

    {
        return $this->fallbackDirsPsr4;
    }

References Composer\Autoload\ClassLoader\$fallbackDirsPsr4.

◆ getPrefixes()

Composer\Autoload\ClassLoader::getPrefixes ( )

Definition at line 60 of file ClassLoader.php.

    {
        if (!empty($this->prefixesPsr0)) {
            return call_user_func_array('array_merge', $this->prefixesPsr0);
        }
 
        return array();
    }

◆ getPrefixesPsr4()

Composer\Autoload\ClassLoader::getPrefixesPsr4 ( )

Definition at line 69 of file ClassLoader.php.

    {
        return $this->prefixDirsPsr4;
    }

References Composer\Autoload\ClassLoader\$prefixDirsPsr4.

◆ getUseIncludePath()

Composer\Autoload\ClassLoader::getUseIncludePath ( )

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

Returns: bool

Definition at line 249 of file ClassLoader.php.

    {
        return $this->useIncludePath;
    }

References Composer\Autoload\ClassLoader\$useIncludePath.

◆ isClassMapAuthoritative()

Composer\Autoload\ClassLoader::isClassMapAuthoritative ( )

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

Returns: bool

Definition at line 270 of file ClassLoader.php.

    {
        return $this->classMapAuthoritative;
    }

References Composer\Autoload\ClassLoader\$classMapAuthoritative.

◆ 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

Definition at line 319 of file ClassLoader.php.

    {
        if ($file = $this->findFile($class)) {
            includeFile($file);
 
            return true;
        }
    }

References $file, Composer\Autoload\ClassLoader\findFile(), and Composer\Autoload\includeFile().

Here is the call graph for this function:

◆ register()

Composer\Autoload\ClassLoader::register ( $prepend = false )

Registers this instance as an autoloader.

Parameters

bool $prepend Whether to prepend the autoloader or not

Definition at line 300 of file ClassLoader.php.

    {
        spl_autoload_register(array($this, 'loadClass'), true, $prepend);
    }

◆ 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

Definition at line 201 of file ClassLoader.php.

    {
        if (!$prefix) {
            $this->fallbackDirsPsr0 = (array) $paths;
        } else {
            $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
        }
    }

◆ 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

Definition at line 280 of file ClassLoader.php.

    {
        $this->apcuPrefix = function_exists('apcu_fetch') && ini_get('apc.enabled') ? $apcuPrefix : null;
    }

References Composer\Autoload\ClassLoader\$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

Definition at line 260 of file ClassLoader.php.

    {
        $this->classMapAuthoritative = $classMapAuthoritative;
    }

References Composer\Autoload\ClassLoader\$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

InvalidArgumentException

Definition at line 219 of file ClassLoader.php.

    {
        if (!$prefix) {
            $this->fallbackDirsPsr4 = (array) $paths;
        } else {
            $length = strlen($prefix);
            if ('\\' !== $prefix[$length - 1]) {
                throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
            }
            $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
            $this->prefixDirsPsr4[$prefix] = (array) $paths;
        }
    }

◆ setUseIncludePath()

Composer\Autoload\ClassLoader::setUseIncludePath ( $useIncludePath )

Turns on searching the include path for class files.

Parameters

bool $useIncludePath

Definition at line 238 of file ClassLoader.php.

    {
        $this->useIncludePath = $useIncludePath;
    }

References Composer\Autoload\ClassLoader\$useIncludePath.

◆ unregister()

Composer\Autoload\ClassLoader::unregister ( )

Unregisters this instance as an autoloader.

Definition at line 308 of file ClassLoader.php.

    {
        spl_autoload_unregister(array($this, 'loadClass'));
    }

Field Documentation

◆ $apcuPrefix

Composer\Autoload\ClassLoader::$apcuPrefix

private

Definition at line 58 of file ClassLoader.php.

Referenced by Composer\Autoload\ClassLoader\getApcuPrefix(), and Composer\Autoload\ClassLoader\setApcuPrefix().

◆ $classMap

Composer\Autoload\ClassLoader::$classMap = array()

private

Definition at line 55 of file ClassLoader.php.

Referenced by Composer\Autoload\ClassLoader\addClassMap(), and Composer\Autoload\ClassLoader\getClassMap().

◆ $classMapAuthoritative

Composer\Autoload\ClassLoader::$classMapAuthoritative = false

private

Definition at line 56 of file ClassLoader.php.

Referenced by Composer\Autoload\ClassLoader\isClassMapAuthoritative(), and Composer\Autoload\ClassLoader\setClassMapAuthoritative().

◆ $fallbackDirsPsr0

Composer\Autoload\ClassLoader::$fallbackDirsPsr0 = array()

private

Definition at line 52 of file ClassLoader.php.

Referenced by Composer\Autoload\ClassLoader\getFallbackDirs().

◆ $fallbackDirsPsr4

Composer\Autoload\ClassLoader::$fallbackDirsPsr4 = array()

private

Definition at line 48 of file ClassLoader.php.

Referenced by Composer\Autoload\ClassLoader\getFallbackDirsPsr4().

◆ $missingClasses

Composer\Autoload\ClassLoader::$missingClasses = array()

private

Definition at line 57 of file ClassLoader.php.

◆ $prefixDirsPsr4

Composer\Autoload\ClassLoader::$prefixDirsPsr4 = array()

private

Definition at line 47 of file ClassLoader.php.

Referenced by Composer\Autoload\ClassLoader\getPrefixesPsr4().

◆ $prefixesPsr0

Composer\Autoload\ClassLoader::$prefixesPsr0 = array()

private

Definition at line 51 of file ClassLoader.php.

◆ $prefixLengthsPsr4

Composer\Autoload\ClassLoader::$prefixLengthsPsr4 = array()

private

Definition at line 46 of file ClassLoader.php.

◆ $useIncludePath

Composer\Autoload\ClassLoader::$useIncludePath = false

private

Definition at line 54 of file ClassLoader.php.

Referenced by Composer\Autoload\ClassLoader\getUseIncludePath(), and Composer\Autoload\ClassLoader\setUseIncludePath().

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

libs/composer/vendor/composer/ClassLoader.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ addClassMap()

◆ addPsr4()

◆ findFile()

◆ findFileWithExtension()

◆ getApcuPrefix()

◆ getClassMap()

◆ getFallbackDirs()

◆ getFallbackDirsPsr4()

◆ getPrefixes()

◆ getPrefixesPsr4()

◆ getUseIncludePath()

◆ isClassMapAuthoritative()

◆ loadClass()

◆ register()

◆ set()

◆ setApcuPrefix()

◆ setClassMapAuthoritative()

◆ setPsr4()

◆ setUseIncludePath()

◆ unregister()

Field Documentation

◆ $apcuPrefix

◆ $classMap

◆ $classMapAuthoritative

◆ $fallbackDirsPsr0

◆ $fallbackDirsPsr4

◆ $missingClasses

◆ $prefixDirsPsr4

◆ $prefixesPsr0

◆ $prefixLengthsPsr4

◆ $useIncludePath