Zend\XmlRpc\Request
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 ; developers may check for it using
and .
Synopsis
class Request
{
- // members
- protected string $encoding;
- protected string $method;
- protected string $xml;
- protected array $params;
- protected Fault $fault;
- protected array $types;
- protected array $xmlRpcParams;
- // methods
- public void __construct()
- public Request setEncoding()
- public string getEncoding()
- public bool setMethod()
- public string getMethod()
- public void addParam()
- public void setParams()
- public array getParams()
- public array getTypes()
- public bool loadXml()
- public bool isFault()
- public Fault getFault()
- protected array _getXmlRpcParams()
- public string saveXml()
- public string __toString()
Hierarchy
Extended by
Members
protected
- $encoding
—
string
Request character encoding - $fault
—
\Zend\XmlRpc\Fault
Fault object, if any - $method
—
string
Method to call - $params
—
array
Method parameters - $types
—
array
XML-RPC type for each param - $xml
—
string
XML request - $xmlRpcParams
—
array
XML-RPC request params
Methods
protected
- _getXmlRpcParams() — Retrieve method parameters as XMLRPC values
public
- __construct() — Create a new XML-RPC request
- __toString() — Return XML request
- addParam() — Add a parameter to the parameter stack
- getEncoding() — Retrieve current request encoding
- getFault() — Retrieve the fault response, if any
- getMethod() — Retrieve call method
- getParams() — Retrieve the array of parameters
- getTypes() — Return parameter types
- isFault() — Does the current request contain errors and should it return a fault response?
- loadXml() — Load XML and parse into request components
- saveXml() — Create XML request
- setEncoding() — Set encoding to use in request
- setMethod() — Set method to call
- setParams() — Set the parameters array