WinCacheClassLoader.php 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  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. @trigger_error('The '.__NAMESPACE__.'\WinCacheClassLoader class is deprecated since Symfony 3.3 and will be removed in 4.0. Use `composer install --apcu-autoloader` instead.', \E_USER_DEPRECATED);
  12. /**
  13. * WinCacheClassLoader implements a wrapping autoloader cached in WinCache.
  14. *
  15. * It expects an object implementing a findFile method to find the file. This
  16. * allow using it as a wrapper around the other loaders of the component (the
  17. * ClassLoader for instance) but also around any other autoloaders following
  18. * this convention (the Composer one for instance).
  19. *
  20. * // with a Symfony autoloader
  21. * $loader = new ClassLoader();
  22. * $loader->addPrefix('Symfony\Component', __DIR__.'/component');
  23. * $loader->addPrefix('Symfony', __DIR__.'/framework');
  24. *
  25. * // or with a Composer autoloader
  26. * use Composer\Autoload\ClassLoader;
  27. *
  28. * $loader = new ClassLoader();
  29. * $loader->add('Symfony\Component', __DIR__.'/component');
  30. * $loader->add('Symfony', __DIR__.'/framework');
  31. *
  32. * $cachedLoader = new WinCacheClassLoader('my_prefix', $loader);
  33. *
  34. * // activate the cached autoloader
  35. * $cachedLoader->register();
  36. *
  37. * // eventually deactivate the non-cached loader if it was registered previously
  38. * // to be sure to use the cached one.
  39. * $loader->unregister();
  40. *
  41. * @author Fabien Potencier <fabien@symfony.com>
  42. * @author Kris Wallsmith <kris@symfony.com>
  43. * @author Artem Ryzhkov <artem@smart-core.org>
  44. *
  45. * @deprecated since version 3.3, to be removed in 4.0. Use `composer install --apcu-autoloader` instead.
  46. */
  47. class WinCacheClassLoader
  48. {
  49. private $prefix;
  50. /**
  51. * A class loader object that implements the findFile() method.
  52. *
  53. * @var object
  54. */
  55. protected $decorated;
  56. /**
  57. * @param string $prefix The WinCache namespace prefix to use
  58. * @param object $decorated A class loader object that implements the findFile() method
  59. *
  60. * @throws \RuntimeException
  61. * @throws \InvalidArgumentException
  62. */
  63. public function __construct($prefix, $decorated)
  64. {
  65. if (!\extension_loaded('wincache')) {
  66. throw new \RuntimeException('Unable to use WinCacheClassLoader as WinCache is not enabled.');
  67. }
  68. if (!method_exists($decorated, 'findFile')) {
  69. throw new \InvalidArgumentException('The class finder must implement a "findFile" method.');
  70. }
  71. $this->prefix = $prefix;
  72. $this->decorated = $decorated;
  73. }
  74. /**
  75. * Registers this instance as an autoloader.
  76. *
  77. * @param bool $prepend Whether to prepend the autoloader or not
  78. */
  79. public function register($prepend = false)
  80. {
  81. spl_autoload_register([$this, 'loadClass'], true, $prepend);
  82. }
  83. /**
  84. * Unregisters this instance as an autoloader.
  85. */
  86. public function unregister()
  87. {
  88. spl_autoload_unregister([$this, 'loadClass']);
  89. }
  90. /**
  91. * Loads the given class or interface.
  92. *
  93. * @param string $class The name of the class
  94. *
  95. * @return bool|null True, if loaded
  96. */
  97. public function loadClass($class)
  98. {
  99. if ($file = $this->findFile($class)) {
  100. require $file;
  101. return true;
  102. }
  103. return null;
  104. }
  105. /**
  106. * Finds a file by class name while caching lookups to WinCache.
  107. *
  108. * @param string $class A class name to resolve to file
  109. *
  110. * @return string|null
  111. */
  112. public function findFile($class)
  113. {
  114. $file = wincache_ucache_get($this->prefix.$class, $success);
  115. if (!$success) {
  116. wincache_ucache_set($this->prefix.$class, $file = $this->decorated->findFile($class) ?: null, 0);
  117. }
  118. return $file;
  119. }
  120. /**
  121. * Passes through all unknown calls onto the decorated object.
  122. */
  123. public function __call($method, $args)
  124. {
  125. return \call_user_func_array([$this->decorated, $method], $args);
  126. }
  127. }