Rest/Route.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Rest  
Version
$Id: Route.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Rest_Route

Package: Zend\Rest
Rest Route

Request-aware route for RESTful modular routing

Parent(s)
\Zend_Controller_Router_Route_Module < \Zend_Controller_Router_Route_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Properties

>VPropertyprotected$_actionKey = 'action'
Default value'action'Details
Type
n/a
Inherited_from
\Zend_Controller_Router_Route_Module::$$_actionKey  
>VPropertyprotected$_controllerKey = 'controller'
Default value'controller'Details
Type
n/a
Inherited_from
\Zend_Controller_Router_Route_Module::$$_controllerKey  
>VPropertyprotectedarray $_defaults
inherited
Default values for the route (ie.
Inherited from: \Zend_Controller_Router_Route_Module::$$_defaults

module, controller, action, params)

Details
Type
array
Inherited_from
\Zend_Controller_Router_Route_Module::$$_defaults  
>VPropertyprotected\Zend_Controller_Dispatcher_Interface $_dispatcher
>VPropertyprotected\Zend_Controller_Front $_front
>VPropertyprotectedboolean $_isAbstract = false
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Controller_Router_Route_Abstract::$$_isAbstract  
Inherited_from
\Zend_Controller_Router_Route_Module::$$_isAbstract  
>VPropertyprotected$_keysSet = false
Default valuefalseDetails
Type
n/a
Inherited_from
\Zend_Controller_Router_Route_Module::$$_keysSet  
>VPropertyprotectedstring $_matchedPath = null
>VPropertyprotected$_moduleKey = 'module'
Default value'module'Details
Type
n/a
Inherited_from
\Zend_Controller_Router_Route_Module::$$_moduleKey  
>VPropertyprotected$_moduleValid = false
Default valuefalseDetails
Type
n/a
Inherited_from
\Zend_Controller_Router_Route_Module::$$_moduleValid  
>VPropertyprotected\Zend_Controller_Request_Abstract $_request
>VPropertyprotectedarray $_restfulControllers = null
Specific Modules=>Controllers to receive RESTful routes
Default valuenullDetails
Type
array
>VPropertyprotectedarray $_restfulModules = null
Specific Modules to receive RESTful routes
Default valuenullDetails
Type
array
>VPropertyprotected$_values = array()
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Controller_Router_Route_Module::$$_values  

Methods

methodpublic__construct(\Zend_Controller_Front $front, array $defaults = array(), array $responders = array()) : void

Constructor

Parameters
NameTypeDescription
$front\Zend_Controller_Front

Front Controller object

$defaultsarray

Defaults for map variables with keys as variable names

$respondersarray

Modules or controllers to receive RESTful routes

methodprotected_allRestful() : bool

Determines if RESTful routing applies to the entire app

Returns
TypeDescription
bool
methodprotected_checkRestfulController(string $moduleName, string $controllerName) : bool

Determine if a specified module + controller combination supports RESTful routing

Parameters
NameTypeDescription
$moduleNamestring
$controllerNamestring
Returns
TypeDescription
bool
methodprotected_checkRestfulModule(string $moduleName) : bool

Determine if a specified module supports RESTful routing

Parameters
NameTypeDescription
$moduleNamestring
Returns
TypeDescription
bool
methodprotected_fullRestfulModule(string $moduleName) : bool

Determines if RESTful routing applies to an entire module

Parameters
NameTypeDescription
$moduleNamestring
Returns
TypeDescription
bool
methodprotected_parseResponders(array $responders) : void

Parses the responders array sent to constructor to know which modules and/or controllers are RESTful

Parameters
NameTypeDescription
$respondersarray
methodprotected_setRequestKeys() : void
inherited

Set request keys based on values in request object

Inherited from: \Zend_Controller_Router_Route_Module::_setRequestKeys()
methodpublicassemble(array $data = array(), bool $reset = false, bool $encode = true) : string

Assembles user submitted parameters forming a URL path defined by this route

Parameters
NameTypeDescription
$dataarray

An array of variable and value pairs used as parameters

$resetbool

Weither to reset the current params

$encodebool

Weither to return urlencoded string

Returns
TypeDescription
stringRoute path with user submitted parameters
methodpublicchain(\Zend_Controller_Router_Route_Abstract $route, string $separator = '/') : \Zend_Controller_Router_Route_Chain
Parameters
NameTypeDescription
$route\Zend_Controller_Router_Route_Abstract
$separatorstring
Returns
TypeDescription
\Zend_Controller_Router_Route_Chain
methodpublicgetDefault(string $name) : string
inherited

Return a single parameter of route's defaults

Inherited from: \Zend_Controller_Router_Route_Module::getDefault()
Parameters
NameTypeDescription
$namestring

Array key of the parameter

Returns
TypeDescription
stringPreviously set default
methodpublicgetDefaults() : array
inherited

Return an array of defaults

Inherited from: \Zend_Controller_Router_Route_Module::getDefaults()
Returns
TypeDescription
arrayRoute defaults
methodpublicgetInstance( $config) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
NameTypeDescription
$config
methodpublicgetMatchedPath() : string
Returns
TypeDescription
string
methodpublicgetVersion() : int

Tells Rewrite Router which version this Route is

Returns
TypeDescription
intRoute "version"
methodpublicisAbstract(boolean $flag = null) : boolean
inherited

Check or set wether this is an abstract route or not

Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()\Zend_Controller_Router_Route_Module::isAbstract()
Parameters
NameTypeDescription
$flagboolean
Returns
TypeDescription
boolean
methodpublicmatch(\Zend_Controller_Request_Http $request,  $partial = false) : array

Matches a user submitted request.

Assigns and returns an array of variables on a successful match.

If a request object is registered, it uses its setModuleName(), setControllerName(), and setActionName() accessors to set those values. Always returns the values as an array.

Parameters
NameTypeDescription
$request\Zend_Controller_Request_Http

Request used to match against this routing ruleset

$partial
Returns
TypeDescription
arrayAn array of assigned values or a false on a mismatch
methodpublicsetMatchedPath(string $path) : void
Parameters
NameTypeDescription
$pathstring
Documentation was generated by phpDocumentor 2.0.0a12.