Inheritance diagram for PsfApiBase:
Public Member Functions | |
| RegisterAPI_Action ($api, $name=NULL) | |
| RegisterAPI_GET ($api) | |
| RegisterAPI_PUT ($api) | |
| RegisterAPI_POST ($api) | |
| RegisterAPI_DELETE ($api) | |
| ProcessAction () | |
| ProcessGET () | |
| ProcessPOST () | |
| ProcessDELETE () | |
| ProcessPUT () | |
| Process () | |
| ThrowError ($error, $message=NULL, $code=-1) | |
| PrintHelpAsHtml () | |
 Public Member Functions inherited from PsfObject | |
| __construct ($_parent=NULL) | |
| SetParent ($_parent) | |
| GetParent ($_parent) | |
| AddChild ($_child) | |
Public Attributes | |
| $ApiList_GET = [] | |
| $ApiList_POST = [] | |
| $ApiList_DELETE = [] | |
| $ApiList_PUT = [] | |
| $ApiList_Action = [] | |
| $ShowHelpOnNoAction = true | |
| $ApiBaseName = "API" | |
| $ApiBaseIntro = "Welcome to web API. These APIs can be used to perform various actions on the website." | |
| $TreatDocsAsHTML = false | |
| $ExamplePrefix = "" | |
| Used typically to put URL or part of it, for example api.php, this string is prefixed to every example string. | |
| $AuthenticationBackend = NULL | |
| This must be an instance of PsfAuth object, see derivatives of PsfAuthBase for more details. | |
Additional Inherited Members | |
| Protected Attributes inherited from PsfObject | |
| $Parent = NULL | |
Detailed Description
Definition at line 107 of file apibase.php.
The documentation for this class was generated from the following file:
- psf/includes/api/apibase.php
