vendor/symfony/routing/Loader/AnnotationFileLoader.php line 56

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Routing\Loader;
  14. use Symfony\Component\Config\FileLocatorInterface;
  15. use Symfony\Component\Config\Loader\FileLoader;
  16. use Symfony\Component\Config\Resource\FileResource;
  17. use Symfony\Component\Routing\RouteCollection;
  19. /**
  20.  * AnnotationFileLoader loads routing information from annotations set
  21.  * on a PHP class and its methods.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  */
  25. class AnnotationFileLoader extends FileLoader
  26. {
  27.     protected $loader;
  29.     public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
  30.     {
  31.         if (!\function_exists('token_get_all')) {
  32.             throw new \LogicException('The Tokenizer extension is required for the routing annotation loaders.');
  33.         }
  35.         parent::__construct($locator);
  37.         $this->loader = $loader;
  38.     }
  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|null
  47.      *
  48.      * @throws \InvalidArgumentException When the file does not exist or its routes cannot be parsed
  49.      */
  50.     public function load($file, string $type = null)
  51.     {
  52.         $path = $this->locator->locate($file);
  54.         $collection = new RouteCollection();
  55.         if ($class = $this->findClass($path)) {
  56.             $refl = new \ReflectionClass($class);
  57.             if ($refl->isAbstract()) {
  58.                 return null;
  59.             }
  61.             $collection->addResource(new FileResource($path));
  62.             $collection->addCollection($this->loader->load($class, $type));
  63.         }
  65.         gc_mem_caches();
  67.         return $collection;
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public function supports($resource, string $type = null)
  74.     {
  75.         return \is_string($resource) && 'php' === pathinfo($resource, \PATHINFO_EXTENSION) && (!$type || 'annotation' === $type);
  76.     }
  78.     /**
  79.      * Returns the full class name for the first class in the file.
  80.      *
  81.      * @return string|false
  82.      */
  83.     protected function findClass(string $file)
  84.     {
  85.         $class = false;
  86.         $namespace = false;
  87.         $tokens = token_get_all(file_get_contents($file));
  89.         if (1 === \count($tokens) && \T_INLINE_HTML === $tokens[0][0]) {
  90.             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));
  91.         }
  93.         $nsTokens = [\T_NS_SEPARATOR => true, \T_STRING => true];
  94.         if (\defined('T_NAME_QUALIFIED')) {
  95.             $nsTokens[\T_NAME_QUALIFIED] = true;
  96.         }
  97.         for ($i = 0; isset($tokens[$i]); ++$i) {
  98.             $token = $tokens[$i];
  99.             if (!isset($token[1])) {
  100.                 continue;
  101.             }
  103.             if (true === $class && \T_STRING === $token[0]) {
  104.                 return $namespace.'\\'.$token[1];
  105.             }
  107.             if (true === $namespace && isset($nsTokens[$token[0]])) {
  108.                 $namespace = $token[1];
  109.                 while (isset($tokens[++$i][1], $nsTokens[$tokens[$i][0]])) {
  110.                     $namespace .= $tokens[$i][1];
  111.                 }
  112.                 $token = $tokens[$i];
  113.             }
  115.             if (\T_CLASS === $token[0]) {
  116.                 // Skip usage of ::class constant and anonymous classes
  117.                 $skipClassToken = false;
  118.                 for ($j = $i - 1; $j > 0; --$j) {
  119.                     if (!isset($tokens[$j][1])) {
  120.                         if ('(' === $tokens[$j] || ',' === $tokens[$j]) {
  121.                             $skipClassToken = true;
  122.                         }
  123.                         break;
  124.                     }
  126.                     if (\T_DOUBLE_COLON === $tokens[$j][0] || \T_NEW === $tokens[$j][0]) {
  127.                         $skipClassToken = true;
  128.                         break;
  129.                     } elseif (!\in_array($tokens[$j][0], [\T_WHITESPACE, \T_DOC_COMMENT, \T_COMMENT])) {
  130.                         break;
  131.                     }
  132.                 }
  134.                 if (!$skipClassToken) {
  135.                     $class = true;
  136.                 }
  137.             }
  139.             if (\T_NAMESPACE === $token[0]) {
  140.                 $namespace = true;
  141.             }
  142.         }
  144.         return false;
  145.     }
  146. }