XmlRpc/Request.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
Classes: Zend_XmlRpc_Request

Description

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 license@zend.com so we can send you a copy immediately.

Zend_XmlRpc_Request
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_XmlRpc
version: $Id: Request.php 20208 2010-01-11 22:37:37Z lars $
Properties: $_encoding; $_method; $_xml; $_params; $_fault; $_types; $_xmlRpcParams
Methods: __construct; setEncoding; getEncoding; setMethod; getMethod; addParam; setParams; getParams; getTypes; loadXml; isFault; getFault; _getXmlRpcParams; saveXml; __toString

Description

XmlRpc Request object

Encapsulates an XmlRpc request, holding the method call and all parameters. Provides accessors for these, as well as the ability to load from XML and to create the XML request string.

Additionally, if errors occur setting the method or parsing XML, a fault is generated and stored in {@link $_fault}; developers may check for it using {@link isFault()} and {@link getFault()}.

Properties

$_encoding
jump to class

string $_encoding = 'UTF-8'

Request character encoding

Details

$_encoding: string
visibility: protected
default: UTF-8
final: false
static: false

$_fault
jump to class

Zend_XmlRpc_Fault $_fault = 'null'

Fault object, if any

Details

$_fault: Zend_XmlRpc_Fault
visibility: protected
default: null
final: false
static: false

$_method
jump to class

string $_method = ''

Method to call

Details

$_method: string
visibility: protected
default
final: false
static: false

$_params
jump to class

array $_params = 'array'

Method parameters

Details

$_params: array
visibility: protected
default: array
final: false
static: false

$_types
jump to class

array $_types = 'array'

XML-RPC type for each param

Details

$_types: array
visibility: protected
default: array
final: false
static: false

$_xml
jump to class

string $_xml = ''

XML request

Details

$_xml: string
visibility: protected
default
final: false
static: false

$_xmlRpcParams
jump to class

array $_xmlRpcParams = 'array'

XML-RPC request params

Details

$_xmlRpcParams: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $method
              =
              null, array $params
              =
              null
          )
        
        :

Create a new XML-RPC request

Arguments

$method: string
(optional)
$params: array
(optional)

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Return XML request

Output

string

Details

visibility: public
final: false
static: false

_getXmlRpcParams
jump to class

_getXmlRpcParams(
          
          )
        
        :
        array

Retrieve method parameters as XMLRPC values

Output

array

Details

visibility: protected
final: false
static: false

addParam
jump to class

addParam(
          mixed $value, string $type
              =
              null
          )
        
        :
        void

Add a parameter to the parameter stack

Adds a parameter to the parameter stack, associating it with the type $type if provided

Arguments

$value: mixed
$type: string
Optional; type hinting

Details

visibility: public
final: false
static: false

getEncoding
jump to class

getEncoding(
          
          )
        
        :
        string

Retrieve current request encoding

Output

string

Details

visibility: public
final: false
static: false

getFault
jump to class

getFault(
          
          )
        
        :
        null|Zend_XmlRpc_Fault

Retrieve the fault response, if any

Output

null|Zend_XmlRpc_Fault

Details

visibility: public
final: false
static: false

getMethod
jump to class

getMethod(
          
          )
        
        :
        string

Retrieve call method

Output

string

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Retrieve the array of parameters

Output

array

Details

visibility: public
final: false
static: false

getTypes
jump to class

getTypes(
          
          )
        
        :
        array

Return parameter types

Output

array

Details

visibility: public
final: false
static: false

isFault
jump to class

isFault(
          
          )
        
        :
        boolean

Does the current request contain errors and should it return a fault response?

Output

boolean

Details

visibility: public
final: false
static: false

loadXml
jump to class

loadXml(
          string $request
          )
        
        :
        boolean

Load XML and parse into request components

Arguments

$request: string

Output

boolean: True on success, false if an error occurred.

Details

visibility: public
final: false
static: false

saveXml
jump to class

saveXml(
          
          )
        
        :
        string

Create XML request

Output

string

Details

visibility: public
final: false
static: false

setEncoding
jump to class

setEncoding(
          string $encoding
          )
        
        :
        Zend_XmlRpc_Request

Set encoding to use in request

Arguments

$encoding: string

Output

Zend_XmlRpc_Request

Details

visibility: public
final: false
static: false

setMethod
jump to class

setMethod(
          string $method
          )
        
        :
        boolean

Set method to call

Arguments

$method: string

Output

boolean: Returns true on success, false if method name is invalid

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          
          )
        
        :
        void

Set the parameters array

If called with a single, array value, that array is used to set the parameters stack. If called with multiple values or a single non-array value, the arguments are used to set the parameters stack.

Best is to call with array of the format, in order to allow type hinting when creating the XMLRPC values for each parameter: $array = array( array( 'value' => $value, 'type' => $type )[, ... ] );

Details

visibility: public
final: false
static: false
access: public

API Documentation

XmlRpc/Request.php

Description

Zend_XmlRpc_Requestjump to top

Description

Properties

$_encodingjump to class

Details

$_faultjump to class

Details

$_methodjump to class

Details

$_paramsjump to class

Details

$_typesjump to class

Details

$_xmljump to class

Details

$_xmlRpcParamsjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_getXmlRpcParamsjump to class

Output

Details

addParamjump to class

Arguments

Details

getEncodingjump to class

Output

Details

getFaultjump to class

Output

Details

getMethodjump to class

Output

Details

getParamsjump to class

Output

Details

getTypesjump to class

Output

Details

isFaultjump to class

Output

Details

loadXmljump to class

Arguments

Output

Details

saveXmljump to class

Output

Details

setEncodingjump to class

Arguments

Output

Details

setMethodjump to class

Arguments

Output

Details

setParamsjump to class

Details

Zend_XmlRpc_Request
jump to top

$_encoding
jump to class

$_fault
jump to class

$_method
jump to class

$_params
jump to class

$_types
jump to class

$_xml
jump to class

$_xmlRpcParams
jump to class

__construct
jump to class

__toString
jump to class

_getXmlRpcParams
jump to class

addParam
jump to class

getEncoding
jump to class

getFault
jump to class

getMethod
jump to class

getParams
jump to class

getTypes
jump to class

isFault
jump to class

loadXml
jump to class

saveXml
jump to class

setEncoding
jump to class

setMethod
jump to class

setParams
jump to class