CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.4 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.4
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • CakeRoute
  • PluginShortRoute
  • RedirectRoute

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. (http://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

  • _compiledRoute, _greedy, _headerMap, defaults, keys, options, template

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() 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() protected ¶

_stop( integer|string $code = 0 )

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

Parameters
integer|string $code optional 0
$status see http://php.net/exit for values

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

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

$redirect ¶

public mixed

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

$response ¶

public CakeResponse

A CakeResponse object

null

$stop ¶

public boolean

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

true
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs