Omeka_Controller_Router_Api¶
Package: Controller\Router
- class Omeka_Controller_Router_Api¶
extends Zend_Controller_Router_Route_Abstract
Router for the Omeka API.
- constant Omeka_Controller_Router_Api::DEFAULT_MODULE¶
The default controller name.
- constant Omeka_Controller_Router_Api::DEFAULT_CONTROLLER¶
The default controller name.
- property Omeka_Controller_Router_Api::$_legalActions¶
protected All
- property Omeka_Controller_Router_Api::$_legalParams¶
protected GET
- property Omeka_Controller_Router_Api::$_legalIndexParams¶
protected GET
- Omeka_Controller_Router_Api::getInstance(Zend_Config $config)¶
Parameters:
- $config (Zend_Config) –
- Omeka_Controller_Router_Api::match($request)¶
Match the user submitted path.
Via Omeka_Application_Resource_Router, this is the only available route for API requests.
Parameters:
- $request (Zend_Controller_Request_Http) –
Returns: array|false
- Omeka_Controller_Router_Api::assemble($data = array(), $reset = false, $encode = false)¶
Parameters:
- $data –
- $reset –
- $encode –
- Omeka_Controller_Router_Api::_getResource($resource, $apiResources)¶
Return this route’s resource.
Parameters:
- $resource (string) –
- $apiResources (array) –
Returns: string
- Omeka_Controller_Router_Api::_getRecordType($resource, $apiResources)¶
Return this route’s record type.
Parameters:
- $resource (string) –
- $apiResources (array) –
Returns: string|null
- Omeka_Controller_Router_Api::_getModule($resource, $apiResources)¶
Return this route’s module.
Parameters:
- $resource (string) –
- $apiResources (array) –
Returns: string
- Omeka_Controller_Router_Api::_getController($resource, $apiResources)¶
Return this route’s controller.
Parameters:
- $resource (string) –
- $apiResources (array) –
Returns: string
- Omeka_Controller_Router_Api::_getAction($method, $params, $resource, $apiResources)¶
Return this route’s action.
Parameters:
- $method (string) –
- $params (array) –
- $resource (string) –
- $apiResources (array) –
Returns: string
- Omeka_Controller_Router_Api::_validateParams($action, $resource, $apiResources)¶
Validate the GET parameters against the whitelist.
Parameters:
- $action (string) –
- $resource (string) –
- $apiResources (array) –