4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
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;
20 * AnnotationFileLoader loads routing information from annotations set
21 * on a PHP class and its methods.
23 * @author Fabien Potencier <fabien@symfony.com>
25 class AnnotationFileLoader extends FileLoader
30 * @throws \RuntimeException
32 public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
34 if (!\function_exists('token_get_all')) {
35 throw new \RuntimeException('The Tokenizer extension is required for the routing annotation loaders.');
38 parent::__construct($locator);
40 $this->loader = $loader;
44 * Loads from annotations from a file.
46 * @param string $file A PHP file path
47 * @param string|null $type The resource type
49 * @return RouteCollection A RouteCollection instance
51 * @throws \InvalidArgumentException When the file does not exist or its routes cannot be parsed
53 public function load($file, $type = null)
55 $path = $this->locator->locate($file);
57 $collection = new RouteCollection();
58 if ($class = $this->findClass($path)) {
59 $collection->addResource(new FileResource($path));
60 $collection->addCollection($this->loader->load($class, $type));
62 if (\PHP_VERSION_ID >= 70000) {
63 // PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
73 public function supports($resource, $type = null)
75 return \is_string($resource) && 'php' === pathinfo($resource, PATHINFO_EXTENSION) && (!$type || 'annotation' === $type);
79 * Returns the full class name for the first class in the file.
81 * @param string $file A PHP file path
83 * @return string|false Full class name if found, false otherwise
85 protected function findClass($file)
89 $tokens = token_get_all(file_get_contents($file));
91 if (1 === \count($tokens) && T_INLINE_HTML === $tokens[0][0]) {
92 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));
95 for ($i = 0; isset($tokens[$i]); ++$i) {
98 if (!isset($token[1])) {
102 if (true === $class && T_STRING === $token[0]) {
103 return $namespace.'\\'.$token[1];
106 if (true === $namespace && T_STRING === $token[0]) {
107 $namespace = $token[1];
108 while (isset($tokens[++$i][1]) && \in_array($tokens[$i][0], array(T_NS_SEPARATOR, T_STRING))) {
109 $namespace .= $tokens[$i][1];
111 $token = $tokens[$i];
114 if (T_CLASS === $token[0]) {
115 // Skip usage of ::class constant and anonymous classes
116 $skipClassToken = false;
117 for ($j = $i - 1; $j > 0; --$j) {
118 if (!isset($tokens[$j][1])) {
122 if (T_DOUBLE_COLON === $tokens[$j][0] || T_NEW === $tokens[$j][0]) {
123 $skipClassToken = true;
125 } elseif (!\in_array($tokens[$j][0], array(T_WHITESPACE, T_DOC_COMMENT, T_COMMENT))) {
130 if (!$skipClassToken) {
135 if (T_NAMESPACE === $token[0]) {