API Documentation

XmlRpc/Request/Http.php

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.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  

\Zend_XmlRpc_Request_Http

XmlRpc Request object -- Request via HTTP

Extends {@link Zend_XmlRpc_Request} to accept a request via HTTP. Request is built at construction time using a raw POST; if no data is available, the request is declared a fault.

Extends from
\Zend_XmlRpc_Request
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_XmlRpc  
version
$Id: Http.php 23775 2011-03-01 17:25:24Z ralph $  

Properties

Propertyprotectedarray  $_headers= ''

Array of headers

Details
Type
array
Propertyprotectedstring  $_xml= ''

Raw XML as received via request

Details
Type
string

Methods

methodpublic__construct( ) : void

Constructor

Attempts to read from php://input to get raw POST request; if an error occurs in doing so, or if the XML is invalid, the request is declared a fault.

methodpublic__toString( ) : string

Return XML request

Inherited from: \Zend_XmlRpc_Request::__toString()
Returns
Type Description
string
methodprotected_getXmlRpcParams( ) : array

Retrieve method parameters as XMLRPC values

Inherited from: \Zend_XmlRpc_Request::_getXmlRpcParams()
Returns
Type Description
array
methodpublicaddParam( mixed $value, string $type = null ) : void

Add a parameter to the parameter stack

Inherited from: \Zend_XmlRpc_Request::addParam()

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

Parameters
Name Type Description
$value mixed
$type string Optional; type hinting
methodpublicgetEncoding( ) : string

Retrieve current request encoding

Inherited from: \Zend_XmlRpc_Request::getEncoding()
Returns
Type Description
string
methodpublicgetFault( ) : null|\Zend_XmlRpc_Fault

Retrieve the fault response, if any

Inherited from: \Zend_XmlRpc_Request::getFault()
Returns
Type Description
null\Zend_XmlRpc_Fault
methodpublicgetFullRequest( ) : string

Retrieve the full HTTP request, including headers and XML

Returns
Type Description
string
methodpublicgetHeaders( ) : array

Get headers

Gets all headers as key => value pairs and returns them.

Returns
Type Description
array
methodpublicgetMethod( ) : string

Retrieve call method

Inherited from: \Zend_XmlRpc_Request::getMethod()
Returns
Type Description
string
methodpublicgetParams( ) : array

Retrieve the array of parameters

Inherited from: \Zend_XmlRpc_Request::getParams()
Returns
Type Description
array
methodpublicgetRawRequest( ) : string

Retrieve the raw XML request

Returns
Type Description
string
methodpublicgetTypes( ) : array

Return parameter types

Inherited from: \Zend_XmlRpc_Request::getTypes()
Returns
Type Description
array
methodpublicisFault( ) : boolean

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

Inherited from: \Zend_XmlRpc_Request::isFault()
Returns
Type Description
boolean
methodpublicloadXml( string $request ) : boolean

Load XML and parse into request components

Inherited from: \Zend_XmlRpc_Request::loadXml()
Parameters
Name Type Description
$request string
Returns
Type Description
boolean True on success, false if an error occurred.
methodpublicsaveXml( ) : string

Create XML request

Inherited from: \Zend_XmlRpc_Request::saveXml()
Returns
Type Description
string
methodpublicsetEncoding( string $encoding ) : \Zend_XmlRpc_Request

Set encoding to use in request

Inherited from: \Zend_XmlRpc_Request::setEncoding()
Parameters
Name Type Description
$encoding string
Returns
Type Description
\Zend_XmlRpc_Request
methodpublicsetMethod( string $method ) : boolean

Set method to call

Inherited from: \Zend_XmlRpc_Request::setMethod()
Parameters
Name Type Description
$method string
Returns
Type Description
boolean Returns true on success, false if method name is invalid
methodpublicsetParams( ) : void

Set the parameters array

Inherited from: \Zend_XmlRpc_Request::setParams()

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
access
public  
Documentation was generated by DocBlox 0.13.3.