symfony API

Method Details

• clearRoutes () Browse code

  Clears all current routes.

• (array) filterParametersEvent ($event) Browse code

  $event

  An sfEvent instance

  Listens to the request.filter_parameters event.

  returns $parameters An array of parameters for the event

• fixGeneratedUrl () Browse code

• (string) generate ($name, $params, $absolute) 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

• (sfCache) getCache () Browse code

  Returns the routing cache object.

  returns A sfCache instance or null

• (string) getCurrentInternalUri ($with_route_name) 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, $options) 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.

• (array|false) 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

• (void) shutdown () Browse code

  Execute the shutdown procedure.

• __construct () Browse code

  Class constructor.