Class GenericResult
GenericResult Result superclass.
Methods summary
protected
|
#
setStatusCode( integer $status, string $message = "" )
Set a status code and optional message.
Set a status code and optional message.
Parameters
- $status
integer $status The status code.
- $message
string $message The message.
|
protected
|
#
setResult( mixed $result )
Set the result.
Parameters
- $result
mixed $result The result
|
protected
string
|
#
getStatusCode( )
Return the current status code
Return the current status code
Returns
string
|
protected
string
|
#
getStatusMessage( )
Return the current status message
Return the current status message
Returns
string
|
protected
string
|
#
getResult( )
Return the current result
Return the current result
Returns
string
|
public
stdClass
|
#
export( )
Serialise to a standard class.
Serialise to a standard class.
DEVNOTE: The API is only interested in data, we can not easily serialise
custom classes without the need for 1) the other side being PHP, 2) you need to
have the class definition installed, 3) its the right version!
Therefore, I'm not bothering.
Override this to include any more specific information, however api results
should be attached to the class using setResult().
if $CONFIG->debug is set then additional information about the runtime
environment and authentication will be returned.
Returns
stdClass
Object containing the serialised result.
|