interface UrlGeneratorInterface

UrlGeneratorInterface is the interface that all URL generator classes must implement.

@author Fabien Potencier <fabien@symfony.com>

@api

Hierarchy

Expanded class hierarchy of UrlGeneratorInterface

All classes that implement UrlGeneratorInterface

1 file declares its use of UrlGeneratorInterface
RouterInterface.php in drupal/core/vendor/symfony/routing/Symfony/Component/Routing/RouterInterface.php

File

drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php, line 24

Namespace

Symfony\Component\Routing\Generator
View source
interface UrlGeneratorInterface extends RequestContextAwareInterface {

  /**
   * Generates a URL from the given parameters.
   *
   * If the generator is not able to generate the url, it must throw the RouteNotFoundException
   * as documented below.
   *
   * @param string  $name       The name of the route
   * @param mixed   $parameters An array of parameters
   * @param Boolean $absolute   Whether to generate an absolute URL
   *
   * @return string The generated URL
   *
   * @throws RouteNotFoundException if route doesn't exist
   *
   * @api
   */
  public function generate($name, $parameters = array(), $absolute = false);

}

Members

Namesort descending Modifiers Type Description Overrides
RequestContextAwareInterface::getContext public function Gets the request context. 5
RequestContextAwareInterface::setContext public function Sets the request context. 5
UrlGeneratorInterface::generate public function Generates a URL from the given parameters. 2