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.1 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.1
      • 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
    • Network
      • Email
      • Http
    • Routing
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • CakeRoute
  • PluginShortRoute
  • RedirectRoute

Class PluginShortRoute

Plugin short route, that copies the plugin param to the controller parameters It is used for supporting /:plugin routes.

CakeRoute
Extended by PluginShortRoute
Package: Cake\Routing\Route
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Routing/Route/PluginShortRoute.php

Inherited Properties

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

Method Summary

  • match() public

    Reverse route plugin shortcut urls. If the plugin and controller are not the same the match is an auto fail.

  • parse() public

    Parses a string url into an array. If a plugin key is found, it will be copied to the controller parameter

Method Detail

match() public ¶

match( array $url )

Reverse route plugin shortcut urls. If the plugin and controller are not the same the match is an auto fail.

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. If a plugin key is found, it will be copied to the controller parameter

Parameters
string $url
The url to parse
Returns
mixed
false on failure, or an array of request parameters
Overrides
CakeRoute::parse()

Methods inherited from CakeRoute

__construct() public ¶

__construct( string $template , array $defaults = array() , array $options = array() )

Constructor for a Route

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

_matchNamed() protected ¶

_matchNamed( string $val , array $rule , string $context )

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.
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