Fault Class Reference

XMLRPC Faults. More...

Public Member Functions
	__construct ($code=404, $message= '')
	Constructor.
	setCode ($code)
	Set the fault code.
	getCode ()
	Return fault code.
	setMessage ($message)
	Retrieve fault message.
	getMessage ()
	Retrieve fault message.
	setEncoding ($encoding)
	Set encoding to use in fault response.
	getEncoding ()
	Retrieve current fault encoding.
	loadXml ($fault)
	Load an XMLRPC fault from XML.
	saveXml ()
	Serialize fault to XML.
	__toString ()
	Return XML fault response.

Static Public Member Functions
static	isFault ($xml)
	Determine if an XML response is an XMLRPC fault.

Protected Attributes
	$code
	$encoding = 'UTF-8'
	$message
	$internal

Detailed Description

XMLRPC Faults.

Container for XMLRPC faults, containing both a code and a message; additionally, has methods for determining if an XML response is an XMLRPC fault, as well as generating the XML for an XMLRPC fault response.

To allow method chaining, you may only use the getInstance() factory to instantiate a Zend.

Constructor & Destructor Documentation

__construct	(		$code = 404,
			$message = ''
	)

Constructor.

Parameters

int	$code
string	$message

Member Function Documentation

__toString

(

)

Return XML fault response.

Returns

string

getCode

(

)

Return fault code.

Returns

int

getEncoding

(

)

Retrieve current fault encoding.

Returns

string

getMessage

(

)

Retrieve fault message.

Returns

string

static isFault (   $xml )

static

Determine if an XML response is an XMLRPC fault.

Parameters

string

$xml

Returns

bool

loadXml

(

$fault

)

Load an XMLRPC fault from XML.

Parameters

string

$fault

Returns

bool Returns true if successfully loaded fault response, false if response was not a fault response

Exceptions

Exception\ExceptionInterface

if no or faulty XML provided, or if fault response does not contain either code or message

saveXml

(

)

Serialize fault to XML.

Returns

string

setCode

(

$code

)

Set the fault code.

Parameters

int

$code

Returns

Fault

setEncoding

(

$encoding

)

Set encoding to use in fault response.

Parameters

string

$encoding

Returns

Fault

setMessage

(

$message

)

Retrieve fault message.

Parameters

string

Returns

Fault

Member Data Documentation

$code

protected

$encoding = 'UTF-8'

protected

$internal

protected

Initial value:

= [
        404 => 'Unknown Error'

$message

protected