class Router in Zircon Profile 8

Same name and namespace in other branches

8.0 vendor/symfony/routing/Router.php \Symfony\Component\Routing\Router

The Router class is an example of the integration of all pieces of the routing system for easier use.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

class \Symfony\Component\Routing\Router implements RequestMatcherInterface, RouterInterface

Expanded class hierarchy of Router

1 file declares its use of Router

RouterTest.php in vendor/symfony/routing/Tests/RouterTest.php

File

vendor/symfony/routing/Router.php, line 34

Namespace

Symfony\Component\Routing

View source

class Router implements RouterInterface, RequestMatcherInterface {

  /**
   * @var UrlMatcherInterface|null
   */
  protected $matcher;

  /**
   * @var UrlGeneratorInterface|null
   */
  protected $generator;

  /**
   * @var RequestContext
   */
  protected $context;

  /**
   * @var LoaderInterface
   */
  protected $loader;

  /**
   * @var RouteCollection|null
   */
  protected $collection;

  /**
   * @var mixed
   */
  protected $resource;

  /**
   * @var array
   */
  protected $options = array();

  /**
   * @var LoggerInterface|null
   */
  protected $logger;

  /**
   * @var ConfigCacheFactoryInterface|null
   */
  private $configCacheFactory;

  /**
   * @var ExpressionFunctionProviderInterface[]
   */
  private $expressionLanguageProviders = array();

  /**
   * Constructor.
   *
   * @param LoaderInterface $loader   A LoaderInterface instance
   * @param mixed           $resource The main resource to load
   * @param array           $options  An array of options
   * @param RequestContext  $context  The context
   * @param LoggerInterface $logger   A logger instance
   */
  public function __construct(LoaderInterface $loader, $resource, array $options = array(), RequestContext $context = null, LoggerInterface $logger = null) {
    $this->loader = $loader;
    $this->resource = $resource;
    $this->logger = $logger;
    $this->context = $context ?: new RequestContext();
    $this
      ->setOptions($options);
  }

  /**
   * Sets options.
   *
   * Available options:
   *
   *   * cache_dir:     The cache directory (or null to disable caching)
   *   * debug:         Whether to enable debugging or not (false by default)
   *   * resource_type: Type hint for the main resource (optional)
   *
   * @param array $options An array of options
   *
   * @throws \InvalidArgumentException When unsupported option is provided
   */
  public function setOptions(array $options) {
    $this->options = array(
      'cache_dir' => null,
      'debug' => false,
      'generator_class' => 'Symfony\\Component\\Routing\\Generator\\UrlGenerator',
      'generator_base_class' => 'Symfony\\Component\\Routing\\Generator\\UrlGenerator',
      'generator_dumper_class' => 'Symfony\\Component\\Routing\\Generator\\Dumper\\PhpGeneratorDumper',
      'generator_cache_class' => 'ProjectUrlGenerator',
      'matcher_class' => 'Symfony\\Component\\Routing\\Matcher\\UrlMatcher',
      'matcher_base_class' => 'Symfony\\Component\\Routing\\Matcher\\UrlMatcher',
      'matcher_dumper_class' => 'Symfony\\Component\\Routing\\Matcher\\Dumper\\PhpMatcherDumper',
      'matcher_cache_class' => 'ProjectUrlMatcher',
      'resource_type' => null,
      'strict_requirements' => true,
    );

    // check option names and live merge, if errors are encountered Exception will be thrown
    $invalid = array();
    foreach ($options as $key => $value) {
      if (array_key_exists($key, $this->options)) {
        $this->options[$key] = $value;
      }
      else {
        $invalid[] = $key;
      }
    }
    if ($invalid) {
      throw new \InvalidArgumentException(sprintf('The Router does not support the following options: "%s".', implode('", "', $invalid)));
    }
  }

  /**
   * Sets an option.
   *
   * @param string $key   The key
   * @param mixed  $value The value
   *
   * @throws \InvalidArgumentException
   */
  public function setOption($key, $value) {
    if (!array_key_exists($key, $this->options)) {
      throw new \InvalidArgumentException(sprintf('The Router does not support the "%s" option.', $key));
    }
    $this->options[$key] = $value;
  }

  /**
   * Gets an option value.
   *
   * @param string $key The key
   *
   * @return mixed The value
   *
   * @throws \InvalidArgumentException
   */
  public function getOption($key) {
    if (!array_key_exists($key, $this->options)) {
      throw new \InvalidArgumentException(sprintf('The Router does not support the "%s" option.', $key));
    }
    return $this->options[$key];
  }

  /**
   * {@inheritdoc}
   */
  public function getRouteCollection() {
    if (null === $this->collection) {
      $this->collection = $this->loader
        ->load($this->resource, $this->options['resource_type']);
    }
    return $this->collection;
  }

  /**
   * {@inheritdoc}
   */
  public function setContext(RequestContext $context) {
    $this->context = $context;
    if (null !== $this->matcher) {
      $this
        ->getMatcher()
        ->setContext($context);
    }
    if (null !== $this->generator) {
      $this
        ->getGenerator()
        ->setContext($context);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {
    return $this->context;
  }

  /**
   * Sets the ConfigCache factory to use.
   *
   * @param ConfigCacheFactoryInterface $configCacheFactory The factory to use.
   */
  public function setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory) {
    $this->configCacheFactory = $configCacheFactory;
  }

  /**
   * {@inheritdoc}
   */
  public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH) {
    return $this
      ->getGenerator()
      ->generate($name, $parameters, $referenceType);
  }

  /**
   * {@inheritdoc}
   */
  public function match($pathinfo) {
    return $this
      ->getMatcher()
      ->match($pathinfo);
  }

  /**
   * {@inheritdoc}
   */
  public function matchRequest(Request $request) {
    $matcher = $this
      ->getMatcher();
    if (!$matcher instanceof RequestMatcherInterface) {

      // fallback to the default UrlMatcherInterface
      return $matcher
        ->match($request
        ->getPathInfo());
    }
    return $matcher
      ->matchRequest($request);
  }

  /**
   * Gets the UrlMatcher instance associated with this Router.
   *
   * @return UrlMatcherInterface A UrlMatcherInterface instance
   */
  public function getMatcher() {
    if (null !== $this->matcher) {
      return $this->matcher;
    }
    if (null === $this->options['cache_dir'] || null === $this->options['matcher_cache_class']) {
      $this->matcher = new $this->options['matcher_class']($this
        ->getRouteCollection(), $this->context);
      if (method_exists($this->matcher, 'addExpressionLanguageProvider')) {
        foreach ($this->expressionLanguageProviders as $provider) {
          $this->matcher
            ->addExpressionLanguageProvider($provider);
        }
      }
      return $this->matcher;
    }
    $class = $this->options['matcher_cache_class'];
    $baseClass = $this->options['matcher_base_class'];
    $expressionLanguageProviders = $this->expressionLanguageProviders;
    $that = $this;

    // required for PHP 5.3 where "$this" cannot be use()d in anonymous functions. Change in Symfony 3.0.
    $cache = $this
      ->getConfigCacheFactory()
      ->cache($this->options['cache_dir'] . '/' . $class . '.php', function (ConfigCacheInterface $cache) use ($that, $class, $baseClass, $expressionLanguageProviders) {
      $dumper = $that
        ->getMatcherDumperInstance();
      if (method_exists($dumper, 'addExpressionLanguageProvider')) {
        foreach ($expressionLanguageProviders as $provider) {
          $dumper
            ->addExpressionLanguageProvider($provider);
        }
      }
      $options = array(
        'class' => $class,
        'base_class' => $baseClass,
      );
      $cache
        ->write($dumper
        ->dump($options), $that
        ->getRouteCollection()
        ->getResources());
    });
    require_once $cache
      ->getPath();
    return $this->matcher = new $class($this->context);
  }

  /**
   * Gets the UrlGenerator instance associated with this Router.
   *
   * @return UrlGeneratorInterface A UrlGeneratorInterface instance
   */
  public function getGenerator() {
    if (null !== $this->generator) {
      return $this->generator;
    }
    if (null === $this->options['cache_dir'] || null === $this->options['generator_cache_class']) {
      $this->generator = new $this->options['generator_class']($this
        ->getRouteCollection(), $this->context, $this->logger);
    }
    else {
      $class = $this->options['generator_cache_class'];
      $baseClass = $this->options['generator_base_class'];
      $that = $this;

      // required for PHP 5.3 where "$this" cannot be use()d in anonymous functions. Change in Symfony 3.0.
      $cache = $this
        ->getConfigCacheFactory()
        ->cache($this->options['cache_dir'] . '/' . $class . '.php', function (ConfigCacheInterface $cache) use ($that, $class, $baseClass) {
        $dumper = $that
          ->getGeneratorDumperInstance();
        $options = array(
          'class' => $class,
          'base_class' => $baseClass,
        );
        $cache
          ->write($dumper
          ->dump($options), $that
          ->getRouteCollection()
          ->getResources());
      });
      require_once $cache
        ->getPath();
      $this->generator = new $class($this->context, $this->logger);
    }
    if ($this->generator instanceof ConfigurableRequirementsInterface) {
      $this->generator
        ->setStrictRequirements($this->options['strict_requirements']);
    }
    return $this->generator;
  }
  public function addExpressionLanguageProvider(ExpressionFunctionProviderInterface $provider) {
    $this->expressionLanguageProviders[] = $provider;
  }

  /**
   * This method is public because it needs to be callable from a closure in PHP 5.3. It should be converted back to protected in 3.0.
   *
   * @internal
   *
   * @return GeneratorDumperInterface
   */
  public function getGeneratorDumperInstance() {
    return new $this->options['generator_dumper_class']($this
      ->getRouteCollection());
  }

  /**
   * This method is public because it needs to be callable from a closure in PHP 5.3. It should be converted back to protected in 3.0.
   *
   * @internal
   *
   * @return MatcherDumperInterface
   */
  public function getMatcherDumperInstance() {
    return new $this->options['matcher_dumper_class']($this
      ->getRouteCollection());
  }

  /**
   * Provides the ConfigCache factory implementation, falling back to a
   * default implementation if necessary.
   *
   * @return ConfigCacheFactoryInterface $configCacheFactory
   */
  private function getConfigCacheFactory() {
    if (null === $this->configCacheFactory) {
      $this->configCacheFactory = new ConfigCacheFactory($this->options['debug']);
    }
    return $this->configCacheFactory;
  }

}

Members

Name	Modifiers	Type	Description
Router::$collection	protected	property
Router::$configCacheFactory	private	property
Router::$context	protected	property
Router::$expressionLanguageProviders	private	property
Router::$generator	protected	property
Router::$loader	protected	property
Router::$logger	protected	property
Router::$matcher	protected	property
Router::$options	protected	property
Router::$resource	protected	property
Router::addExpressionLanguageProvider	public	function
Router::generate	public	function	Generates a URL or path for a specific route based on the given parameters. Overrides UrlGeneratorInterface::generate
Router::getConfigCacheFactory	private	function	Provides the ConfigCache factory implementation, falling back to a default implementation if necessary.
Router::getContext	public	function	Gets the request context. Overrides RequestContextAwareInterface::getContext
Router::getGenerator	public	function	Gets the UrlGenerator instance associated with this Router.
Router::getGeneratorDumperInstance	public	function	This method is public because it needs to be callable from a closure in PHP 5.3. It should be converted back to protected in 3.0.
Router::getMatcher	public	function	Gets the UrlMatcher instance associated with this Router.
Router::getMatcherDumperInstance	public	function	This method is public because it needs to be callable from a closure in PHP 5.3. It should be converted back to protected in 3.0.
Router::getOption	public	function	Gets an option value.
Router::getRouteCollection	public	function	Gets the RouteCollection instance associated with this Router. Overrides RouterInterface::getRouteCollection
Router::match	public	function	Tries to match a URL path with a set of routes. Overrides UrlMatcherInterface::match
Router::matchRequest	public	function	Tries to match a request with a set of routes. Overrides RequestMatcherInterface::matchRequest
Router::setConfigCacheFactory	public	function	Sets the ConfigCache factory to use.
Router::setContext	public	function	Sets the request context. Overrides RequestContextAwareInterface::setContext
Router::setOption	public	function	Sets an option.
Router::setOptions	public	function	Sets options.
Router::__construct	public	function	Constructor.
UrlGeneratorInterface::ABSOLUTE_PATH		constant	Generates an absolute path, e.g. "/dir/file".
UrlGeneratorInterface::ABSOLUTE_URL		constant	Generates an absolute URL, e.g. "http://example.com/dir/file".
UrlGeneratorInterface::NETWORK_PATH		constant	Generates a network path, e.g. "//example.com/dir/file". Such reference reuses the current scheme but specifies the host.
UrlGeneratorInterface::RELATIVE_PATH		constant	Generates a relative path based on the current request path, e.g. "../parent-file".

You are here

class Router in Zircon Profile 8

Hierarchy

File

Namespace

Members

API Navigation