[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Rest/ -> Route.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 401 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Rest_Route:: (10 methods):
  __construct()
  getInstance()
  match()
  assemble()
  getVersion()
  _parseResponders()
  _checkRestfulModule()
  _checkRestfulController()
  _allRestful()
  _fullRestfulModule()


Class: Zend_Rest_Route  - X-Ref

Rest Route

Request-aware route for RESTful modular routing

__construct(Zend_Controller_Front $front,array $defaults = array()   X-Ref
Constructor

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

getInstance(Zend_Config $config)   X-Ref
Instantiates route based on passed Zend_Config structure


match($request, $partial = false)   X-Ref
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.

param: Zend_Controller_Request_Http $request Request used to match against this routing ruleset
return: array An array of assigned values or a false on a mismatch

assemble($data = array()   X-Ref
Assembles user submitted parameters forming a URL path defined by this route

param: array $data An array of variable and value pairs used as parameters
param: bool $reset Weither to reset the current params
param: bool $encode Weither to return urlencoded string
return: string Route path with user submitted parameters

getVersion()   X-Ref
Tells Rewrite Router which version this Route is

return: int Route "version"

_parseResponders($responders)   X-Ref
Parses the responders array sent to constructor to know
which modules and/or controllers are RESTful

param: array $responders

_checkRestfulModule($moduleName)   X-Ref
Determine if a specified module supports RESTful routing

param: string $moduleName
return: bool

_checkRestfulController($moduleName, $controllerName)   X-Ref
Determine if a specified module + controller combination supports
RESTful routing

param: string $moduleName
param: string $controllerName
return: bool

_allRestful()   X-Ref
Determines if RESTful routing applies to the entire app

return: bool

_fullRestfulModule($moduleName)   X-Ref
Determines if RESTful routing applies to an entire module

param: string $moduleName
return: bool



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1