ApiController¶
Package: Controller
- class ApiController¶
extends Omeka_Controller_AbstractActionController
The default controller for API resources.
- ApiController::init()¶
Initialize this controller.
- ApiController::indexAction()¶
Handle GET request without ID.
- ApiController::getAction()¶
Handle GET request with ID.
- ApiController::postAction()¶
Handle POST requests.
- ApiController::putAction()¶
Handle PUT requests.
- ApiController::deleteAction()¶
Handle DELETE requests.
- ApiController::_validateRecordType($recordType)¶
Validate a record type.
Parameters:
- $recordType (string) –
- ApiController::_validateUser(Omeka_Record_AbstractRecord $record, $privilege)¶
Validate a user against a privilege.
For GET requests, assume that records without an ACL resource do not require a permission check. Note that for POST, PUT, and DELETE, all records must define an ACL resource.
Parameters:
- $record (Omeka_Record_AbstractRecord) –
- $privilege (string) –
- ApiController::_getRecordAdapter($recordType)¶
Get the adapter for a record type.
Parameters:
- $recordType (string) –
Returns: Omeka_Record_Api_AbstractRecordAdapter
- ApiController::_setLinkHeader($perPage, $page, $totalResults, $resource)¶
Set the Link header for pagination.
Parameters:
- $perPage (int) –
- $page (int) –
- $totalResults (int) –
- $resource (string) –
- ApiController::_getRepresentation(Omeka_Record_Api_AbstractRecordAdapter $recordAdapter, Omeka_Record_AbstractRecord $record, $resource)¶
Get the representation of a record.
Parameters:
- $recordAdapter (Omeka_Record_Api_AbstractRecordAdapter) –
- $record (Omeka_Record_AbstractRecord) –
- $resource (string) –