1. class
  2. Symfony
  3. \
  4. Bundle
  5. \
  6. FrameworkBundle
  7. \
  8. Templating
  9. \
  10. Helper
  11. \
  12. RouterHelper

RouterHelper

class RouterHelper extends Helper

RouterHelper manages links between pages in a template context.

Properties

protected $charset from Helper
protected $generator

Methods

setCharset(string $charset)

Sets the default charset.

from Helper
string
getCharset()

Gets the default charset.

from Helper
__construct(UrlGeneratorInterface $router)

No description

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

setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

string getCharset()

Gets the default charset.

Return Value

string The default charset

__construct(UrlGeneratorInterface $router)

Parameters

UrlGeneratorInterface $router

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

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

string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name