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.

Redirection is signalled by an exception that halts route matching and defines the redirect URL and status code.

Namespace: Cake\Routing\Route

Property Summary

$_compiledRoute protected

string

The compiled route regular expression
$_extensions protected

array

List of connected extensions for this route.
$_greedy protected

string

Is this route a greedy route? Greedy routes have a /* in their template
$_name protected

string

The name for a route. Fetch with Route::getName();
$defaults public

array

Default parameters for a Route
$keys public

array

An array of named segments in a Route. /:controller/:action/:id has 3 key elements
$options public

array

An array of additional parameters for the Route.
$redirect public

array|string

The location to redirect to. Either a string or a CakePHP array URL.
$response public deprecated

Cake\Network\Response

A Response object
$template public

string

The routes template string.

Method Summary

__construct() public

Constructor
__set_state() public static

Set state magic method to support var_export
_matchMethod() protected

Check whether or not the URL's HTTP method matches.
_parseArgs() protected

Parse passed parameters into a list of passed args.
_parseExtension() protected

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.
_persistParams() protected

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

Builds a route regular expression.
_writeUrl() protected

Converts a matching route array into a URL string.
compile() public

Compiles the route's regular expression.
compiled() public

Check if a Route has been compiled into a regular expression.
extensions() public deprecated

Get/Set the supported extensions for this route.
getExtensions() public

Get the supported extensions for this route.
getName() public

Get the standardized plugin.controller:action name for a route.
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.
setExtensions() public

Set the supported extensions for this route.
staticPath() public

Get the static path portion for this route.

Method Detail

__construct() ¶ public

__construct(string $template, array|string $defaults = [], array $options = [])

Constructor

Options

_ext - Defines the extensions used for this route.
pass - Copies the listed parameters into params['pass'].

Parameters

string $template: Template string with parameter placeholders
array|string $defaults optional: Defaults for the route.
array $options optional: Array of additional options for the Route

__set_state() ¶ public static

__set_state(array $fields): Cake\Routing\Route\Route

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

Cake\Routing\Route\Route

A new instance of the route

_matchMethod() ¶ protected

_matchMethod(array $url): bool

Check whether or not the URL's HTTP method matches.

Parameters

array $url: The array for the URL being generated.

Returns

bool

_parseArgs() ¶ protected

_parseArgs(string $args, string $context): array

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.

Parameters

string $args: A string with the passed params. eg. /1/foo
string $context: The current route context, which should contain controller/action keys.

Returns

array

Array of passed args.

_parseExtension() ¶ protected

_parseExtension(string $url): array

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.

Parameters

string $url: The url to parse.

Returns

array

containing url, extension

_persistParams() ¶ protected

_persistParams(array $url, array $params): array

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.

_writeRoute() ¶ protected

_writeRoute(): void

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.

Returns

void

_writeUrl() ¶ protected

_writeUrl(array $params, array $pass = [], array $query = []): string

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
array $pass optional: The additional passed arguments
array $query optional: An array of parameters

Returns

string

Composed route string.

compile() ¶ public

compile(): array

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(): bool

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

Returns

bool

extensions() ¶ public

extensions(null|string|array $extensions = null): array|null

Get/Set the supported extensions for this route.

Parameters

null|string|array $extensions optional: The extensions to set. Use null to get.

Returns

array|null

The extensions or null.

getExtensions() ¶ public

getExtensions(): array

Get the supported extensions for this route.

Returns

array

getName() ¶ public

getName(): string

Get the standardized plugin.controller:action name for a route.

Returns

string

match() ¶ public

match(array $url, array $context = []): bool

There is no reverse routing redirection routes.

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: Array of parameters to convert to a string.
array $context optional: Array of request context parameters.

Returns

bool

Always false.

parse() ¶ public

parse(string $url, string $method = ''): false|null

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

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 parse.
string $method optional: The HTTP method being used.

Returns

false|null

False on failure. An exception is raised on a successful match.

Throws

Cake\Routing\Exception\RedirectException
An exception is raised on successful match. This is used to halt route matching and signal to the middleware that a redirect should happen.

setExtensions() ¶ public

setExtensions(array $extensions): $this

Set the supported extensions for this route.

Parameters

array $extensions: The extensions to set.

Returns

$this

staticPath() ¶ public

staticPath(): string

Get the static path portion for this route.

Returns

string

string

Namespaces

Class RedirectRoute

Property Summary

Method Summary

__construct() public

__set_state() public static

_matchMethod() protected

_parseArgs() protected

_parseExtension() protected

_persistParams() protected

_writeRoute() protected

_writeUrl() protected

compile() public

compiled() public

extensions() public deprecated

getExtensions() public

getName() public

match() public

parse() public

setExtensions() public

staticPath() public

Method Detail

__construct() ¶ public

Options

Parameters

__set_state() ¶ public static

Parameters

Returns

_matchMethod() ¶ protected

Parameters

Returns

_parseArgs() ¶ protected

Parameters

Returns

_parseExtension() ¶ protected

Parameters

Returns

_persistParams() ¶ protected

Parameters

Returns

_writeRoute() ¶ protected

Returns

_writeUrl() ¶ protected

Parameters

Returns

compile() ¶ public

Returns

compiled() ¶ public

Returns

extensions() ¶ public

Parameters

Returns

getExtensions() ¶ public

Returns

getName() ¶ public

Returns

match() ¶ public

Parameters

Returns

parse() ¶ public

Parameters

Returns

Throws

setExtensions() ¶ public

Parameters

Returns

staticPath() ¶ public

Returns

Property Detail

$_compiledRoute ¶ protected

Type

$_extensions ¶ protected

Type

$_greedy ¶ protected

Type

$_name ¶ protected

Type

$defaults ¶ public

Type

$keys ¶ public

`$_compiledRoute` ¶ protected

`$_extensions` ¶ protected

`$_greedy` ¶ protected

`$_name` ¶ protected

`$defaults` ¶ public

`$keys` ¶ public

`$options` ¶ public

`$redirect` ¶ public

`$response` ¶ public deprecated

`$template` ¶ public