Class Zend_Rest_Route

Description

Rest Route

Request-aware route for RESTful modular routing

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Rest/Route.php (line 52)

Zend_Controller_Router_Route_Abstract
   |
   --Zend_Controller_Router_Route_Module
      |
      --Zend_Rest_Route
Variable Summary
Method Summary
 static void getInstance ( $config)
 Zend_Rest_Route __construct ( $front, [ $defaults = array()], [ $responders = array()])
 string assemble ([array $data = array()], [bool $reset = false], [bool $encode = true])
 int getVersion ()
 array match (Zend_Controller_Request_Http $request, [ $partial = false])
 bool _allRestful ()
 bool _checkRestfulController (string $moduleName, string $controllerName)
 bool _checkRestfulModule (string $moduleName)
 bool _fullRestfulModule (string $moduleName)
 void _parseResponders (array $responders)
Variables
Methods
static getInstance (line 95)

Instantiates route based on passed Zend_Config structure

  • access: public
static void getInstance ( $config)

Redefinition of:
Zend_Controller_Router_Route_Module::getInstance()
Instantiates route based on passed Zend_Config structure
Constructor __construct (line 78)

Constructor

  • access: public
Zend_Rest_Route __construct ( $front, [ $defaults = array()], [ $responders = array()])
  • 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

Redefinition of:
Zend_Controller_Router_Route_Module::__construct()
Constructor
assemble (line 244)

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

  • return: Route path with user submitted parameters
  • access: public
string assemble ([array $data = array()], [bool $reset = false], [bool $encode = true])
  • 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

Redefinition of:
Zend_Controller_Router_Route_Module::assemble()
Assembles user submitted parameters forming a URL path defined by this route
getVersion (line 306)

Tells Rewrite Router which version this Route is

  • return: Route "version"
  • access: public
int getVersion ()

Redefinition of:
Zend_Controller_Router_Route_Module::getVersion()
match (line 124)

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.

  • return: An array of assigned values or a false on a mismatch
  • access: public
array match (Zend_Controller_Request_Http $request, [ $partial = false])

Redefinition of:
Zend_Controller_Router_Route_Module::match()
Matches a user submitted path. Assigns and returns an array of variables on a successful match.
_allRestful (line 383)

Determines if RESTful routing applies to the entire app

  • access: protected
bool _allRestful ()
_checkRestfulController (line 361)

Determine if a specified module + controller combination supports RESTful routing

  • access: protected
bool _checkRestfulController (string $moduleName, string $controllerName)
  • string $moduleName
  • string $controllerName
_checkRestfulModule (line 339)

Determine if a specified module supports RESTful routing

  • access: protected
bool _checkRestfulModule (string $moduleName)
  • string $moduleName
_fullRestfulModule (line 394)

Determines if RESTful routing applies to an entire module

  • access: protected
bool _fullRestfulModule (string $moduleName)
  • string $moduleName
_parseResponders (line 317)

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

  • access: protected
void _parseResponders (array $responders)
  • array $responders

Inherited Methods

Inherited From Zend_Controller_Router_Route_Module

 Zend_Controller_Router_Route_Module::__construct()
 Zend_Controller_Router_Route_Module::assemble()
 Zend_Controller_Router_Route_Module::getDefault()
 Zend_Controller_Router_Route_Module::getDefaults()
 Zend_Controller_Router_Route_Module::getInstance()
 Zend_Controller_Router_Route_Module::getVersion()
 Zend_Controller_Router_Route_Module::match()
 Zend_Controller_Router_Route_Module::_setRequestKeys()

Inherited From Zend_Controller_Router_Route_Abstract

 Zend_Controller_Router_Route_Abstract::chain()
 Zend_Controller_Router_Route_Abstract::getMatchedPath()
 Zend_Controller_Router_Route_Abstract::getVersion()
 Zend_Controller_Router_Route_Abstract::isAbstract()
 Zend_Controller_Router_Route_Abstract::setMatchedPath()
Class Constants

Documentation generated on Mon, 21 Jun 2010 15:42:51 -0400 by phpDocumentor 1.4.3