Rest/Route.php

Show:

inherited

Classes
- \Zend_Rest_Route

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
jump to top

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

 
                URI_DELIMITER
                = '/'

inherited

URI delimiter

Inherited from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER \Zend_Controller_Router_Route_Module::URI_DELIMITER

Inherited_from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER
Inherited_from: \Zend_Controller_Router_Route_Module::URI_DELIMITER

Properties

$_actionKey = 'action'

inheritedInherited from: \Zend_Controller_Router_Route_Module::$$_actionKey

Default value'action'Details

Type: n/a
Inherited_from: \Zend_Controller_Router_Route_Module::$$_actionKey

$_controllerKey = 'controller'

inheritedInherited from: \Zend_Controller_Router_Route_Module::$$_controllerKey

Default value'controller'Details

Type: n/a
Inherited_from: \Zend_Controller_Router_Route_Module::$$_controllerKey

array $_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

\Zend_Controller_Dispatcher_Interface $_dispatcher

inherited

Inherited from: \Zend_Controller_Router_Route_Module::$$_dispatcher

Details

Type: \Zend_Controller_Dispatcher_Interface
Inherited_from: \Zend_Controller_Router_Route_Module::$$_dispatcher

\Zend_Controller_Front $_front

Details

Type: \Zend_Controller_Front

boolean $_isAbstract = false

inherited

Wether this route is abstract or not

Inherited from: \Zend_Controller_Router_Route_Abstract::$$_isAbstract \Zend_Controller_Router_Route_Module::$$_isAbstract

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Controller_Router_Route_Abstract::$$_isAbstract
Inherited_from: \Zend_Controller_Router_Route_Module::$$_isAbstract

$_keysSet = false

inheritedInherited from: \Zend_Controller_Router_Route_Module::$$_keysSet

Default valuefalseDetails

Type: n/a
Inherited_from: \Zend_Controller_Router_Route_Module::$$_keysSet

string $_matchedPath = null

inherited

Path matched by this route

Inherited from: \Zend_Controller_Router_Route_Abstract::$$_matchedPath \Zend_Controller_Router_Route_Module::$$_matchedPath

Default valuenullDetails

Type: string
Inherited_from: \Zend_Controller_Router_Route_Abstract::$$_matchedPath
Inherited_from: \Zend_Controller_Router_Route_Module::$$_matchedPath

$_moduleKey = 'module'

inheritedInherited from: \Zend_Controller_Router_Route_Module::$$_moduleKey

Default value'module'Details

Type: n/a
Inherited_from: \Zend_Controller_Router_Route_Module::$$_moduleKey

$_moduleValid = false

inheritedInherited from: \Zend_Controller_Router_Route_Module::$$_moduleValid

Default valuefalseDetails

Type: n/a
Inherited_from: \Zend_Controller_Router_Route_Module::$$_moduleValid

\Zend_Controller_Request_Abstract $_request

inherited

Inherited from: \Zend_Controller_Router_Route_Module::$$_request

Details

Type: \Zend_Controller_Request_Abstract
Inherited_from: \Zend_Controller_Router_Route_Module::$$_request

array $_restfulControllers = null

Specific Modules=>Controllers to receive RESTful routes

Default valuenullDetails

Type: array

array $_restfulModules = null

Specific Modules to receive RESTful routes

Default valuenullDetails

Type: array

$_values = array()

inheritedInherited from: \Zend_Controller_Router_Route_Module::$$_values

Default valuearray()Details

Type: n/a
Inherited_from: \Zend_Controller_Router_Route_Module::$$_values

Methods

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

Constructor

Parameters

Name	Type	Description
$front	\Zend_Controller_Front	Front Controller object
$defaults	array	Defaults for map variables with keys as variable names
$responders	array	Modules or controllers to receive RESTful routes

_allRestful() : bool

Determines if RESTful routing applies to the entire app

Returns

Type	Description
bool

_checkRestfulController(string $moduleName, string $controllerName) : bool

Determine if a specified module + controller combination supports RESTful routing

Parameters

Name	Type	Description
$moduleName	string
$controllerName	string

Returns

Type	Description
bool

_checkRestfulModule(string $moduleName) : bool

Determine if a specified module supports RESTful routing

Parameters

Name	Type	Description
$moduleName	string

Returns

Type	Description
bool

_fullRestfulModule(string $moduleName) : bool

Determines if RESTful routing applies to an entire module

Parameters

Name	Type	Description
$moduleName	string

Returns

Type	Description
bool

_parseResponders(array $responders) : void

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

Parameters

Name	Type	Description
$responders	array

_setRequestKeys() : void

inherited

Set request keys based on values in request object

Inherited from: \Zend_Controller_Router_Route_Module::_setRequestKeys()

assemble(array $data = array(), bool $reset = false, bool $encode = true) : string

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

Parameters

Name	Type	Description
$data	array	An array of variable and value pairs used as parameters
$reset	bool	Weither to reset the current params
$encode	bool	Weither to return urlencoded string

Returns

Type	Description
string	Route path with user submitted parameters

chain(\Zend_Controller_Router_Route_Abstract $route, string $separator = '/') : \Zend_Controller_Router_Route_Chain

inherited

Create a new chain

Inherited from: \Zend_Controller_Router_Route_Abstract::chain()\Zend_Controller_Router_Route_Module::chain()

Parameters

Name	Type	Description
$route	\Zend_Controller_Router_Route_Abstract
$separator	string

Returns

Type	Description
\Zend_Controller_Router_Route_Chain

getDefault(string $name) : string

inherited

Return a single parameter of route's defaults

Inherited from: \Zend_Controller_Router_Route_Module::getDefault()

Parameters

Name	Type	Description
$name	string	Array key of the parameter

Returns

Type	Description
string	Previously set default

getDefaults() : array

inherited

Return an array of defaults

Inherited from: \Zend_Controller_Router_Route_Module::getDefaults()

Returns

Type	Description
array	Route defaults

getInstance( $config) : void

static

Instantiates route based on passed Zend_Config structure

Parameters

Name	Type	Description
$config

getMatchedPath() : string

inherited

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()\Zend_Controller_Router_Route_Module::getMatchedPath()

Returns

Type	Description
string

getVersion() : int

Tells Rewrite Router which version this Route is

Returns

Type	Description
int	Route "version"

isAbstract(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

Name	Type	Description
$flag	boolean

Returns

Type	Description
boolean

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

Name	Type	Description
$request	\Zend_Controller_Request_Http	Request used to match against this routing ruleset
$partial

Returns

Type	Description
array	An array of assigned values or a false on a mismatch

setMatchedPath(string $path) : void

inherited

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()\Zend_Controller_Router_Route_Module::setMatchedPath()

Parameters

Name	Type	Description
$path	string

Rest/Route.php

\Zend_Rest_Routejump to top

Constants

Properties

Methods

\Zend_Rest_Route
jump to top