API Documentation

Json/Server/Request/Http.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Json  
version
$Id: Http.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Json_Server_Request_Http

Extends from
\Zend_Json_Server_Request
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Json  
subpackage
Server  

Properties

Propertyprotectedstring  $_rawJson= ''

Raw JSON pulled from POST body

Details
Type
string

Methods

methodpublic__construct( ) : void

Constructor

Pull JSON request from raw POST body and use to populate request.

methodpublic__toString( ) : string

Cast request to string (JSON)

Inherited from: \Zend_Json_Server_Request::__toString()
Returns
Type Description
string
methodpublicaddParam( mixed $value, string $key = null ) : \Zend_Json_Server_Request

Add a parameter to the request

Inherited from: \Zend_Json_Server_Request::addParam()
Parameters
Name Type Description
$value mixed
$key string
Returns
Type Description
\Zend_Json_Server_Request
methodpublicaddParams( array $params ) : \Zend_Json_Server_Request

Add many params

Inherited from: \Zend_Json_Server_Request::addParams()
Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Json_Server_Request
methodpublicgetId( ) : mixed

Retrieve request identifier

Inherited from: \Zend_Json_Server_Request::getId()
Returns
Type Description
mixed
methodpublicgetMethod( ) : string

Get request method name

Inherited from: \Zend_Json_Server_Request::getMethod()
Returns
Type Description
string
methodpublicgetParam( int|string $index ) : mixed|null

Retrieve param by index or key

Inherited from: \Zend_Json_Server_Request::getParam()
Parameters
Name Type Description
$index int|string
Returns
Type Description
mixednull Null when not found
methodpublicgetParams( ) : array

Retrieve parameters

Inherited from: \Zend_Json_Server_Request::getParams()
Returns
Type Description
array
methodpublicgetRawJson( ) : string

Get JSON from raw POST body

Returns
Type Description
string
methodpublicgetVersion( ) : string

Retrieve JSON-RPC version

Inherited from: \Zend_Json_Server_Request::getVersion()
Returns
Type Description
string
methodpublicisMethodError( ) : bool

Was a bad method provided?

Inherited from: \Zend_Json_Server_Request::isMethodError()
Returns
Type Description
bool
methodpublicloadJson( string $json ) : void

Set request state based on JSON

Inherited from: \Zend_Json_Server_Request::loadJson()
Parameters
Name Type Description
$json string
methodpublicsetId( mixed $name ) : \Zend_Json_Server_Request

Set request identifier

Inherited from: \Zend_Json_Server_Request::setId()
Parameters
Name Type Description
$name mixed
Returns
Type Description
\Zend_Json_Server_Request
methodpublicsetMethod( string $name ) : \Zend_Json_Server_Request

Set request method

Inherited from: \Zend_Json_Server_Request::setMethod()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Json_Server_Request
methodpublicsetOptions( array $options ) : \Zend_Json_Server_Request

Set request state

Inherited from: \Zend_Json_Server_Request::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Json_Server_Request
methodpublicsetParams( array $params ) : \Zend_Json_Server_Request

Overwrite params

Inherited from: \Zend_Json_Server_Request::setParams()
Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Json_Server_Request
methodpublicsetVersion( string $version ) : \Zend_Json_Server_Request

Set JSON-RPC version

Inherited from: \Zend_Json_Server_Request::setVersion()
Parameters
Name Type Description
$version string
Returns
Type Description
\Zend_Json_Server_Request
methodpublictoJson( ) : string

Cast request to JSON

Inherited from: \Zend_Json_Server_Request::toJson()
Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.