A single Route used by the Router to connect requests to parameter maps.
Not normally created as a standalone. Use Router::connect() to create Routes for your application.
__construct( string $template , array $defaults array() , array $options array() )
Constructor for a Route
$template
$defaults
optional array() $options
optional array() __set_state( array $fields )
Set state magic method to support var_export
This method helps for applications that want to implement router caching.
$fields
CakeRoute
_matchNamed( string $val , array $rule , string $context )
Check if a named parameter matches the current rules.
Return true if a given named $param's $val matches a given $rule depending on $context. Currently implemented rule types are controller, action and match that can be combined with each other.
$val
$rule
$context
boolean
_parseArgs( string $args , string $context )
Parse passed and Named parameters into a list of passed args, and a hash of named parameters. The local and global configuration for named parameters will be used.
$args
$context
array
_writeRoute( )
Builds a route regular expression.
Uses the template, defaults and options properties to compile a regular expression that can be used to parse request strings.
_writeUrl( array $params )
Converts a matching route array into a URL string.
Composes the string URL using the template used to create the route.
$params
string
compile( )
Compiles the route's regular expression.
Modifies defaults property so all necessary keys are set and populates $this->names with the named routing elements.
array
compiled( )
Check if a Route has been compiled into a regular expression.
boolean
match( array $url )
Check if a URL array matches this route instance.
If the URL matches the route parameters and settings, then return a generated string URL. If the URL doesn't match the route parameters, false will be returned. This method handles the reverse routing or conversion of URL arrays into string URLs.
$url
mixed
parse( string $url )
Checks to see if the given URL can be parsed by this route.
If the route can be parsed an array of parameters will be returned; if not false will be returned. String URLs are parsed if they match a routes regular expression.
$url
mixed
persistParams( array $url , array $params )
Apply persistent parameters to a URL array. Persistent parameters are a special key used during route creation to force route parameters to persist when omitted from a URL array.
$url
$params
array
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-CakeRoute.html