Drupal investigation

AnnotationFileLoader.php 4.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  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\Routing\Loader;
  11. use Symfony\Component\Routing\RouteCollection;
  12. use Symfony\Component\Config\Resource\FileResource;
  13. use Symfony\Component\Config\Loader\FileLoader;
  14. use Symfony\Component\Config\FileLocatorInterface;
  15. /**
  16. * AnnotationFileLoader loads routing information from annotations set
  17. * on a PHP class and its methods.
  18. *
  19. * @author Fabien Potencier <fabien@symfony.com>
  20. */
  21. class AnnotationFileLoader extends FileLoader
  22. {
  23. protected $loader;
  24. /**
  25. * Constructor.
  26. *
  27. * @param FileLocatorInterface $locator A FileLocator instance
  28. * @param AnnotationClassLoader $loader An AnnotationClassLoader instance
  29. *
  30. * @throws \RuntimeException
  31. */
  32. public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
  33. {
  34. if (!function_exists('token_get_all')) {
  35. throw new \RuntimeException('The Tokenizer extension is required for the routing annotation loaders.');
  36. }
  37. parent::__construct($locator);
  38. $this->loader = $loader;
  39. }
  40. /**
  41. * Loads from annotations from a file.
  42. *
  43. * @param string $file A PHP file path
  44. * @param string|null $type The resource type
  45. *
  46. * @return RouteCollection A RouteCollection instance
  47. *
  48. * @throws \InvalidArgumentException When the file does not exist or its routes cannot be parsed
  49. */
  50. public function load($file, $type = null)
  51. {
  52. $path = $this->locator->locate($file);
  53. $collection = new RouteCollection();
  54. if ($class = $this->findClass($path)) {
  55. $collection->addResource(new FileResource($path));
  56. $collection->addCollection($this->loader->load($class, $type));
  57. }
  58. if (PHP_VERSION_ID >= 70000) {
  59. // PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
  60. gc_mem_caches();
  61. }
  62. return $collection;
  63. }
  64. /**
  65. * {@inheritdoc}
  66. */
  67. public function supports($resource, $type = null)
  68. {
  69. return is_string($resource) && 'php' === pathinfo($resource, PATHINFO_EXTENSION) && (!$type || 'annotation' === $type);
  70. }
  71. /**
  72. * Returns the full class name for the first class in the file.
  73. *
  74. * @param string $file A PHP file path
  75. *
  76. * @return string|false Full class name if found, false otherwise
  77. */
  78. protected function findClass($file)
  79. {
  80. $class = false;
  81. $namespace = false;
  82. $tokens = token_get_all(file_get_contents($file));
  83. for ($i = 0; isset($tokens[$i]); ++$i) {
  84. $token = $tokens[$i];
  85. if (!isset($token[1])) {
  86. continue;
  87. }
  88. if (true === $class && T_STRING === $token[0]) {
  89. return $namespace.'\\'.$token[1];
  90. }
  91. if (true === $namespace && T_STRING === $token[0]) {
  92. $namespace = $token[1];
  93. while (isset($tokens[++$i][1]) && in_array($tokens[$i][0], array(T_NS_SEPARATOR, T_STRING))) {
  94. $namespace .= $tokens[$i][1];
  95. }
  96. $token = $tokens[$i];
  97. }
  98. if (T_CLASS === $token[0]) {
  99. // Skip usage of ::class constant
  100. $isClassConstant = false;
  101. for ($j = $i - 1; $j > 0; --$j) {
  102. if (!isset($tokens[$j][1])) {
  103. break;
  104. }
  105. if (T_DOUBLE_COLON === $tokens[$j][0]) {
  106. $isClassConstant = true;
  107. break;
  108. } elseif (!in_array($tokens[$j][0], array(T_WHITESPACE, T_DOC_COMMENT, T_COMMENT))) {
  109. break;
  110. }
  111. }
  112. if (!$isClassConstant) {
  113. $class = true;
  114. }
  115. }
  116. if (T_NAMESPACE === $token[0]) {
  117. $namespace = true;
  118. }
  119. }
  120. return false;
  121. }
  122. }