FilesController¶
Package: Controller
- class FilesController¶
extends ApiController
The controller for API /files.
- constant FilesController::FILE_NAME¶
Name for file on a multipart/form-data request.
- constant FilesController::DATA_NAME¶
Name for JSON data on a multipart/form-data request.
- FilesController::postAction()¶
Handle POST requests.
- FilesController::init()¶
Initialize this controller.
- FilesController::indexAction()¶
Handle GET request without ID.
- FilesController::getAction()¶
Handle GET request with ID.
- FilesController::putAction()¶
Handle PUT requests.
- FilesController::deleteAction()¶
Handle DELETE requests.
- FilesController::_validateRecordType($recordType)¶
Validate a record type.
Parameters:
- $recordType (string) –
- FilesController::_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) –
- FilesController::_getRecordAdapter($recordType)¶
Get the adapter for a record type.
Parameters:
- $recordType (string) –
Returns: Omeka_Record_Api_AbstractRecordAdapter
- FilesController::_setLinkHeader($perPage, $page, $totalResults, $resource)¶
Set the Link header for pagination.
Parameters:
- $perPage (int) –
- $page (int) –
- $totalResults (int) –
- $resource (string) –
- FilesController::_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) –