UrlGeneratorInterface is the interface that all URL generator classes must implement.
@author Fabien Potencier <fabien@symfony.com>
@api
Expanded class hierarchy of UrlGeneratorInterface
All classes that implement UrlGeneratorInterface
interface UrlGeneratorInterface extends RequestContextAwareInterface {
/**
* Generates a URL from the given parameters.
*
* If the generator is not able to generate the url, it must throw the RouteNotFoundException
* as documented below.
*
* @param string $name The name of the route
* @param mixed $parameters An array of parameters
* @param Boolean $absolute Whether to generate an absolute URL
*
* @return string The generated URL
*
* @throws RouteNotFoundException if route doesn't exist
*
* @api
*/
public function generate($name, $parameters = array(), $absolute = false);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
RequestContextAwareInterface:: |
public | function | Gets the request context. | 5 |
RequestContextAwareInterface:: |
public | function | Sets the request context. | 5 |
UrlGeneratorInterface:: |
public | function | Generates a URL from the given parameters. | 2 |