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

The special parameter _fragment will be used as the document fragment suffixed to the final URL.

Throws

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 it does not match the requirement

6 methods override UrlGeneratorInterface::generate()

AccessAwareRouter::generate in core/lib/Drupal/Core/Routing/AccessAwareRouter.php: Generates a URL or path for a specific route based on the given parameters.
MetadataBubblingUrlGenerator::generate in core/lib/Drupal/Core/Render/MetadataBubblingUrlGenerator.php: Generates a URL or path for a specific route based on the given parameters.
Router::generate in core/lib/Drupal/Core/Routing/Router.php: This method is intentionally not implemented.
Router::generate in vendor/symfony/routing/Router.php: Generates a URL or path for a specific route based on the given parameters.
UrlGenerator::generate in core/lib/Drupal/Core/Routing/UrlGenerator.php: Generates a URL or path for a specific route based on the given parameters.

... See full list

File

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

Class

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

Namespace

Symfony\Component\Routing\Generator

Code

public function generate(string $name, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH) : string;