class UniversalClassLoader in Zircon Profile 8

Same name and namespace in other branches

8.0 vendor/symfony/class-loader/UniversalClassLoader.php \Symfony\Component\ClassLoader\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.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

class \Symfony\Component\ClassLoader\UniversalClassLoader

Expanded class hierarchy of UniversalClassLoader

Deprecated

since version 2.4, to be removed in 3.0. Use the {@link ClassLoader} class instead.

3 files declare their use of UniversalClassLoader

ClassNotFoundFatalErrorHandler.php in vendor/symfony/debug/FatalErrorHandler/ClassNotFoundFatalErrorHandler.php
ClassNotFoundFatalErrorHandlerTest.php in vendor/symfony/debug/Tests/FatalErrorHandler/ClassNotFoundFatalErrorHandlerTest.php
LegacyUniversalClassLoaderTest.php in vendor/symfony/class-loader/Tests/LegacyUniversalClassLoaderTest.php

File

vendor/symfony/class-loader/UniversalClassLoader.php, line 64

Namespace

Symfony\Component\ClassLoader

View source

class UniversalClassLoader {
  private $namespaces = array();
  private $prefixes = array();
  private $namespaceFallbacks = array();
  private $prefixFallbacks = array();
  private $useIncludePath = false;

  /**
   * Turns on searching the include for class files. Allows easy loading
   * of installed PEAR packages.
   *
   * @param bool $useIncludePath
   */
  public function useIncludePath($useIncludePath) {
    $this->useIncludePath = (bool) $useIncludePath;
  }

  /**
   * Can be used to check if the autoloader uses the include path to check
   * for classes.
   *
   * @return bool
   */
  public function getUseIncludePath() {
    return $this->useIncludePath;
  }

  /**
   * Gets the configured namespaces.
   *
   * @return array A hash with namespaces as keys and directories as values
   */
  public function getNamespaces() {
    return $this->namespaces;
  }

  /**
   * Gets the configured class prefixes.
   *
   * @return array A hash with class prefixes as keys and directories as values
   */
  public function getPrefixes() {
    return $this->prefixes;
  }

  /**
   * Gets the directory(ies) to use as a fallback for namespaces.
   *
   * @return array An array of directories
   */
  public function getNamespaceFallbacks() {
    return $this->namespaceFallbacks;
  }

  /**
   * Gets the directory(ies) to use as a fallback for class prefixes.
   *
   * @return array An array of directories
   */
  public function getPrefixFallbacks() {
    return $this->prefixFallbacks;
  }

  /**
   * Registers the directory to use as a fallback for namespaces.
   *
   * @param array $dirs An array of directories
   */
  public function registerNamespaceFallbacks(array $dirs) {
    $this->namespaceFallbacks = $dirs;
  }

  /**
   * Registers a directory to use as a fallback for namespaces.
   *
   * @param string $dir A directory
   */
  public function registerNamespaceFallback($dir) {
    $this->namespaceFallbacks[] = $dir;
  }

  /**
   * Registers directories to use as a fallback for class prefixes.
   *
   * @param array $dirs An array of directories
   */
  public function registerPrefixFallbacks(array $dirs) {
    $this->prefixFallbacks = $dirs;
  }

  /**
   * Registers a directory to use as a fallback for class prefixes.
   *
   * @param string $dir A directory
   */
  public function registerPrefixFallback($dir) {
    $this->prefixFallbacks[] = $dir;
  }

  /**
   * Registers an array of namespaces.
   *
   * @param array $namespaces An array of namespaces (namespaces as keys and locations as values)
   */
  public function registerNamespaces(array $namespaces) {
    foreach ($namespaces as $namespace => $locations) {
      $this->namespaces[$namespace] = (array) $locations;
    }
  }

  /**
   * Registers a namespace.
   *
   * @param string       $namespace The namespace
   * @param array|string $paths     The location(s) of the namespace
   */
  public function registerNamespace($namespace, $paths) {
    $this->namespaces[$namespace] = (array) $paths;
  }

  /**
   * Registers an array of classes using the PEAR naming convention.
   *
   * @param array $classes An array of classes (prefixes as keys and locations as values)
   */
  public function registerPrefixes(array $classes) {
    foreach ($classes as $prefix => $locations) {
      $this->prefixes[$prefix] = (array) $locations;
    }
  }

  /**
   * Registers a set of classes using the PEAR naming convention.
   *
   * @param string       $prefix The classes prefix
   * @param array|string $paths  The location(s) of the classes
   */
  public function registerPrefix($prefix, $paths) {
    $this->prefixes[$prefix] = (array) $paths;
  }

  /**
   * Registers this instance as an autoloader.
   *
   * @param bool $prepend Whether to prepend the autoloader or not
   */
  public function register($prepend = false) {
    spl_autoload_register(array(
      $this,
      'loadClass',
    ), true, $prepend);
  }

  /**
   * Loads the given class or interface.
   *
   * @param string $class The name of the class
   *
   * @return bool|null True, if loaded
   */
  public function loadClass($class) {
    if ($file = $this
      ->findFile($class)) {
      require $file;
      return true;
    }
  }

  /**
   * Finds the path to the file where the class is defined.
   *
   * @param string $class The name of the class
   *
   * @return string|null The path, if found
   */
  public function findFile($class) {
    if (false !== ($pos = strrpos($class, '\\'))) {

      // namespaced class name
      $namespace = substr($class, 0, $pos);
      $className = substr($class, $pos + 1);
      $normalizedClass = str_replace('\\', DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR . str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
      foreach ($this->namespaces as $ns => $dirs) {
        if (0 !== strpos($namespace, $ns)) {
          continue;
        }
        foreach ($dirs as $dir) {
          $file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
          if (is_file($file)) {
            return $file;
          }
        }
      }
      foreach ($this->namespaceFallbacks as $dir) {
        $file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
        if (is_file($file)) {
          return $file;
        }
      }
    }
    else {

      // PEAR-like class name
      $normalizedClass = str_replace('_', DIRECTORY_SEPARATOR, $class) . '.php';
      foreach ($this->prefixes as $prefix => $dirs) {
        if (0 !== strpos($class, $prefix)) {
          continue;
        }
        foreach ($dirs as $dir) {
          $file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
          if (is_file($file)) {
            return $file;
          }
        }
      }
      foreach ($this->prefixFallbacks as $dir) {
        $file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
        if (is_file($file)) {
          return $file;
        }
      }
    }
    if ($this->useIncludePath && ($file = stream_resolve_include_path($normalizedClass))) {
      return $file;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UniversalClassLoader::$namespaceFallbacks	private	property
UniversalClassLoader::$namespaces	private	property
UniversalClassLoader::$prefixes	private	property
UniversalClassLoader::$prefixFallbacks	private	property
UniversalClassLoader::$useIncludePath	private	property
UniversalClassLoader::findFile	public	function	Finds the path to the file where the class is defined.	1
UniversalClassLoader::getNamespaceFallbacks	public	function	Gets the directory(ies) to use as a fallback for namespaces.
UniversalClassLoader::getNamespaces	public	function	Gets the configured namespaces.
UniversalClassLoader::getPrefixes	public	function	Gets the configured class prefixes.
UniversalClassLoader::getPrefixFallbacks	public	function	Gets the directory(ies) to use as a fallback for class prefixes.
UniversalClassLoader::getUseIncludePath	public	function	Can be used to check if the autoloader uses the include path to check for classes.
UniversalClassLoader::loadClass	public	function	Loads the given class or interface.	1
UniversalClassLoader::register	public	function	Registers this instance as an autoloader.
UniversalClassLoader::registerNamespace	public	function	Registers a namespace.
UniversalClassLoader::registerNamespaceFallback	public	function	Registers a directory to use as a fallback for namespaces.
UniversalClassLoader::registerNamespaceFallbacks	public	function	Registers the directory to use as a fallback for namespaces.
UniversalClassLoader::registerNamespaces	public	function	Registers an array of namespaces.
UniversalClassLoader::registerPrefix	public	function	Registers a set of classes using the PEAR naming convention.
UniversalClassLoader::registerPrefixes	public	function	Registers an array of classes using the PEAR naming convention.
UniversalClassLoader::registerPrefixFallback	public	function	Registers a directory to use as a fallback for class prefixes.
UniversalClassLoader::registerPrefixFallbacks	public	function	Registers directories to use as a fallback for class prefixes.
UniversalClassLoader::useIncludePath	public	function	Turns on searching the include for class files. Allows easy loading of installed PEAR packages.

You are here