interface RouterInterface in Zircon Profile 8

RouterInterface is the interface that all Router classes must implement.

This interface is the concatenation of UrlMatcherInterface and UrlGeneratorInterface.

@author Fabien Potencier <[e-mail]>

Hierarchy

• interface \Symfony\Component\Routing\Matcher\UrlMatcherInterface; interface \Symfony\Component\Routing\Generator\UrlGeneratorInterface
  • interface \Symfony\Component\Routing\RouterInterface

7 files declare their use of RouterInterface

AccessAwareRouterInterface.php in core/lib/Drupal/Core/Routing/AccessAwareRouterInterface.php

Contains \Drupal\Core\Routing\AccessAwareRouterInterface.

ChainedRouterInterface.php in vendor/symfony-cmf/routing/ChainedRouterInterface.php

ChainRouter.php in vendor/symfony-cmf/routing/ChainRouter.php

ChainRouterInterface.php in vendor/symfony-cmf/routing/ChainRouterInterface.php

ChainRouterTest.php in vendor/symfony-cmf/routing/Tests/Routing/ChainRouterTest.php

... See full list

File

vendor/symfony/routing/RouterInterface.php, line 24

Namespace

Symfony\Component\Routing

interface RouterInterface extends UrlMatcherInterface, UrlGeneratorInterface {

  /**
   * Gets the RouteCollection instance associated with this Router.
   *
   * @return RouteCollection A RouteCollection instance
   */
  public function getRouteCollection();

}

Members

Name	Modifiers	Type	Description	Overrides
RequestContextAwareInterface::getContext	public	function	Gets the request context.	9
RequestContextAwareInterface::setContext	public	function	Sets the request context.	9
RouterInterface::getRouteCollection	public	function	Gets the RouteCollection instance associated with this Router.	4
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::generate	public	function	Generates a URL or path for a specific route based on the given parameters.	8
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".
UrlMatcherInterface::match	public	function	Tries to match a URL path with a set of routes.	5