Result Class Reference

Public Member Functions
	getStatus ()
	getFunction ()
	getControlId ()
	getData ()
	getListType ()
	getCount ()
	getTotalCount ()
	getNumRemaining ()
	getResultId ()
	getKey ()
	setKey (string $key)
	getStart ()
	setStart (int $start)
	getEnd ()
	setEnd (int $end)
	getErrors ()
	__construct (\SimpleXMLElement $result)
	ensureStatusSuccess ()
	ensureStatusNotFailure ()

Constructor & Destructor Documentation

__construct()

__construct

(

\SimpleXMLElement

$result

)

Result constructor.

Parameters

\SimpleXMLElement

$result

Member Function Documentation

ensureStatusNotFailure()

ensureStatusNotFailure

(

)

Ensure the result status is not failure (result status will be success or aborted)

Exceptions

ResultException

ensureStatusSuccess()

ensureStatusSuccess

(

)

Ensure the result status is success

Exceptions

ResultException

getControlId()

getControlId

(

)

Returns

string

getCount()

getCount

(

)

Returns

int

getData()

getData

(

)

Returns

\SimpleXMLElement[]

getEnd()

getEnd

(

)

Returns

int

getErrors()

getErrors

(

)

Returns

array

getFunction()

getFunction

(

)

Returns

string

getKey()

getKey

(

)

Returns

string

getListType()

getListType

(

)

Returns

string

getNumRemaining()

getNumRemaining

(

)

Returns

int

getResultId()

getResultId

(

)

Returns

string

getStart()

getStart

(

)

Returns

int

getStatus()

getStatus

(

)

Returns

string

getTotalCount()

getTotalCount

(

)

Returns

int

setEnd()

setEnd

(

int

$end

)

Parameters

int

$end

setKey()

setKey

(

string

$key

)

Parameters

string

$key

setStart()

setStart

(

int

$start

)

Parameters

int

$start