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.
XmlRpc Request object -- Request via STDIN
Extends {@link Zend_XmlRpc_Request} to accept a request via STDIN. Request is built at construction time using data from STDIN; if no data is available, the request is declared a fault.

__construct(
)
:
void
Constructor
Attempts to read from php://stdin 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
Return XML request
Inherited from: \Zend_XmlRpc_Request::__toString()Type | Description |
---|---|
string |

_getXmlRpcParams(
)
:
array
Retrieve method parameters as XMLRPC values
Inherited from: \Zend_XmlRpc_Request::_getXmlRpcParams()Type | Description |
---|---|
array |

addParam(
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
Name | Type | Description |
---|---|---|
$value | mixed | |
$type | string | Optional; type hinting |

getEncoding(
)
:
string
Retrieve current request encoding
Inherited from: \Zend_XmlRpc_Request::getEncoding()Type | Description |
---|---|
string |

getFault(
)
:
null|\Zend_XmlRpc_Fault
Retrieve the fault response, if any
Inherited from: \Zend_XmlRpc_Request::getFault()Type | Description |
---|---|
null\Zend_XmlRpc_Fault |

getMethod(
)
:
string
Retrieve call method
Inherited from: \Zend_XmlRpc_Request::getMethod()Type | Description |
---|---|
string |

getParams(
)
:
array
Retrieve the array of parameters
Inherited from: \Zend_XmlRpc_Request::getParams()Type | Description |
---|---|
array |

getTypes(
)
:
array
Return parameter types
Inherited from: \Zend_XmlRpc_Request::getTypes()Type | Description |
---|---|
array |

isFault(
)
:
boolean
Does 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
Load XML and parse into request components
Inherited from: \Zend_XmlRpc_Request::loadXml()Name | Type | Description |
---|---|---|
$request | string |
Type | Description |
---|---|
boolean | True on success, false if an error occurred. |

saveXml(
)
:
string
Create XML request
Inherited from: \Zend_XmlRpc_Request::saveXml()Type | Description |
---|---|
string |

setEncoding(
string $encoding
)
:
\Zend_XmlRpc_Request
Set encoding to use in request
Inherited from: \Zend_XmlRpc_Request::setEncoding()
setMethod(
string $method
)
:
boolean
Set method to call
Inherited from: \Zend_XmlRpc_Request::setMethod()Name | Type | Description |
---|---|---|
$method | string |
Type | Description |
---|---|
boolean | Returns true on success, false if method name is invalid |

setParams(
)
:
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
)[, ... ]
);