Class CakeRoute

Properties summary

• $_compiledRoute protected
  string
  The compiled route regular expression
• $_greedy protected
  string

  Is this route a greedy route? Greedy routes have a /* in their template

• $_headerMap protected
  array
  HTTP header shortcut map. Used for evaluating header-based route expressions.
• $defaults public
  array
  Default parameters for a Route
• $keys public
  array

  An array of named segments in a Route. /:controller/:action/:id has 3 key elements

• $options public
  array
  An array of additional parameters for the Route.
• $template public
  string
  The routes template string.

Method Summary

• __construct() public

  Constructor for a Route

• _matchNamed() protected

  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.

• _parseArgs() protected

  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.

• _writeRoute() protected

  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() protected

  Converts a matching route array into a url string. Composes the string url using the template used to create the route.

• compile() public

  Compiles the route's regular expression. Modifies defaults property so all necessary keys are set and populates $this->names with the named routing elements.

• compiled() public

  Check if a Route has been compiled into a regular expression.

• match() public

  Attempt to match a url array. 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.

• parse() public

  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.

• persistParams() public

  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.

Method Detail

Properties detail

null

false

array(
    'type' => 'content_type',
    'method' => 'request_method',
    'server' => 'server_name'
)

array()

array()

array()

null