PHPXRef 0.7.1 : moodle-2.8 : Detail view of Request.php

Zend Framework LICENSE

Copyright:	Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License:	http://framework.zend.com/license/new-bsd New BSD License
File Size:	446 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Zend_XmlRpc_Request:: (15 methods):
  __construct()
  setEncoding()
  getEncoding()
  setMethod()
  getMethod()
  addParam()
  setParams()
  getParams()
  getTypes()
  loadXml()
  isFault()
  getFault()
  _getXmlRpcParams()
  saveXml()
  __toString()

Class: Zend_XmlRpc_Request - X-Ref

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()}.

__construct($method = null, $params = null) X-Ref

Create a new XML-RPC request

param: string $method (optional)
param: array $params (optional)

setEncoding($encoding) X-Ref

Set encoding to use in request

param: string $encoding
return: Zend_XmlRpc_Request

getEncoding() X-Ref

Retrieve current request encoding

return: string

setMethod($method) X-Ref

Set method to call

param: string $method
return: boolean Returns true on success, false if method name is invalid

getMethod() X-Ref

Retrieve call method

return: string

addParam($value, $type = null) X-Ref

Add a parameter to the parameter stack

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

param: mixed $value
param: string $type Optional; type hinting
return: void

setParams() X-Ref

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: void

getParams() X-Ref

Retrieve the array of parameters

return: array

getTypes() X-Ref

Return parameter types

return: array

loadXml($request) X-Ref

Load XML and parse into request components

param: string $request
return: boolean True on success, false if an error occurred.

isFault() X-Ref

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

return: boolean

getFault() X-Ref

Retrieve the fault response, if any

return: null|Zend_XmlRpc_Fault

_getXmlRpcParams() X-Ref

Retrieve method parameters as XMLRPC values

return: array

saveXml() X-Ref

Create XML request

return: string

__toString() X-Ref

Return XML request

return: string

PHP Cross Reference of moodle-2.8

/lib/zend/Zend/XmlRpc/ -> Request.php (summary)

Defines 1 class