sfPatternRouting class controls the generation and parsing of URLs.
Method Summary
Methods inherited from sfRouting
clearRoutes , filterParametersEvent , fixGeneratedUrl , generate , getCache , getCurrentInternalUri , getDefaultParameter , getDefaultParameters , getOptions , getRoutes , hasRoutes , initialize , listenToChangeCultureEvent , loadConfiguration , parse , setDefaultParameter , setDefaultParameters , setRoutes , shutdown , __construct
Method Details
-
Adds a new route.
Alias for the connect method.
-
@see sfRouting
-
-
(array) connect ($name, $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 parameter (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
-
ensureDefaultParametersAreSet ()
Browse code
Added for better performance. We need to ensure that changed default parameters
are set, but resetting them everytime wastes many cpu cycles
-
(array|false) findRoute ($url)
Browse code
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
-
-
@see sfRouting
-
-
getCurrentInternalUri ()
Browse code
@see sfRouting
-
(string) getCurrentRouteName ()
Browse code
Gets the current route name.
returns The route name
-
@see sfRouting
-
getRouteThatMatchesParameters ()
Browse code
-
getRouteThatMatchesUrl ()
Browse code
-
(boolean) hasRouteName ($name)
Browse code
Returns true if the route name given is defined.
-
@see sfRouting
-
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
* 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).
-
Adds a new route before a given one in the current list of routes.
-
@see sfRouting
-
-
@see sfRouting
-
Adds a new route at the beginning of the current list of routes.
-
setDefaultParameter ()
Browse code
@see sfRouting
-
setDefaultParameters ()
Browse code
@see sfRouting
-
@see sfRouting
-
@see sfRouting
-
updateCurrentInternalUri ()
Browse code
|