interface VersatileGeneratorInterface in Zircon Profile 8

This generator is able to handle more than string route names as symfony core supports them.

Hierarchy

• interface \Symfony\Component\Routing\RequestContextAwareInterface
  • interface \Symfony\Component\Routing\Generator\UrlGeneratorInterface
    • interface \Symfony\Cmf\Component\Routing\VersatileGeneratorInterface

2 files declare their use of VersatileGeneratorInterface

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

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

Contains \Drupal\Core\Routing\UrlGeneratorInterface.

File

vendor/symfony-cmf/routing/VersatileGeneratorInterface.php, line 20

Namespace

Symfony\Cmf\Component\Routing

interface VersatileGeneratorInterface extends UrlGeneratorInterface {

  /**
   * Whether this generator supports the supplied $name.
   *
   * This check does not need to look if the specific instance can be
   * resolved to a route, only whether the router can generate routes from
   * objects of this class.
   *
   * @param mixed $name The route "name" which may also be an object or anything
   *
   * @return bool
   */
  public function supports($name);

  /**
   * Convert a route identifier (name, content object etc) into a string
   * usable for logging and other debug/error messages
   *
   * @param mixed $name
   * @param array $parameters which should contain a content field containing
   *                          a RouteReferrersReadInterface object
   *
   * @return string
   */
  public function getRouteDebugMessage($name, array $parameters = array());

}

Members

Name	Modifiers	Type	Description	Overrides
RequestContextAwareInterface::getContext	public	function	Gets the request context.	9
RequestContextAwareInterface::setContext	public	function	Sets the request context.	9
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".
VersatileGeneratorInterface::getRouteDebugMessage	public	function	Convert a route identifier (name, content object etc) into a string usable for logging and other debug/error messages	5
VersatileGeneratorInterface::supports	public	function	Whether this generator supports the supplied $name.	5