Geen omschrijving

AnnotationFileLoader.php 4.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  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\Config\FileLocatorInterface;
  12. use Symfony\Component\Config\Loader\FileLoader;
  13. use Symfony\Component\Config\Resource\FileResource;
  14. use Symfony\Component\Routing\RouteCollection;
  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. public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
  25. {
  26. if (!\function_exists('token_get_all')) {
  27. throw new \LogicException('The Tokenizer extension is required for the routing annotation loaders.');
  28. }
  29. parent::__construct($locator);
  30. $this->loader = $loader;
  31. }
  32. /**
  33. * Loads from annotations from a file.
  34. *
  35. * @param string $file A PHP file path
  36. * @param string|null $type The resource type
  37. *
  38. * @return RouteCollection|null A RouteCollection instance
  39. *
  40. * @throws \InvalidArgumentException When the file does not exist or its routes cannot be parsed
  41. */
  42. public function load($file, $type = null)
  43. {
  44. $path = $this->locator->locate($file);
  45. $collection = new RouteCollection();
  46. if ($class = $this->findClass($path)) {
  47. $refl = new \ReflectionClass($class);
  48. if ($refl->isAbstract()) {
  49. return null;
  50. }
  51. $collection->addResource(new FileResource($path));
  52. $collection->addCollection($this->loader->load($class, $type));
  53. }
  54. gc_mem_caches();
  55. return $collection;
  56. }
  57. /**
  58. * {@inheritdoc}
  59. */
  60. public function supports($resource, $type = null)
  61. {
  62. return \is_string($resource) && 'php' === pathinfo($resource, \PATHINFO_EXTENSION) && (!$type || 'annotation' === $type);
  63. }
  64. /**
  65. * Returns the full class name for the first class in the file.
  66. *
  67. * @param string $file A PHP file path
  68. *
  69. * @return string|false Full class name if found, false otherwise
  70. */
  71. protected function findClass($file)
  72. {
  73. $class = false;
  74. $namespace = false;
  75. $tokens = token_get_all(file_get_contents($file));
  76. if (1 === \count($tokens) && \T_INLINE_HTML === $tokens[0][0]) {
  77. throw new \InvalidArgumentException(sprintf('The file "%s" does not contain PHP code. Did you forgot to add the "<?php" start tag at the beginning of the file?', $file));
  78. }
  79. $nsTokens = [\T_NS_SEPARATOR => true, \T_STRING => true];
  80. if (\defined('T_NAME_QUALIFIED')) {
  81. $nsTokens[\T_NAME_QUALIFIED] = true;
  82. }
  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 && isset($nsTokens[$token[0]])) {
  92. $namespace = $token[1];
  93. while (isset($tokens[++$i][1], $nsTokens[$tokens[$i][0]])) {
  94. $namespace .= $tokens[$i][1];
  95. }
  96. $token = $tokens[$i];
  97. }
  98. if (\T_CLASS === $token[0]) {
  99. // Skip usage of ::class constant and anonymous classes
  100. $skipClassToken = false;
  101. for ($j = $i - 1; $j > 0; --$j) {
  102. if (!isset($tokens[$j][1])) {
  103. if ('(' === $tokens[$j] || ',' === $tokens[$j]) {
  104. $skipClassToken = true;
  105. }
  106. break;
  107. }
  108. if (\T_DOUBLE_COLON === $tokens[$j][0] || \T_NEW === $tokens[$j][0]) {
  109. $skipClassToken = true;
  110. break;
  111. } elseif (!\in_array($tokens[$j][0], [\T_WHITESPACE, \T_DOC_COMMENT, \T_COMMENT])) {
  112. break;
  113. }
  114. }
  115. if (!$skipClassToken) {
  116. $class = true;
  117. }
  118. }
  119. if (\T_NAMESPACE === $token[0]) {
  120. $namespace = true;
  121. }
  122. }
  123. return false;
  124. }
  125. }