XcacheClassLoader.php 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  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. * XcacheClassLoader implements a wrapping autoloader cached in XCache 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 XcacheClassLoader('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. * @author Kim Hemsø Rasmussen <kimhemsoe@gmail.com>
  45. */
  46. class XcacheClassLoader
  47. {
  48. private $prefix;
  49. private $decorated;
  50. /**
  51. * @param string $prefix The XCache namespace prefix to use
  52. * @param object $decorated A class loader object that implements the findFile() method
  53. *
  54. * @throws \RuntimeException
  55. * @throws \InvalidArgumentException
  56. */
  57. public function __construct($prefix, $decorated)
  58. {
  59. if (!\extension_loaded('xcache')) {
  60. throw new \RuntimeException('Unable to use XcacheClassLoader as XCache is not enabled.');
  61. }
  62. if (!method_exists($decorated, 'findFile')) {
  63. throw new \InvalidArgumentException('The class finder must implement a "findFile" method.');
  64. }
  65. $this->prefix = $prefix;
  66. $this->decorated = $decorated;
  67. }
  68. /**
  69. * Registers this instance as an autoloader.
  70. *
  71. * @param bool $prepend Whether to prepend the autoloader or not
  72. */
  73. public function register($prepend = false)
  74. {
  75. spl_autoload_register(array($this, 'loadClass'), true, $prepend);
  76. }
  77. /**
  78. * Unregisters this instance as an autoloader.
  79. */
  80. public function unregister()
  81. {
  82. spl_autoload_unregister(array($this, 'loadClass'));
  83. }
  84. /**
  85. * Loads the given class or interface.
  86. *
  87. * @param string $class The name of the class
  88. *
  89. * @return bool|null True, if loaded
  90. */
  91. public function loadClass($class)
  92. {
  93. if ($file = $this->findFile($class)) {
  94. require $file;
  95. return true;
  96. }
  97. }
  98. /**
  99. * Finds a file by class name while caching lookups to Xcache.
  100. *
  101. * @param string $class A class name to resolve to file
  102. *
  103. * @return string|null
  104. */
  105. public function findFile($class)
  106. {
  107. if (xcache_isset($this->prefix.$class)) {
  108. $file = xcache_get($this->prefix.$class);
  109. } else {
  110. $file = $this->decorated->findFile($class) ?: null;
  111. xcache_set($this->prefix.$class, $file);
  112. }
  113. return $file;
  114. }
  115. /**
  116. * Passes through all unknown calls onto the decorated object.
  117. */
  118. public function __call($method, $args)
  119. {
  120. return \call_user_func_array(array($this->decorated, $method), $args);
  121. }
  122. }