CakeRoute Class Info:

Class Declaration:

class CakeRoute

File name:
cake/libs/router.php
Description:

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.

Package
cake.libs
Since

1.3.0

See

Router::connect()

Properties:

Show/Hide parent properties

  • _compiledRoute string

    The compiled route regular expresssion

  • defaults array

    Default parameters for a Route

  • _greedy string

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

  • __headerMap array

    HTTP header shortcut map. Used for evaluating header-based route expressions.

  • keys array

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

  • options array

    An array of additional parameters for the Route.

  • template string

    The routes template string.

Method Summary:

Show/Hide parent methods

CakeRoute

top

Constructor for a Route

Parameters:
  • string $template required

    Template string with parameter placeholders

  • array $defaults optional array ( )

    Array of defaults for the route.

  • $options optional array ( )

Method defined in:
cake/libs/router.php on line 1307
Return

void

Access

public

compile

top

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

Method defined in:
cake/libs/router.php on line 1330
Return

array Returns a string regular expression of the compiled route.

Access

public

compiled

top

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

Method defined in:
cake/libs/router.php on line 1319
Return

boolean

Access

public

match

top

Attempt to match a url array. If the url matches the route parameters + 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.

Parameters:
  • array $url required

    An array of parameters to check matching with.

Method defined in:
cake/libs/router.php on line 1468
Return

mixed Either a string url for the parameters if they match or false.

Access

public

parse

top

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.

Parameters:
  • string $url required

    The url to attempt to parse.

Method defined in:
cake/libs/router.php on line 1393
Return

mixed Boolean false on failure, otherwise an array or parameters

Access

public

persistParams

top

Apply persistent parameters to a url array. Persistant parameters are a special key used during route creation to force route parameters to persist when omitted from a url array.

Parameters:
  • array $url required

    The array to apply persistent parameters to.

  • array $params required

    An array of persistent values to replace persistent ones.

Method defined in:
cake/libs/router.php on line 1450
Return

array An array with persistent parameters applied.

Access

public

_writeRoute

top

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.

Method defined in:
cake/libs/router.php on line 1345
Return

void

Access

protected

_writeUrl

top

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

Parameters:
  • array $params required

    The params to convert to a string url.

Method defined in:
cake/libs/router.php on line 1549
Return

string Composed route string.

Access

protected