Documentation

rex_api_result
in package

Class representing the result of a api function call.

Tags
author

staabm

see
rex_api_function

Table of Contents

Methods

__construct()  : mixed
fromJSON()  : self
getFormattedMessage()  : string|null
getMessage()  : string|null
Returns end-user friendly statusmessage.
isSuccessfull()  : bool
Returns whether the api function was executed successfully.
requiresReboot()  : bool
setRequiresReboot()  : void
toJSON()  : false|string

Methods

__construct()

public __construct(bool $succeeded[, string|null $message = null ]) : mixed
Parameters
$succeeded : bool
$message : string|null = null

fromJSON()

public static fromJSON(string $json) : self
Parameters
$json : string
Return values
self

getFormattedMessage()

public getFormattedMessage() : string|null
Return values
string|null

getMessage()

Returns end-user friendly statusmessage.

public getMessage() : string|null
Return values
string|null

a statusmessage

isSuccessfull()

Returns whether the api function was executed successfully.

public isSuccessfull() : bool
Return values
bool

true on success, false on error

requiresReboot()

public requiresReboot() : bool
Return values
bool

setRequiresReboot()

public setRequiresReboot(bool $requiresReboot) : void
Parameters
$requiresReboot : bool

toJSON()

public toJSON() : false|string
Return values
false|string

        
On this page

Search results