XmlRpc/Request/Http.php
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 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 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.
- Parent(s)
- \Zend_XmlRpc_Request
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Http.php 24593 2012-01-05 20:35:02Z matthew $
Properties
string $_encoding = 'UTF-8''UTF-8'Details- Type
- string
- Inherited_from
- \Zend_XmlRpc_Request::$$_encoding
\Zend_XmlRpc_Fault $_fault = null
nullDetails- Type
- \Zend_XmlRpc_Fault
- Inherited_from
- \Zend_XmlRpc_Request::$$_fault
array $_headers = Array of headers
- Type
- array
array $_params = array()
array()Details- Type
- array
- Inherited_from
- \Zend_XmlRpc_Request::$$_params
array $_types = array()
array()Details- Type
- array
- Inherited_from
- \Zend_XmlRpc_Request::$$_types
string $_xml = Raw XML as received via request
- Type
- string
array $_xmlRpcParams = array()
array()Details- Type
- array
- Inherited_from
- \Zend_XmlRpc_Request::$$_xmlRpcParams
Methods
__construct() : voidConstructor
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.
__toString() : string
| Type | Description |
|---|---|
| string |
_getXmlRpcParams() : arrayRetrieve method parameters as XMLRPC values
Inherited from: \Zend_XmlRpc_Request::_getXmlRpcParams()| Type | Description |
|---|---|
| array |
addParam(mixed $value, string $type = null) : void
Adds a parameter to the parameter stack, associating it with the type $type if provided
| Name | Type | Description |
|---|---|---|
| $value | mixed | |
| $type | string | Optional; type hinting |
getEncoding() : string
| Type | Description |
|---|---|
| string |
getFullRequest() : stringRetrieve the full HTTP request, including headers and XML
| Type | Description |
|---|---|
| string |
getHeaders() : arrayGet headers
Gets all headers as key => value pairs and returns them.
| Type | Description |
|---|---|
| array |
getMethod() : string
| Type | Description |
|---|---|
| string |
getParams() : array
| Type | Description |
|---|---|
| array |
getRawRequest() : stringRetrieve the raw XML request
| Type | Description |
|---|---|
| string |
getTypes() : array
| Type | Description |
|---|---|
| array |
isFault() : booleanDoes the current request contain errors and should it return a fault response?
Inherited from: \Zend_XmlRpc_Request::isFault()| Type | Description |
|---|---|
| boolean |
loadXml(string $request) : boolean
| Name | Type | Description |
|---|---|---|
| $request | string |
| Type | Description |
|---|---|
| boolean | True on success, false if an error occurred. |
saveXml() : string
| Type | Description |
|---|---|
| string |
setEncoding(string $encoding) : \Zend_XmlRpc_Request
| Name | Type | Description |
|---|---|---|
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Request |
setMethod(string $method) : boolean
| Name | Type | Description |
|---|---|---|
| $method | string |
| Type | Description |
|---|---|
| boolean | Returns true on success, false if method name is invalid |
setParams() : void
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
)[, ... ]
);
- Access
- public