RedirectRoute (class)
Class RedirectRoute
Redirect route will perform an immediate redirect. Redirect routes are useful when you want to have Routing layer redirects occur in your application, for when URLs move.
- CakeRoute
- RedirectRoute
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/Routing/Route/RedirectRoute.php
Method Detail
__constructsource public
__construct( string $template , array $defaults array() , array $options array() )
Constructor
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
Overrides
CakeRoute::__construct()
_stopsource protected
_stop( integer|string $code 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- integer|string
$code
optional 0 - See http://php.net/exit for values
matchsource public
match( array $url )
There is no reverse routing redirection routes
Parameters
- array
$url
- Array of parameters to convert to a string.
Returns
mixed
either false or a string URL.
Overrides
CakeRoute::match()
parsesource public
parse( string $url )
Parses a string URL into an array. Parsed URLs will result in an automatic redirection
Parameters
- string
$url
- The URL to parse
Returns
boolean
False on failure
Overrides
CakeRoute::parse()
Methods inherited from CakeRoute
__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
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.
Properties summary
Properties inherited from CakeRoute
$_greedysource
protected string
Is this route a greedy route? Greedy routes have a /*
in their template
false
$_headerMapsource
protected array
HTTP header shortcut map. Used for evaluating header-based route expressions.
array( 'type' => 'content_type', 'method' => 'request_method', 'server' => 'server_name' )
$keyssource
public array
An array of named segments in a Route. /:controller/:action/:id
has 3 key elements
array()
© 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/2.7/class-RedirectRoute.html