XmlRpc/Fault.php

Show:

inherited

Classes
- \Zend_XmlRpc_Fault

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_XmlRpc
Subpackage: Server
Version: $Id: Fault.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_XmlRpc_Fault
jump to top

Package: Zend\XmlRpc

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_XmlRpc_Server_Fault.

Children: \Zend_XmlRpc_Server_Fault
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

int $_code =

Fault code

Details

Type: int

string $_encoding = 'UTF-8'

Fault character encoding

Default value'UTF-8'Details

Type: string

array $_internal = array(404 => 'Unknown Error', 610 => 'Invalid method class', 611 => 'Unable to attach function or callback; not callable', 612 => 'Unable to load array; not an array', 613 => 'One or more method records are corrupt or otherwise unusable', 620 => 'Method does not exist', 621 => 'Error instantiating class to invoke method', 622 => 'Method missing implementation', 623 => 'Calling parameters do not match signature', 630 => 'Unable to read request', 631 => 'Failed to parse request', 632 => 'Invalid request, no method passed; request must contain a \'methodName\' tag', 633 => 'Param must contain a value', 634 => 'Invalid method name', 635 => 'Invalid XML provided to request', 636 => 'Error creating xmlrpc value', 640 => 'Method does not exist', 650 => 'Invalid XML provided for response', 651 => 'Failed to parse response', 652 => 'Invalid response', 653 => 'Invalid XMLRPC value in response')

Internal fault codes => messages

Default value

array(404 => 'Unknown Error', 610 => 'Invalid method class', 611 => 'Unable to attach function or callback; not callable', 612 => 'Unable to load array; not an array', 613 => 'One or more method records are corrupt or otherwise unusable', 620 => 'Method does not exist', 621 => 'Error instantiating class to invoke method', 622 => 'Method missing implementation', 623 => 'Calling parameters do not match signature', 630 => 'Unable to read request', 631 => 'Failed to parse request', 632 => 'Invalid request, no method passed; request must contain a \'methodName\' tag', 633 => 'Param must contain a value', 634 => 'Invalid method name', 635 => 'Invalid XML provided to request', 636 => 'Error creating xmlrpc value', 640 => 'Method does not exist', 650 => 'Invalid XML provided for response', 651 => 'Failed to parse response', 652 => 'Invalid response', 653 => 'Invalid XMLRPC value in response')

Details

Type: array

string $_message =

Fault message

Details

Type: string

Methods

__construct( $code = 404, $message = '') : \Zend_XmlRpc_Fault

Constructor

Parameters

Name	Type	Description
$code
$message

Returns

Type	Description
\Zend_XmlRpc_Fault

__toString() : string

Return XML fault response

Returns

Type	Description
string

getCode() : int

Return fault code

Returns

Type	Description
int

getEncoding() : string

Retrieve current fault encoding

Returns

Type	Description
string

getMessage() : string

Retrieve fault message

Returns

Type	Description
string

isFault(string $xml) : boolean

static

Determine if an XML response is an XMLRPC fault

Parameters

Name	Type	Description
$xml	string

Returns

Type	Description
boolean

loadXml(string $fault) : boolean

Load an XMLRPC fault from XML

Parameters

Name	Type	Description
$fault	string

Returns

Type	Description
boolean	Returns true if successfully loaded fault response, false if response was not a fault response

Throws

Exception	Description
\Zend_XmlRpc_Exception	if no or faulty XML provided, or if fault response does not contain either code or message

saveXml() : string

Serialize fault to XML

Returns

Type	Description
string

setCode(int $code) : \Zend_XmlRpc_Fault

Set the fault code

Parameters

Name	Type	Description
$code	int

Returns

Type	Description
\Zend_XmlRpc_Fault

setEncoding(string $encoding) : \Zend_XmlRpc_Fault

Set encoding to use in fault response

Parameters

Name	Type	Description
$encoding	string

Returns

Type	Description
\Zend_XmlRpc_Fault

setMessage( $message) : \Zend_XmlRpc_Fault

Retrieve fault message

Parameters

Name	Type	Description
$message		string

Returns

Type	Description
\Zend_XmlRpc_Fault

XmlRpc/Fault.php

\Zend_XmlRpc_Faultjump to top

Properties

Methods

\Zend_XmlRpc_Fault
jump to top