PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of UrlGeneratorInterface.php

(no description)

File Size:	86 lines (4 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

UrlGeneratorInterface:: (1 method):
generate()

Interface: UrlGeneratorInterface - X-Ref

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.

generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH) X-Ref

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.

param: string  $name          The name of the route
param: mixed[] $parameters    An array of parameters
param: int     $referenceType The type of reference to be generated (one of the constants)
return: string The generated URL

PHP Cross Reference of phpBB-3.3.14-deutsch

/vendor/symfony/routing/Generator/ -> UrlGeneratorInterface.php (summary)

Defines 1 class