interface ChainRouterInterface in Zircon Profile 8

Interface for a router that proxies routing to other routers.

@author Daniel Wehner <[e-mail]>

Hierarchy

• interface \Symfony\Component\Routing\RouterInterface; interface \Symfony\Component\Routing\Matcher\RequestMatcherInterface
  • interface \Symfony\Cmf\Component\Routing\ChainRouterInterface

File

vendor/symfony-cmf/routing/ChainRouterInterface.php, line 22

Namespace

Symfony\Cmf\Component\Routing

interface ChainRouterInterface extends RouterInterface, RequestMatcherInterface {

  /**
   * Add a Router to the index.
   *
   * @param RouterInterface $router   The router instance. Instead of RouterInterface, may also
   *                                  be RequestMatcherInterface and UrlGeneratorInterface.
   * @param integer         $priority The priority
   */
  public function add($router, $priority = 0);

  /**
   * Sorts the routers and flattens them.
   *
   * @return RouterInterface[] or RequestMatcherInterface and UrlGeneratorInterface.
   */
  public function all();

}

Members

Name	Modifiers	Type	Description	Overrides
ChainRouterInterface::add	public	function	Add a Router to the index.	1
ChainRouterInterface::all	public	function	Sorts the routers and flattens them.	1
RequestContextAwareInterface::getContext	public	function	Gets the request context.	9
RequestContextAwareInterface::setContext	public	function	Sets the request context.	9
RequestMatcherInterface::matchRequest	public	function	Tries to match a request with a set of routes.	7
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