Class PluginShortRoute

Plugin short route, that copies the plugin param to the controller parameters It is used for supporting /:plugin routes.

CakeRoute

PluginShortRoute

Package: cake\cake\libs
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: router.php

Inherited Properties

__headerMap, _compiledRoute, _greedy, defaults, keys, options, template

Method Summary

match() public

Reverse route plugin shortcut urls. If the plugin and controller are not the same the match is an auto fail.
parse() public

Parses a string url into an array. If a plugin key is found, it will be copied to the controller parameter

Method Detail

match() public ¶

match( array $url )

Reverse route plugin shortcut urls. If the plugin and controller are not the same the match is an auto fail.

Parameters

array $url: Array of parameters to convert to a string.

Returns

mixed
either false or a string url.

Overrides

CakeRoute::match()

parse() public ¶

parse( string $url )

Parses a string url into an array. If a plugin key is found, it will be copied to the controller parameter

Parameters

string $url: The url to parse

Returns

mixed
false on failure, or an array of request parameters

Overrides

CakeRoute::parse()

Methods inherited from CakeRoute

CakeRoute() public ¶

CakeRoute( string $template , array $defaults = array() , string $options = array() )

Constructor for a Route

Parameters

string $template: Template string with parameter placeholders
array $defaults optional array(): Array of defaults for the route.
string $options optional array(): $params Array of parameters and additional options for the Route

_writeRoute() public ¶

_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() public ¶

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

compile() 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.

compiled() public ¶

compiled( )

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

Returns

boolean

persistParams() public ¶

persistParams( array $url , array $params )

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

C CakePHP 1.3 API

Version:

Classes

Functions

Class PluginShortRoute

Inherited Properties

Method Summary

match() public

parse() public

Method Detail

match() public ¶

Parameters

Returns

Overrides

parse() public ¶

Parameters

Returns

Overrides

Methods inherited from CakeRoute

CakeRoute() public ¶

Parameters

_writeRoute() public ¶

_writeUrl() public ¶

Parameters

Returns

compile() public ¶

Returns

compiled() public ¶

Returns

persistParams() public ¶

Parameters

Returns