symfony API

sfRouting Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.2 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.2 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

sfRouting class controls the generation and parsing of URLs.

Inheritence

sfNoRouting, sfPathInfoRouting, sfPatternRouting  <  sfRouting

Method Summary

Method Details

  • clearRoutes () Browse code

    Clears all current routes.

  • (array) filterParametersEvent ($event, $parameters) Browse code

    $event An sfEvent instance
    $parameters

    Listens to the request.filter_parameters event.

    returns An array of parameters for the event

  • fixGeneratedUrl ($url, $absolute = false) Browse code

    $url
    $absolute

  • (string) generate ($name, $params = array(), (Boolean) $absolute = false) Browse code

    $name The route name
    $params The parameter values
    $absolute Whether to generate an absolute URL

    Generates a valid URLs for parameters.

    returns The generated URL

  • getCache () Browse code

    Returns the routing cache object.

    returns A sfCache instance or null

  • (string) getCurrentInternalUri ($with_route_name = false) Browse code

    $with_route_name Whether to give an internal URI with the route name (@route) or with the module/action pair

    Gets the internal URI for the current request.

    returns The current internal URI

  • (string) getDefaultParameter ($key) Browse code

    $key The key

    Gets a default parameter.

    returns The value

  • (array) getDefaultParameters () Browse code

    Gets the default parameters for URL generation.

    returns An array of default parameters

  • (array) getOptions () Browse code

    Returns the options.

    returns An array of options

  • (array) getRoutes () Browse code

    Gets the current compiled route array.

    returns The route array

  • (bool) hasRoutes () Browse code

    Returns true if this instance has some routes.

  • initialize ($dispatcher, $cache = null, $options = array()) Browse code

    $dispatcher An sfEventDispatcher instance
    $cache An sfCache instance
    $options An associative array of initialization options.

    Initializes this sfRouting instance.


    Available options:

    * default_module: The default module name
    * default_action: The default action name
    * logging: Whether to log or not (false by default)
    * debug: Whether to cache or not (false by default)
    * context: An array of context variables to help URL matching and generation

  • listenToChangeCultureEvent ($event) Browse code

    $event An sfEvent instance

    Listens to the user.change_culture event.

  • loadConfiguration () Browse code

    Loads routing configuration.


    This methods notifies a routing.load_configuration event.

  • mergeArrays ($arr1, $arr2) Browse code

    $arr1
    $arr2

  • parse ($url) Browse code

    $url URL to be parsed

    Parses a URL to find a matching route and sets internal state.


    Returns false if no route match the URL.

    returns An array of parameters or false if the route does not match

  • setDefaultParameter ($key, $value) Browse code

    $key The key
    $value The value

    Sets a default parameter.

  • setDefaultParameters ($parameters) Browse code

    $parameters An array of default parameters

    Sets the default parameters for URL generation.

  • (array) setRoutes ($routes) Browse code

    $routes The route array

    Sets the compiled route array.

    returns The route array

  • shutdown () Browse code

    Execute the shutdown procedure.

  • __construct ($dispatcher, $cache = null, $options = array()) Browse code

    $dispatcher
    $cache
    $options

    Class constructor.