AttributeFileLoader.php 4.3 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\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. * AttributeFileLoader loads routing information from attributes set
  17. * on a PHP class and its methods.
  18. *
  19. * @author Fabien Potencier <fabien@symfony.com>
  20. * @author Alexandre Daubois <alex.daubois@gmail.com>
  21. */
  22. class AttributeFileLoader extends FileLoader
  23. {
  24. public function __construct(
  25. FileLocatorInterface $locator,
  26. protected AttributeClassLoader $loader,
  27. ) {
  28. if (!\function_exists('token_get_all')) {
  29. throw new \LogicException('The Tokenizer extension is required for the routing attribute loader.');
  30. }
  31. parent::__construct($locator);
  32. }
  33. /**
  34. * Loads from attributes from a file.
  35. *
  36. * @throws \InvalidArgumentException When the file does not exist or its routes cannot be parsed
  37. */
  38. public function load(mixed $file, ?string $type = null): ?RouteCollection
  39. {
  40. $path = $this->locator->locate($file);
  41. $collection = new RouteCollection();
  42. if ($class = $this->findClass($path)) {
  43. $refl = new \ReflectionClass($class);
  44. if ($refl->isAbstract()) {
  45. return null;
  46. }
  47. $collection->addResource(new FileResource($path));
  48. $collection->addCollection($this->loader->load($class, $type));
  49. }
  50. gc_mem_caches();
  51. return $collection;
  52. }
  53. public function supports(mixed $resource, ?string $type = null): bool
  54. {
  55. return \is_string($resource) && 'php' === pathinfo($resource, \PATHINFO_EXTENSION) && (!$type || 'attribute' === $type);
  56. }
  57. /**
  58. * Returns the full class name for the first class in the file.
  59. */
  60. protected function findClass(string $file): string|false
  61. {
  62. $class = false;
  63. $namespace = false;
  64. $tokens = token_get_all(file_get_contents($file));
  65. if (1 === \count($tokens) && \T_INLINE_HTML === $tokens[0][0]) {
  66. 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));
  67. }
  68. $nsTokens = [\T_NS_SEPARATOR => true, \T_STRING => true];
  69. if (\defined('T_NAME_QUALIFIED')) {
  70. $nsTokens[\T_NAME_QUALIFIED] = true;
  71. }
  72. for ($i = 0; isset($tokens[$i]); ++$i) {
  73. $token = $tokens[$i];
  74. if (!isset($token[1])) {
  75. continue;
  76. }
  77. if (true === $class && \T_STRING === $token[0]) {
  78. return $namespace.'\\'.$token[1];
  79. }
  80. if (true === $namespace && isset($nsTokens[$token[0]])) {
  81. $namespace = $token[1];
  82. while (isset($tokens[++$i][1], $nsTokens[$tokens[$i][0]])) {
  83. $namespace .= $tokens[$i][1];
  84. }
  85. $token = $tokens[$i];
  86. }
  87. if (\T_CLASS === $token[0]) {
  88. // Skip usage of ::class constant and anonymous classes
  89. $skipClassToken = false;
  90. for ($j = $i - 1; $j > 0; --$j) {
  91. if (!isset($tokens[$j][1])) {
  92. if ('(' === $tokens[$j] || ',' === $tokens[$j]) {
  93. $skipClassToken = true;
  94. }
  95. break;
  96. }
  97. if (\T_DOUBLE_COLON === $tokens[$j][0] || \T_NEW === $tokens[$j][0]) {
  98. $skipClassToken = true;
  99. break;
  100. } elseif (!\in_array($tokens[$j][0], [\T_WHITESPACE, \T_DOC_COMMENT, \T_COMMENT])) {
  101. break;
  102. }
  103. }
  104. if (!$skipClassToken) {
  105. $class = true;
  106. }
  107. }
  108. if (\T_NAMESPACE === $token[0]) {
  109. $namespace = true;
  110. }
  111. }
  112. return false;
  113. }
  114. }