\rex_api_result

Class representing the result of a api function call.

Summary

Methods
Properties
Constants
__construct()
setRequiresReboot()
requiresReboot()
getFormattedMessage()
getMessage()
isSuccessfull()
toJSON()
fromJSON()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(mixed  $succeeded, mixed  $message = null) : mixed

Parameters

mixed $succeeded
mixed $message

Returns

mixed —

setRequiresReboot()

setRequiresReboot(mixed  $requiresReboot) : mixed

Parameters

mixed $requiresReboot

Returns

mixed —

requiresReboot()

requiresReboot() : bool

Returns

bool —

getFormattedMessage()

getFormattedMessage() : null|string

Returns

null|string —

getMessage()

getMessage() : string

Returns end-user friendly statusmessage.

Returns

string —

a statusmessage

isSuccessfull()

isSuccessfull() : bool

Returns whether the api function was executed successfully.

Returns

bool —

true on success, false on error

toJSON()

toJSON() : false|string

Returns

false|string —

fromJSON()

fromJSON(mixed  $json) : self

Parameters

mixed $json

Returns

self —