PhpFileLoader.php in Zircon Profile 8

Namespace

Symfony\Component\Routing\Loader

File

vendor/symfony/routing/Loader/PhpFileLoader.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Routing\Loader;

use Symfony\Component\Config\Loader\FileLoader;
use Symfony\Component\Config\Resource\FileResource;
use Symfony\Component\Routing\RouteCollection;

/**
 * PhpFileLoader loads routes from a PHP file.
 *
 * The file must return a RouteCollection instance.
 *
 * @author Fabien Potencier <[e-mail]>
 */
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
   */
  public function load($file, $type = null) {
    $path = $this->locator
      ->locate($file);
    $this
      ->setCurrentDir(dirname($path));
    $collection = self::includeFile($path, $this);
    $collection
      ->addResource(new FileResource($path));
    return $collection;
  }

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

  /**
   * Safe include. Used for scope isolation.
   *
   * @param string        $file   File to include
   * @param PhpFileLoader $loader the loader variable is exposed to the included file below
   *
   * @return RouteCollection
   */
  private static function includeFile($file, PhpFileLoader $loader) {
    return include $file;
  }

}

Classes

Name	Description
PhpFileLoader	PhpFileLoader loads routes from a PHP file.