symfony API

sfPatternRouting 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.

sfPatternRouting class controls the generation and parsing of URLs.

Inheritence

sfPatternRouting  <  sfRouting

Method Summary

Methods inherited from sfRouting

clearRoutes , filterParametersEvent , fixGeneratedUrl , generate , getCache , getCurrentInternalUri , getDefaultParameter , getDefaultParameters , getOptions , getRoutes , hasRoutes , initialize , listenToChangeCultureEvent , loadConfiguration , mergeArrays , parse , setDefaultParameter , setDefaultParameters , setRoutes , shutdown , __construct

Method Details

  • appendRoute ($name, $route) Browse code

    $name
    $route

    Adds a new route.


    Alias for the connect method.

  • clearRoutes () Browse code

  • configureRoute ($route) Browse code

    $route

  • (array) connect ($name, (sfRoute) $route) Browse code

    $name The route name
    $route A sfRoute instance

    Adds a new route at the end of the current list of routes.


    A route string is a string with 2 special constructions:


    • :string: :string denotes a named paramater (available later as $request->getParameter('string'))

    • *: * match an indefinite number of parameters in a route



    Here is a very common rule in a symfony project:

     $r->connect('default', new sfRoute('/:module/:action/*'));

    returns current routes

  • findRoute ($url) Browse code

    $url URL to be parsed

    Finds a matching route for given URL.


    Returns false if no route matches.

    Returned array contains:


    • name: name or alias of the route that matched

    • pattern: the compiled pattern of the route that matched

    • parameters: array containing key value pairs of the request parameters including defaults



    returns An array with routing information or false if no route matched

  • flattenRoutes ($routes) Browse code

    $routes

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

    $name
    $params
    $absolute

  • getCurrentInternalUri ($withRouteName = false) Browse code

    $withRouteName

  • (string) getCurrentRouteName () Browse code

    Gets the current route name.

    returns The route name

  • getRoutes () Browse code

  • getRouteThatMatchesParameters ($parameters) Browse code

    $parameters

  • getRouteThatMatchesUrl ($url) Browse code

    $url

  • (boolean) hasRouteName ($name) Browse code

    $name The route name

    Returns true if the route name given is defined.

  • hasRoutes () Browse code

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

    $dispatcher
    $cache
    $options

    Initializes this Routing.


    Available options:

    * suffix: The default suffix
    * variable_prefixes: An array of characters that starts a variable name (: by default)
    * segment_separators: An array of allowed characters for segment separators (/ and . by default)
    * variable_regex: A regex that match a valid variable name ([\w\d_]+ by default)
    * generate_shortest_url: Whether to generate the shortest URL possible (true by default)
    * extra_parameters_as_query_string: Whether to generate extra parameters as a query string
    * lazy_routes_deserialize: Use lazy route deserialization optimization: not all routes are deserialized upfront but on demand (false by default)
    * lookup_cache_dedicated_keys: Whether to use dedicated keys for parse/generate cache (false by default) WARNING: When this option is activated, do not use sfFileCache; use a fast access cache backend (like sfAPCCache).

  • insertRouteBefore ($pivot, $name, $route) Browse code

    $pivot
    $name
    $route

    Adds a new route before a given one in the current list of routes.

  • loadConfiguration () Browse code

  • loadRoute ($name) Browse code

    $name The name of the route

    Load a lazy route from cache

    returns The route instance unserialized from the cache

  • loadRoutes () Browse code

    Load all lazy routes

  • normalizeUrl ($url) Browse code

    $url

  • parse ($url) Browse code

    $url

  • prependRoute ($name, $route) Browse code

    $name
    $route

    Adds a new route at the beginning of the current list of routes.

  • setRoutes ($routes) Browse code

    $routes

  • shutdown () Browse code

  • updateCurrentInternalUri ($name, $parameters) Browse code

    $name
    $parameters