class PhpFileLoader

Same name in this branch
  1. 8.x drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Loader/PhpFileLoader.php \Symfony\Component\Routing\Loader\PhpFileLoader
  2. 8.x drupal/core/vendor/symfony/dependency-injection/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php \Symfony\Component\DependencyInjection\Loader\PhpFileLoader

PhpFileLoader loads routes from a PHP file.

The file must return a RouteCollection instance.

@author Fabien Potencier <fabien@symfony.com>

@api

Hierarchy

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

Expanded class hierarchy of PhpFileLoader

1 file declares its use of PhpFileLoader
PhpFileLoaderTest.php in drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php

File

drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Loader/PhpFileLoader.php, line 27

Namespace

Symfony\Component\Routing\Loader
View source
class PhpFileLoader extends FileLoader {

  /**
   * Loads a PHP file.
   *
   * @param string      $file A PHP file path
   * @param string|null $type The resource type
   *
   * @return RouteCollection A RouteCollection instance
   *
   * @api
   */
  public function load($file, $type = null) {

    // the loader variable is exposed to the included file below
    $loader = $this;
    $path = $this->locator
      ->locate($file);
    $this
      ->setCurrentDir(dirname($path));
    $collection = (include $path);
    $collection
      ->addResource(new FileResource($path));
    return $collection;
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
PhpFileLoader::load public function Loads a PHP file.
PhpFileLoader::supports public function @api