interface UrlGeneratorInterface in Zircon Profile 8

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

The constants in this interface define the different types of resource references that are declared in RFC 3986: http://tools.ietf.org/html/rfc3986 We are using the term "URL" instead of "URI" as this is more common in web applications and we do not need to distinguish them as the difference is mostly semantical and less technical. Generating URIs, i.e. representation-independent resource identifiers, is also possible.

@author Fabien Potencier <[e-mail]> @author Tobias Schultze <http://tobion.de>

Hierarchy

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

6 files declare their use of UrlGeneratorInterface

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

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

Router.php in vendor/symfony/routing/Router.php

RouterInterface.php in vendor/symfony/routing/RouterInterface.php

UrlGeneratorTest.php in vendor/symfony/routing/Tests/Generator/UrlGeneratorTest.php

... See full list

File

vendor/symfony/routing/Generator/UrlGeneratorInterface.php, line 32

Namespace

Symfony\Component\Routing\Generator

interface UrlGeneratorInterface extends RequestContextAwareInterface {

  /**
   * Generates an absolute URL, e.g. "http://example.com/dir/file".
   */
  const ABSOLUTE_URL = true;

  /**
   * Generates an absolute path, e.g. "/dir/file".
   */
  const ABSOLUTE_PATH = false;

  /**
   * Generates a relative path based on the current request path, e.g. "../parent-file".
   *
   * @see UrlGenerator::getRelativePath()
   */
  const RELATIVE_PATH = 'relative';

  /**
   * Generates a network path, e.g. "//example.com/dir/file".
   * Such reference reuses the current scheme but specifies the host.
   */
  const NETWORK_PATH = 'network';

  /**
   * Generates a URL or path for a specific route based on the given parameters.
   *
   * Parameters that reference placeholders in the route pattern will substitute them in the
   * path or host. Extra params are added as query string to the URL.
   *
   * When the passed reference type cannot be generated for the route because it requires a different
   * host or scheme than the current one, the method will return a more comprehensive reference
   * that includes the required params. For example, when you call this method with $referenceType = ABSOLUTE_PATH
   * but the route requires the https scheme whereas the current scheme is http, it will instead return an
   * ABSOLUTE_URL with the https scheme and the current host. This makes sure the generated URL matches
   * the route in any case.
   *
   * If there is no route with the given name, the generator must throw the RouteNotFoundException.
   *
   * @param string      $name          The name of the route
   * @param mixed       $parameters    An array of parameters
   * @param bool|string $referenceType The type of reference to be generated (one of the constants)
   *
   * @return string The generated URL
   *
   * @throws RouteNotFoundException              If the named route doesn't exist
   * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
   * @throws InvalidParameterException           When a parameter value for a placeholder is not correct because
   *                                             it does not match the requirement
   */
  public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH);

}

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".