APIResponse
in package
Defines an API Response Object
Table of Contents
Properties
Methods
- __construct() : mixed
- Error() : mixed
- Creates an Error API Response
- Html() : string
- Returns the Message as Html
- If() : APIResponse
- Checks a condition, if true SuccessResponse else ErrorResponse
- Json() : mixed
- Serializes the Object to Json
- PlainText() : string
- Returns the Message as PlainText
- Success() : mixed
- Returns an Success API Response
- ToData() : string|false
- Outputs the API in the requested MIME Format
Properties
$code
public
mixed
$code
$data
public
mixed
$data
$message
public
mixed
$message
$success
public
mixed
$success
= \false
Methods
__construct()
public
__construct(bool $success, mixed $code, mixed $message, mixed $data) : mixed
Parameters
- $success : bool
- $code : mixed
- $message : mixed
- $data : mixed
Error()
Creates an Error API Response
public
static Error([mixed $code = 200 ][, mixed $message = null ][, mixed $val = null ]) : mixed
Parameters
- $code : mixed = 200
- $message : mixed = null
- $val : mixed = null
Html()
Returns the Message as Html
public
Html() : string
Return values
stringIf()
Checks a condition, if true SuccessResponse else ErrorResponse
public
static If(mixed $condition[, mixed $codeTrue = 200 ][, mixed $codeFalse = 400 ][, mixed $message = null ][, mixed $data = null ]) : APIResponse
Parameters
- $condition : mixed
-
Condition
- $codeTrue : mixed = 200
- $codeFalse : mixed = 400
- $message : mixed = null
-
API Message if necessary
- $data : mixed = null
-
API Response Data
Return values
APIResponseJson()
Serializes the Object to Json
public
Json() : mixed
PlainText()
Returns the Message as PlainText
public
PlainText() : string
Return values
stringSuccess()
Returns an Success API Response
public
static Success([mixed $code = 200 ][, mixed $message = null ][, mixed $val = null ]) : mixed
Parameters
- $code : mixed = 200
- $message : mixed = null
- $val : mixed = null
ToData()
Outputs the API in the requested MIME Format
public
ToData(mixed $mime) : string|false
Parameters
- $mime : mixed
-
Content Type