class AnnotationFileLoader in Zircon Profile 8

AnnotationFileLoader loads routing information from annotations set on a PHP class and its methods.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\Routing\Loader\AnnotationFileLoader extends \Symfony\Component\Config\Loader\FileLoader

1 file declares its use of AnnotationFileLoader

AnnotationFileLoaderTest.php in vendor/symfony/routing/Tests/Loader/AnnotationFileLoaderTest.php

File

vendor/symfony/routing/Loader/AnnotationFileLoader.php, line 25

Namespace

Symfony\Component\Routing\Loader

class AnnotationFileLoader extends FileLoader {
  protected $loader;

  /**
   * Constructor.
   *
   * @param FileLocatorInterface  $locator A FileLocator instance
   * @param AnnotationClassLoader $loader  An AnnotationClassLoader instance
   *
   * @throws \RuntimeException
   */
  public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader) {
    if (!function_exists('token_get_all')) {
      throw new \RuntimeException('The Tokenizer extension is required for the routing annotation loaders.');
    }
    parent::__construct($locator);
    $this->loader = $loader;
  }

  /**
   * Loads from annotations from a file.
   *
   * @param string      $file A PHP file path
   * @param string|null $type The resource type
   *
   * @return RouteCollection A RouteCollection instance
   *
   * @throws \InvalidArgumentException When the file does not exist or its routes cannot be parsed
   */
  public function load($file, $type = null) {
    $path = $this->locator
      ->locate($file);
    $collection = new RouteCollection();
    if ($class = $this
      ->findClass($path)) {
      $collection
        ->addResource(new FileResource($path));
      $collection
        ->addCollection($this->loader
        ->load($class, $type));
    }
    return $collection;
  }

  /**
   * {@inheritdoc}
   */
  public function supports($resource, $type = null) {
    return is_string($resource) && 'php' === pathinfo($resource, PATHINFO_EXTENSION) && (!$type || 'annotation' === $type);
  }

  /**
   * Returns the full class name for the first class in the file.
   *
   * @param string $file A PHP file path
   *
   * @return string|false Full class name if found, false otherwise
   */
  protected function findClass($file) {
    $class = false;
    $namespace = false;
    $tokens = token_get_all(file_get_contents($file));
    for ($i = 0, $count = count($tokens); $i < $count; ++$i) {
      $token = $tokens[$i];
      if (!is_array($token)) {
        continue;
      }
      if (true === $class && T_STRING === $token[0]) {
        return $namespace . '\\' . $token[1];
      }
      if (true === $namespace && T_STRING === $token[0]) {
        $namespace = '';
        do {
          $namespace .= $token[1];
          $token = $tokens[++$i];
        } while ($i < $count && is_array($token) && in_array($token[0], array(
          T_NS_SEPARATOR,
          T_STRING,
        )));
      }
      if (T_CLASS === $token[0]) {
        $class = true;
      }
      if (T_NAMESPACE === $token[0]) {
        $namespace = true;
      }
    }
    return false;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AnnotationFileLoader::$loader	protected	property
AnnotationFileLoader::findClass	protected	function	Returns the full class name for the first class in the file.
AnnotationFileLoader::load	public	function	Loads from annotations from a file.	1
AnnotationFileLoader::supports	public	function		1
AnnotationFileLoader::__construct	public	function	Constructor.