XmlRpc/Request/Stdin.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

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_Stdin

Package: Zend\XmlRpc
XmlRpc Request object -- Request via STDIN

Extends 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.

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: Stdin.php 24593 2012-01-05 20:35:02Z matthew $  

Properties

>VPropertyprotectedstring $_encoding = 'UTF-8'
inherited
Request character encoding
Inherited from: \Zend_XmlRpc_Request::$$_encoding
Default value'UTF-8'Details
Type
string
Inherited_from
\Zend_XmlRpc_Request::$$_encoding  
>VPropertyprotected\Zend_XmlRpc_Fault $_fault = null
inherited
Fault object, if any
Inherited from: \Zend_XmlRpc_Request::$$_fault
Default valuenullDetails
Type
\Zend_XmlRpc_Fault
Inherited_from
\Zend_XmlRpc_Request::$$_fault  
>VPropertyprotectedstring $_method
inherited
Method to call
Inherited from: \Zend_XmlRpc_Request::$$_method
Details
Type
string
Inherited_from
\Zend_XmlRpc_Request::$$_method  
>VPropertyprotectedarray $_params = array()
inherited
Method parameters
Inherited from: \Zend_XmlRpc_Request::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_XmlRpc_Request::$$_params  
>VPropertyprotectedarray $_types = array()
inherited
XML-RPC type for each param
Inherited from: \Zend_XmlRpc_Request::$$_types
Default valuearray()Details
Type
array
Inherited_from
\Zend_XmlRpc_Request::$$_types  
>VPropertyprotectedstring $_xml
Raw XML as received via request
Details
Type
string
>VPropertyprotectedarray $_xmlRpcParams = array()
inherited
XML-RPC request params
Inherited from: \Zend_XmlRpc_Request::$$_xmlRpcParams
Default valuearray()Details
Type
array
Inherited_from
\Zend_XmlRpc_Request::$$_xmlRpcParams  

Methods

methodpublic__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.

methodpublic__toString() : string
inherited

Return XML request

Inherited from: \Zend_XmlRpc_Request::__toString()
Returns
TypeDescription
string
methodprotected_getXmlRpcParams() : array
inherited

Retrieve method parameters as XMLRPC values

Inherited from: \Zend_XmlRpc_Request::_getXmlRpcParams()
Returns
TypeDescription
array
methodpublicaddParam(mixed $value, string $type = null) : void
inherited

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

Parameters
NameTypeDescription
$valuemixed
$typestring

Optional; type hinting

methodpublicgetEncoding() : string
inherited

Retrieve current request encoding

Inherited from: \Zend_XmlRpc_Request::getEncoding()
Returns
TypeDescription
string
methodpublicgetFault() : null | \Zend_XmlRpc_Fault
inherited

Retrieve the fault response, if any

Inherited from: \Zend_XmlRpc_Request::getFault()
Returns
TypeDescription
null | \Zend_XmlRpc_Fault
methodpublicgetMethod() : string
inherited

Retrieve call method

Inherited from: \Zend_XmlRpc_Request::getMethod()
Returns
TypeDescription
string
methodpublicgetParams() : array
inherited

Retrieve the array of parameters

Inherited from: \Zend_XmlRpc_Request::getParams()
Returns
TypeDescription
array
methodpublicgetRawRequest() : string

Retrieve the raw XML request

Returns
TypeDescription
string
methodpublicgetTypes() : array
inherited

Return parameter types

Inherited from: \Zend_XmlRpc_Request::getTypes()
Returns
TypeDescription
array
methodpublicisFault() : boolean
inherited

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

Inherited from: \Zend_XmlRpc_Request::isFault()
Returns
TypeDescription
boolean
methodpublicloadXml(string $request) : boolean
inherited

Load XML and parse into request components

Inherited from: \Zend_XmlRpc_Request::loadXml()
Parameters
NameTypeDescription
$requeststring
Returns
TypeDescription
booleanTrue on success, false if an error occurred.
methodpublicsaveXml() : string
inherited

Create XML request

Inherited from: \Zend_XmlRpc_Request::saveXml()
Returns
TypeDescription
string
methodpublicsetEncoding(string $encoding) : \Zend_XmlRpc_Request
inherited

Set encoding to use in request

Inherited from: \Zend_XmlRpc_Request::setEncoding()
Parameters
NameTypeDescription
$encodingstring
Returns
TypeDescription
\Zend_XmlRpc_Request
methodpublicsetMethod(string $method) : boolean
inherited

Set method to call

Inherited from: \Zend_XmlRpc_Request::setMethod()
Parameters
NameTypeDescription
$methodstring
Returns
TypeDescription
booleanReturns true on success, false if method name is invalid
methodpublicsetParams() : void
inherited

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
    )[, ... ]
);
Details
Access
public  
Documentation was generated by phpDocumentor 2.0.0a12.