Plugin short route, that copies the plugin param to the controller parameters It is used for supporting /:plugin routes.
match( array $url , array $context [] )
Reverses route plugin shortcut URLs. If the plugin and controller are not the same the match is an auto fail.
$url
$context
optional [] string|false
Cake\Routing\Route\InflectedRoute::match()
parse( string $url )
Parses a string URL into an array. If a plugin key is found, it will be copied to the controller parameter.
$url
array|false
Cake\Routing\Route\InflectedRoute::parse()
_underscore( array $url )
Helper method for underscoring keys in a URL array.
$url
array
__construct( string $template , array|string $defaults [] , array $options [] )
Constructor for a Route
_ext
- Defines the extensions used for this route.pass
- Copies the listed parameters into params['pass'].$template
$defaults
optional [] $options
optional [] __set_state( array $fields )
Set state magic method to support var_export
This method helps for applications that want to implement router caching.
$fields
Cake\Routing\Route\Route
_matchMethod( array $url )
Check whether or not the URL's HTTP method matches.
$url
boolean
_parseArgs( string $args , string $context )
Parse passed parameters into a list of passed args.
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.
$args
$context
array
_parseExtension( string $url )
Removes the extension from $url if it contains a registered extension. If no registered extension is found, no extension is returned and the URL is returned unmodified.
$url
array
_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
_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 , array $pass [] , array $query [] )
Converts a matching route array into a URL string.
Composes the string URL using the template used to create the route.
$params
$pass
optional [] $query
optional [] 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
extensions( null|string|array $extensions null )
Get/Set the supported extensions for this route.
$extensions
optional null array|null
getName( )
Get the standardized plugin.controller:action name for a route.
string
staticPath( )
Get the static path portion for this route.
string
protected boolean
Flag for tracking whether or not the defaults have been inflected.
Default values need to be inflected so that they match the inflections that match() will create.
false
protected string
Is this route a greedy route? Greedy routes have a /*
in their template
false
public array
An array of named segments in a Route. /:controller/:action/:id
has 3 key elements
[]
© 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/3.1/class-Cake.Routing.Route.PluginShortRoute.html