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()}.
Create a new XML-RPC request
| Parameters: |
|
|---|
Set encoding to use in request
| Parameters: | string – |
|---|---|
| Return type: | ZendXmlRpcRequest |
Set method to call
| Parameters: | string – |
|---|---|
| Return type: | bool Returns true on success, false if method name is invalid |
Add a parameter to the parameter stack
Adds a parameter to the parameter stack, associating it with the type $type if provided
| Parameters: |
|
|---|---|
| Return type: | 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: <code> $array = array(
- array(
- ‘value’ => $value, ‘type’ => $type
)[, ... ]
); </code>
| Return type: | void |
|---|
Load XML and parse into request components
| Parameters: | string – |
|---|---|
| Throws ExceptionValueException: | |
| if invalid XML | |
| Return type: | bool True on success, false if an error occurred. |
Does the current request contain errors and should it return a fault response?
| Return type: | bool |
|---|
Retrieve the fault response, if any
| Return type: | null|ZendXmlRpcFault |
|---|