1. class
  2. Symfony
  3. Bundle
  4. FrameworkBundle
  5. Templating
  6. Helper
  7. RouterHelper

RouterHelper

class RouterHelper extends Helper

RouterHelper manages links between pages in a template context.

Methods

setCharset(string $charset)

Sets the default charset.

from Helper
string
getCharset()

Gets the default charset.

from Helper
__construct(UrlGeneratorInterface $router)

Constructor.

string
path(string $name, mixed $parameters = array(), bool $relative = false)

Generates a URL reference (as an absolute or relative path) to the route with the given parameters.

string
url(string $name, mixed $parameters = array(), bool $schemeRelative = false)

Generates a URL reference (as an absolute URL or network path) to the route with the given parameters.

string
getName()

Returns the canonical name of this helper.

Details

in Helper at line line 31
setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

in Helper at line line 41
string getCharset()

Gets the default charset.

Return Value

string The default charset

at line line 31
__construct(UrlGeneratorInterface $router)

Constructor.

Parameters

UrlGeneratorInterface $router A Router instance

at line line 47
string path(string $name, mixed $parameters = array(), bool $relative = false)

Generates a URL reference (as an absolute or relative path) to the route with the given parameters.

Parameters

string $name The name of the route
mixed $parameters An array of parameters
bool $relative Whether to generate a relative or absolute path

Return Value

string The generated URL reference

See also

UrlGeneratorInterface

at line line 63
string url(string $name, mixed $parameters = array(), bool $schemeRelative = false)

Generates a URL reference (as an absolute URL or network path) to the route with the given parameters.

Parameters

string $name The name of the route
mixed $parameters An array of parameters
bool $schemeRelative Whether to omit the scheme in the generated URL reference

Return Value

string The generated URL reference

See also

UrlGeneratorInterface

at line line 71
string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name