4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\ClassLoader;
15 * ApcClassLoader implements a wrapping autoloader cached in APC for PHP 5.3.
17 * It expects an object implementing a findFile method to find the file. This
18 * allows using it as a wrapper around the other loaders of the component (the
19 * ClassLoader for instance) but also around any other autoloaders following
20 * this convention (the Composer one for instance).
22 * // with a Symfony autoloader
23 * use Symfony\Component\ClassLoader\ClassLoader;
25 * $loader = new ClassLoader();
26 * $loader->addPrefix('Symfony\Component', __DIR__.'/component');
27 * $loader->addPrefix('Symfony', __DIR__.'/framework');
29 * // or with a Composer autoloader
30 * use Composer\Autoload\ClassLoader;
32 * $loader = new ClassLoader();
33 * $loader->add('Symfony\Component', __DIR__.'/component');
34 * $loader->add('Symfony', __DIR__.'/framework');
36 * $cachedLoader = new ApcClassLoader('my_prefix', $loader);
38 * // activate the cached autoloader
39 * $cachedLoader->register();
41 * // eventually deactivate the non-cached loader if it was registered previously
42 * // to be sure to use the cached one.
43 * $loader->unregister();
45 * @author Fabien Potencier <fabien@symfony.com>
46 * @author Kris Wallsmith <kris@symfony.com>
53 * A class loader object that implements the findFile() method.
62 * @param string $prefix The APC namespace prefix to use
63 * @param object $decorated A class loader object that implements the findFile() method
65 * @throws \RuntimeException
66 * @throws \InvalidArgumentException
68 public function __construct($prefix, $decorated)
70 if (!function_exists('apcu_fetch')) {
71 throw new \RuntimeException('Unable to use ApcClassLoader as APC is not installed.');
74 if (!method_exists($decorated, 'findFile')) {
75 throw new \InvalidArgumentException('The class finder must implement a "findFile" method.');
78 $this->prefix = $prefix;
79 $this->decorated = $decorated;
83 * Registers this instance as an autoloader.
85 * @param bool $prepend Whether to prepend the autoloader or not
87 public function register($prepend = false)
89 spl_autoload_register(array($this, 'loadClass'), true, $prepend);
93 * Unregisters this instance as an autoloader.
95 public function unregister()
97 spl_autoload_unregister(array($this, 'loadClass'));
101 * Loads the given class or interface.
103 * @param string $class The name of the class
105 * @return bool|null True, if loaded
107 public function loadClass($class)
109 if ($file = $this->findFile($class)) {
117 * Finds a file by class name while caching lookups to APC.
119 * @param string $class A class name to resolve to file
121 * @return string|null
123 public function findFile($class)
125 $file = apcu_fetch($this->prefix.$class, $success);
128 apcu_store($this->prefix.$class, $file = $this->decorated->findFile($class) ?: null);
135 * Passes through all unknown calls onto the decorated object.
137 public function __call($method, $args)
139 return call_user_func_array(array($this->decorated, $method), $args);