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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Rest
Version: $Id$

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Controller_Front $_front

Details

Type: \Zend_Controller_Front

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

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

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

getInstance( $config) : void

static

Instantiates route based on passed Zend_Config structure

Parameters

Name	Type	Description
$config

getVersion() : int

Tells Rewrite Router which version this Route is

Returns

Type	Description
int	Route "version"

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

Rest/Route.php

\Zend_Rest_Routejump to top

Properties

Methods

\Zend_Rest_Route
jump to top