class XcacheClassLoader in Zircon Profile 8

XcacheClassLoader implements a wrapping autoloader cached in XCache for PHP 5.3.

It expects an object implementing a findFile method to find the file. This allows using it as a wrapper around the other loaders of the component (the ClassLoader and the UniversalClassLoader for instance) but also around any other autoloaders following this convention (the Composer one for instance).

// with a Symfony autoloader use Symfony\Component\ClassLoader\ClassLoader;

$loader = new ClassLoader(); $loader->addPrefix('Symfony\Component', __DIR__.'/component'); $loader->addPrefix('Symfony', __DIR__.'/framework');

// or with a Composer autoloader use Composer\Autoload\ClassLoader;

$loader = new ClassLoader(); $loader->add('Symfony\Component', __DIR__.'/component'); $loader->add('Symfony', __DIR__.'/framework');

$cachedLoader = new XcacheClassLoader('my_prefix', $loader);

// activate the cached autoloader $cachedLoader->register();

// eventually deactivate the non-cached loader if it was registered previously // to be sure to use the cached one. $loader->unregister();

@author Fabien Potencier <[e-mail]> @author Kris Wallsmith <[e-mail]> @author Kim Hemsø Rasmussen <[e-mail]>

Hierarchy

• class \Symfony\Component\ClassLoader\XcacheClassLoader

File

vendor/symfony/class-loader/XcacheClassLoader.php, line 49

Namespace

Symfony\Component\ClassLoader

class XcacheClassLoader {
  private $prefix;

  /**
   * A class loader object that implements the findFile() method.
   *
   * @var object
   */
  private $decorated;

  /**
   * Constructor.
   *
   * @param string $prefix    The XCache namespace prefix to use.
   * @param object $decorated A class loader object that implements the findFile() method.
   *
   * @throws \RuntimeException
   * @throws \InvalidArgumentException
   */
  public function __construct($prefix, $decorated) {
    if (!extension_loaded('xcache')) {
      throw new \RuntimeException('Unable to use XcacheClassLoader as XCache is not enabled.');
    }
    if (!method_exists($decorated, 'findFile')) {
      throw new \InvalidArgumentException('The class finder must implement a "findFile" method.');
    }
    $this->prefix = $prefix;
    $this->decorated = $decorated;
  }

  /**
   * 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);
  }

  /**
   * Unregisters this instance as an autoloader.
   */
  public function unregister() {
    spl_autoload_unregister(array(
      $this,
      'loadClass',
    ));
  }

  /**
   * 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 a file by class name while caching lookups to Xcache.
   *
   * @param string $class A class name to resolve to file
   *
   * @return string|null
   */
  public function findFile($class) {
    if (xcache_isset($this->prefix . $class)) {
      $file = xcache_get($this->prefix . $class);
    }
    else {
      $file = $this->decorated
        ->findFile($class);
      xcache_set($this->prefix . $class, $file);
    }
    return $file;
  }

  /**
   * Passes through all unknown calls onto the decorated object.
   */
  public function __call($method, $args) {
    return call_user_func_array(array(
      $this->decorated,
      $method,
    ), $args);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
XcacheClassLoader::$decorated	private	property	A class loader object that implements the findFile() method.
XcacheClassLoader::$prefix	private	property
XcacheClassLoader::findFile	public	function	Finds a file by class name while caching lookups to Xcache.
XcacheClassLoader::loadClass	public	function	Loads the given class or interface.
XcacheClassLoader::register	public	function	Registers this instance as an autoloader.
XcacheClassLoader::unregister	public	function	Unregisters this instance as an autoloader.
XcacheClassLoader::__call	public	function	Passes through all unknown calls onto the decorated object.
XcacheClassLoader::__construct	public	function	Constructor.