vendor/symfony/routing/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Routing\Generator;
  13
  14 use Symfony\Component\Routing\Exception\InvalidParameterException;
  15 use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
  16 use Symfony\Component\Routing\Exception\RouteNotFoundException;
  17 use Symfony\Component\Routing\RequestContextAwareInterface;
  18
  19 /**
  20  * UrlGeneratorInterface is the interface that all URL generator classes must implement.
  21  *
  22  * The constants in this interface define the different types of resource references that
  23  * are declared in RFC 3986: http://tools.ietf.org/html/rfc3986
  24  * We are using the term "URL" instead of "URI" as this is more common in web applications
  25  * and we do not need to distinguish them as the difference is mostly semantical and
  26  * less technical. Generating URIs, i.e. representation-independent resource identifiers,
  27  * is also possible.
  28  *
  29  * @author Fabien Potencier <fabien@symfony.com>
  30  * @author Tobias Schultze <http://tobion.de>
  31  *
  32  * @api
  33  */
  34 interface UrlGeneratorInterface extends RequestContextAwareInterface
  35 {
  36     /**
  37      * Generates an absolute URL, e.g. "http://example.com/dir/file".
  38      */
  39     const ABSOLUTE_URL = true;
  40
  41     /**
  42      * Generates an absolute path, e.g. "/dir/file".
  43      */
  44     const ABSOLUTE_PATH = false;
  45
  46     /**
  47      * Generates a relative path based on the current request path, e.g. "../parent-file".
  48      * @see UrlGenerator::getRelativePath()
  49      */
  50     const RELATIVE_PATH = 'relative';
  51
  52     /**
  53      * Generates a network path, e.g. "//example.com/dir/file".
  54      * Such reference reuses the current scheme but specifies the host.
  55      */
  56     const NETWORK_PATH = 'network';
  57
  58     /**
  59      * Generates a URL or path for a specific route based on the given parameters.
  60      *
  61      * Parameters that reference placeholders in the route pattern will substitute them in the
  62      * path or host. Extra params are added as query string to the URL.
  63      *
  64      * When the passed reference type cannot be generated for the route because it requires a different
  65      * host or scheme than the current one, the method will return a more comprehensive reference
  66      * that includes the required params. For example, when you call this method with $referenceType = ABSOLUTE_PATH
  67      * but the route requires the https scheme whereas the current scheme is http, it will instead return an
  68      * ABSOLUTE_URL with the https scheme and the current host. This makes sure the generated URL matches
  69      * the route in any case.
  70      *
  71      * If there is no route with the given name, the generator must throw the RouteNotFoundException.
  72      *
  73      * @param string         $name          The name of the route
  74      * @param mixed          $parameters    An array of parameters
  75      * @param Boolean|string $referenceType The type of reference to be generated (one of the constants)
  76      *
  77      * @return string The generated URL
  78      *
  79      * @throws RouteNotFoundException              If the named route doesn't exist
  80      * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
  81      * @throws InvalidParameterException           When a parameter value for a placeholder is not correct because
  82      *                                             it does not match the requirement
  83      *
  84      * @api
  85      */
  86     public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH);
  87 }