Zend_Rest_Route Class Reference

Public Member Functions
	__construct (Zend_Controller_Front $front, array $defaults=array(), array $responders=array())
	match ($request, $partial=false)
	assemble ($data=array(), $reset=false, $encode=true)
	getVersion ()
Static Public Member Functions
static	getInstance (Zend_Config $config)
Protected Member Functions
	_parseResponders ($responders)
	_checkRestfulModule ($moduleName)
	_checkRestfulController ($moduleName, $controllerName)
	_allRestful ()
	_fullRestfulModule ($moduleName)
Protected Attributes
	$_restfulModules = null
	$_restfulControllers = null
	$_front

---

Detailed Description

Definition at line 52 of file Route.php.

---

Constructor & Destructor Documentation

__construct	(	Zend_Controller_Front $	front,
		array $	defaults = array(),
		array $	responders = array()
	)

Constructor

Parameters:

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

Definition at line 78 of file Route.php.

Here is the call graph for this function:

---

Member Function Documentation

_allRestful

(

)

[protected]

Determines if RESTful routing applies to the entire app

Returns:

bool

Definition at line 383 of file Route.php.

Here is the caller graph for this function:

_checkRestfulController	(	$	moduleName,
		$	controllerName
	)		[protected]

Determine if a specified module + controller combination supports RESTful routing

Parameters:

string	$moduleName
string	$controllerName

Returns:

bool

Definition at line 361 of file Route.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_checkRestfulModule

(

$

moduleName

)

[protected]

Determine if a specified module supports RESTful routing

Parameters:

string

$moduleName

Returns:

bool

Definition at line 339 of file Route.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_fullRestfulModule

(

$

moduleName

)

[protected]

Determines if RESTful routing applies to an entire module

Parameters:

string

$moduleName

Returns:

bool

Definition at line 394 of file Route.php.

Here is the caller graph for this function:

_parseResponders

(

$

responders

)

[protected]

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

Parameters:

array

$responders

Definition at line 317 of file Route.php.

Here is the caller graph for this function:

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

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

Parameters:

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

Returns:

string Route path with user submitted parameters

Definition at line 244 of file Route.php.

static getInstance

(

Zend_Config $

config

)

[static]

Instantiates route based on passed Zend_Config structure

Definition at line 95 of file Route.php.

getVersion

(

)

Tells Rewrite Router which version this Route is

Returns:

int Route "version"

Definition at line 306 of file Route.php.

match	(	$	request,
		$	partial = false
	)

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:

Zend_Controller_Request_Http

$request

Request used to match against this routing ruleset

Returns:

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

Definition at line 124 of file Route.php.

Here is the call graph for this function:

---

Field Documentation

$_front [protected]

Definition at line 69 of file Route.php.

$_restfulControllers = null [protected]

Definition at line 64 of file Route.php.

$_restfulModules = null [protected]

Definition at line 58 of file Route.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/Rest/Route.php