class AnnotationDirectoryLoader in Zircon Profile 8

AnnotationDirectoryLoader loads routing information from annotations set on PHP classes and methods.

@author Fabien Potencier <[e-mail]>

Hierarchy

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

1 file declares its use of AnnotationDirectoryLoader

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

File

vendor/symfony/routing/Loader/AnnotationDirectoryLoader.php, line 23

Namespace

Symfony\Component\Routing\Loader

class AnnotationDirectoryLoader extends AnnotationFileLoader {

  /**
   * Loads from annotations from a directory.
   *
   * @param string      $path A directory path
   * @param string|null $type The resource type
   *
   * @return RouteCollection A RouteCollection instance
   *
   * @throws \InvalidArgumentException When the directory does not exist or its routes cannot be parsed
   */
  public function load($path, $type = null) {
    $dir = $this->locator
      ->locate($path);
    $collection = new RouteCollection();
    $collection
      ->addResource(new DirectoryResource($dir, '/\\.php$/'));
    $files = iterator_to_array(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($dir), \RecursiveIteratorIterator::LEAVES_ONLY));
    usort($files, function (\SplFileInfo $a, \SplFileInfo $b) {
      return (string) $a > (string) $b ? 1 : -1;
    });
    foreach ($files as $file) {
      if (!$file
        ->isFile() || '.php' !== substr($file
        ->getFilename(), -4)) {
        continue;
      }
      if ($class = $this
        ->findClass($file)) {
        $refl = new \ReflectionClass($class);
        if ($refl
          ->isAbstract()) {
          continue;
        }
        $collection
          ->addCollection($this->loader
          ->load($class, $type));
      }
    }
    return $collection;
  }

  /**
   * {@inheritdoc}
   */
  public function supports($resource, $type = null) {
    try {
      $path = $this->locator
        ->locate($resource);
    } catch (\Exception $e) {
      return false;
    }
    return is_string($resource) && is_dir($path) && (!$type || 'annotation' === $type);
  }

}

Members

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