CakeRoute (class)

__constructsource public

__construct( string $template , array $defaults array() , array $options array() )

Constructor for a Route

Parameters

string $template

Template string with parameter placeholders

array $defaults optional array()

Array of defaults for the route.

array $options optional array()

Array of additional options for the Route

__set_statesource public static

__set_state( array $fields )

Set state magic method to support var_export

This method helps for applications that want to implement router caching.

Parameters

array $fields

Key/Value of object attributes

Returns

CakeRoute
A new instance of the route

_matchNamedsource protected

_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.

Parameters

string $val

The value of the named parameter

array $rule

The rule(s) to apply, can also be a match string

string $context

An array with additional context information (controller / action)

Returns

boolean
bool

_parseArgssource protected

_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.

Parameters

string $args

A string with the passed & named params. eg. /1/page:2

string $context

The current route context, which should contain controller/action keys.

Returns

array
Array of ($pass, $named)

_writeRoutesource protected

_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.

_writeUrlsource protected

_writeUrl( array $params )

Converts a matching route array into a URL string.

Composes the string URL using the template used to create the route.

Parameters

array $params

The params to convert to a string URL.

Returns

string
Composed route string.

compilesource public

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.

Returns

array
Returns a string regular expression of the compiled route.

compiledsource public

compiled( )

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

Returns

boolean
bool

matchsource public

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.

Parameters

array $url

An array of parameters to check matching with.

Returns

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

parsesource public

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.

Parameters

string $url

The URL to attempt to parse.

Returns

mixed
Boolean false on failure, otherwise an array or parameters

persistParamssource public

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.

Parameters

array $url

The array to apply persistent parameters to.

array $params

An array of persistent values to replace persistent ones.

Returns

array
An array with persistent parameters applied.

null

false

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

array()

array()

array()

null