This class represents a single API PSF supports quite flexible API framework which can be used to create simple action based or REST based API for your service In order to create API entry point just create an object PsfApiBase and execute Process function on it. More...
Public Member Functions | |
| __construct ($_name, $_callback=NULL, $short_description=NULL, $long_description=NULL, $params_req=NULL, $params_opt=NULL) | |
| Process () | |
| GetParameterCount () | |
 Public Member Functions inherited from PsfObject | |
| __construct ($_parent=NULL) | |
| SetParent ($_parent) | |
| GetParent ($_parent) | |
| AddChild ($_child) | |
Public Attributes | |
| $Name = NULL | |
| $ParametersRequired = [] | |
| $ParametersOptional = [] | |
| $ShortDescription = NULL | |
| $LongDescription = NULL | |
| $Example = NULL | |
| $Callback = NULL | |
| $RequiresAuthentication = false | |
| $POSTOnly = false | |
| This is a security measure for action API's only. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from PsfObject | |
| $Parent = NULL | |
Detailed Description
This class represents a single API PSF supports quite flexible API framework which can be used to create simple action based or REST based API for your service In order to create API entry point just create an object PsfApiBase and execute Process function on it.
Definition at line 66 of file apibase.php.
Member Data Documentation
◆ $POSTOnly
| PsfApi::$POSTOnly = false |
This is a security measure for action API's only.
If this API is registered as action API, it will be only working when submitted via POST method. This is to prevent users from exposing their passwords in URL.
Definition at line 78 of file apibase.php.
The documentation for this class was generated from the following file:
- psf/includes/api/apibase.php
