ApcClassLoader.php 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\ClassLoader;
  11. /**
  12. * ApcClassLoader implements a wrapping autoloader cached in APC for PHP 5.3.
  13. *
  14. * It expects an object implementing a findFile method to find the file. This
  15. * allows using it as a wrapper around the other loaders of the component (the
  16. * ClassLoader and the UniversalClassLoader for instance) but also around any
  17. * other autoloaders following this convention (the Composer one for instance).
  18. *
  19. * // with a Symfony autoloader
  20. * use Symfony\Component\ClassLoader\ClassLoader;
  21. *
  22. * $loader = new ClassLoader();
  23. * $loader->addPrefix('Symfony\Component', __DIR__.'/component');
  24. * $loader->addPrefix('Symfony', __DIR__.'/framework');
  25. *
  26. * // or with a Composer autoloader
  27. * use Composer\Autoload\ClassLoader;
  28. *
  29. * $loader = new ClassLoader();
  30. * $loader->add('Symfony\Component', __DIR__.'/component');
  31. * $loader->add('Symfony', __DIR__.'/framework');
  32. *
  33. * $cachedLoader = new ApcClassLoader('my_prefix', $loader);
  34. *
  35. * // activate the cached autoloader
  36. * $cachedLoader->register();
  37. *
  38. * // eventually deactivate the non-cached loader if it was registered previously
  39. * // to be sure to use the cached one.
  40. * $loader->unregister();
  41. *
  42. * @author Fabien Potencier <fabien@symfony.com>
  43. * @author Kris Wallsmith <kris@symfony.com>
  44. */
  45. class ApcClassLoader
  46. {
  47. private $prefix;
  48. /**
  49. * A class loader object that implements the findFile() method.
  50. *
  51. * @var object
  52. */
  53. protected $decorated;
  54. /**
  55. * @param string $prefix The APC namespace prefix to use
  56. * @param object $decorated A class loader object that implements the findFile() method
  57. *
  58. * @throws \RuntimeException
  59. * @throws \InvalidArgumentException
  60. */
  61. public function __construct($prefix, $decorated)
  62. {
  63. if (!\function_exists('apcu_fetch')) {
  64. throw new \RuntimeException('Unable to use ApcClassLoader as APC is not installed.');
  65. }
  66. if (!method_exists($decorated, 'findFile')) {
  67. throw new \InvalidArgumentException('The class finder must implement a "findFile" method.');
  68. }
  69. $this->prefix = $prefix;
  70. $this->decorated = $decorated;
  71. }
  72. /**
  73. * Registers this instance as an autoloader.
  74. *
  75. * @param bool $prepend Whether to prepend the autoloader or not
  76. */
  77. public function register($prepend = false)
  78. {
  79. spl_autoload_register(array($this, 'loadClass'), true, $prepend);
  80. }
  81. /**
  82. * Unregisters this instance as an autoloader.
  83. */
  84. public function unregister()
  85. {
  86. spl_autoload_unregister(array($this, 'loadClass'));
  87. }
  88. /**
  89. * Loads the given class or interface.
  90. *
  91. * @param string $class The name of the class
  92. *
  93. * @return bool|null True, if loaded
  94. */
  95. public function loadClass($class)
  96. {
  97. if ($file = $this->findFile($class)) {
  98. require $file;
  99. return true;
  100. }
  101. }
  102. /**
  103. * Finds a file by class name while caching lookups to APC.
  104. *
  105. * @param string $class A class name to resolve to file
  106. *
  107. * @return string|null
  108. */
  109. public function findFile($class)
  110. {
  111. $file = apcu_fetch($this->prefix.$class, $success);
  112. if (!$success) {
  113. apcu_store($this->prefix.$class, $file = $this->decorated->findFile($class) ?: null);
  114. }
  115. return $file;
  116. }
  117. /**
  118. * Passes through all unknown calls onto the decorated object.
  119. */
  120. public function __call($method, $args)
  121. {
  122. return \call_user_func_array(array($this->decorated, $method), $args);
  123. }
  124. }