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
Extended by RedirectRoute
Package: Cake\Routing\Route
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Routing/Route/RedirectRoute.php

Properties summary

  • $redirect public
    mixed
    The location to redirect to. Either a string or a CakePHP array URL.
  • $response public
    CakeResponse
    A CakeResponse object
  • $stop public
    boolean
    Flag for disabling exit() when this route parses a URL.

Inherited Properties

Method Summary

  • __construct() public
    Constructor
  • _stop() protected

    Stop execution of the current script. Wraps exit() making testing easier.

  • match() public
    There is no reverse routing redirection routes
  • parse() public

    Parses a string URL into an array. Parsed URLs will result in an automatic redirection

Method Detail

__construct()source 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()

_stop()source 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

match()source 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()

parse()source 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_state()source 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

_matchNamed()source 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

_parseArgs()source 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)

_writeRoute()source 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.

_writeUrl()source 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.

compile()source 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()source public 

compiled( )

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

Returns

boolean

persistParams()source 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 detail

$redirectsource

public mixed

The location to redirect to. Either a string or a CakePHP array URL.

$responsesource

public CakeResponse

A CakeResponse object

null

$stopsource

public boolean

Flag for disabling exit() when this route parses a URL.

true

© 2005–2017 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.
https://api.cakephp.org/2.10/class-RedirectRoute.html