API Class Reference
Public Member Functions | |
| processRequest ($params=null) | |
| addPOST ($name, $required, $description, $example) | |
| addGET ($name, $required, $description, $example) | |
| POST ($key) | |
| GET ($key) | |
| addError ($error) | |
| addMessage ($message) | |
| addData ($key, $value) | |
| checkRequiredParams () | |
| getHelp () | |
| processParams ($params) | |
| isLoginRequired () | |
| doAction () | |
Public Attributes | |
| $errors = array() | |
| $posts = array() | |
| $gets = array() | |
| $messages = array() | |
| $data = array() | |
Member Function Documentation
| API::doAction | ( | ) | [abstract] |
Runs the API action
Reimplemented in MaterialAPI, and RESTAPI.
| API::GET | ( | $ | key | ) |
- Parameters:
-
string $key The key of the GET parameter
- Returns:
- string Returns the value of the GET parameter
| API::isLoginRequired | ( | ) | [abstract] |
- Returns:
- boolean Returns whether or not a login is required to execute this action
Reimplemented in AddHQPMovedOnAPI, AddHQPThesisAPI, AddMaterialAPI, AddThemeLeaderAPI, CreateProjectAPI, CreateUserAPI, DeleteProjectAPI, EvolveProjectAPI, ImportBibTeXAPI, ImportDOIAPI, ImportMetricsAPI, ImportORCIDAPI, MaterialAPI, ProjectDescriptionAPI, ProjectMilestoneAPI, RequestUserAPI, RESTAPI, UploadCCVAPI, UploadICSAPI, UserEmailAPI, and UserPhoneAPI.
| API::POST | ( | $ | key | ) |
- Parameters:
-
string $key The key of the POST parameter
- Returns:
- string Returns the value of the POST parameter
| API::processParams | ( | $ | params | ) | [abstract] |
Does some pre-proccessing to the parameters
- Parameters:
-
array $params The array of GET parameters
Reimplemented in AddHQPMovedOnAPI, AddHQPThesisAPI, AddMaterialAPI, AddThemeLeaderAPI, CreateProjectAPI, CreateUserAPI, DeleteProjectAPI, EvolveProjectAPI, ImportBibTeXAPI, ImportDOIAPI, ImportMetricsAPI, ImportORCIDAPI, MaterialAPI, ProjectDescriptionAPI, ProjectMilestoneAPI, RequestUserAPI, RESTAPI, UploadCCVAPI, UploadICSAPI, UserEmailAPI, and UserPhoneAPI.
The documentation for this class was generated from the following file:
- extensions/API/API.body.php
