Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate
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.
Signature
public function generate(string
$name,
[mixed
$parameters = self::ABSOLUTE_PATH,
[Boolean|string
$referenceType = self::ABSOLUTE_PATH]] )
Parameters
$name
— string- The name of the route
$parameters
— array- An array of parameters
$referenceType
— object- The type of reference to be generated (one of the constants)
Returns
- string
- The generated URL
Errors/Exceptions
-
RouteNotFoundException
- If the named route doesn't exist
-
MissingMandatoryParametersException
- When some parameters are missing that are mandatory for the route
-
InvalidParameterException
- When a parameter value for a placeholder is not correct because