RestManager extends IRestService implements IErrorable
FinalYes
Table of Contents
Interfaces
Methods
- __construct() : mixed
- Constructor of RestManager.
- className() : string
- getErrorByCode() : array<string|int, Error>
- Getting once error with the necessary code.
- getErrors() : array<string|int, Error>
- Getting array of errors.
- getErrorsByCode() : array<string|int, Error>
- Getting array of errors with the necessary code.
- getNavData() : array<string|int, mixed>
- Gets offset and limit by start parameter.
- onRestAppDelete() : void
- Deletes application storage.
- onRestGetModule() : mixed
- onRestServiceBuildDescription() : array<string|int, mixed>
- Builds list of REST methods which provides module disk.
- processMethodRequest() : array<string|int, mixed>
- Processes method to services.
- setNavData() : mixed
Methods
__construct()
Constructor of RestManager.
public
__construct() : mixed
className()
public
static className() : string
Return values
string —the fully qualified name of this class.
getErrorByCode()
Getting once error with the necessary code.
public
getErrorByCode(string $code) : array<string|int, Error>
Parameters
- $code : string
-
Code of error.
Return values
array<string|int, Error>getErrors()
Getting array of errors.
public
getErrors() : array<string|int, Error>
Return values
array<string|int, Error>getErrorsByCode()
Getting array of errors with the necessary code.
public
getErrorsByCode(string $code) : array<string|int, Error>
Parameters
- $code : string
-
Code of error.
Return values
array<string|int, Error>getNavData()
Gets offset and limit by start parameter.
public
static getNavData(string $start[, bool $isOrm = false ]) : array<string|int, mixed>
Parameters
- $start : string
-
Start position.
- $isOrm : bool = false
-
Use ORM format.
Return values
array<string|int, mixed>onRestAppDelete()
Deletes application storage.
public
static onRestAppDelete(array<string|int, mixed> $fields) : void
Parameters
- $fields : array<string|int, mixed>
-
Fields describes application.
onRestGetModule()
public
static onRestGetModule() : mixed
onRestServiceBuildDescription()
Builds list of REST methods which provides module disk.
public
static onRestServiceBuildDescription() : array<string|int, mixed>
Return values
array<string|int, mixed>processMethodRequest()
Processes method to services.
public
processMethodRequest(array<string|int, mixed> $params, string $start, CRestServer $restServer) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters ($_GET, $_POST).
- $start : string
-
Start position.
- $restServer : CRestServer
-
REST server.
Tags
Return values
array<string|int, mixed>setNavData()
public
static setNavData(mixed $result, mixed $dbRes) : mixed
Parameters
- $result : mixed
- $dbRes : mixed