Json/Server/Request/Http.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_Json  
Version
$Id: Http.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Json_Server_Request_Http

Package: Zend\Json
Parent(s)
\Zend_Json_Server_Request
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedmixed $_id
inherited
Request ID
Inherited from: \Zend_Json_Server_Request::$$_id
Details
Type
mixed
Inherited_from
\Zend_Json_Server_Request::$$_id  
>VPropertyprotectedbool $_isMethodError = false
inherited
Flag
Inherited from: \Zend_Json_Server_Request::$$_isMethodError
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Json_Server_Request::$$_isMethodError  
>VPropertyprotectedstring $_method
inherited
Requested method
Inherited from: \Zend_Json_Server_Request::$$_method
Details
Type
string
Inherited_from
\Zend_Json_Server_Request::$$_method  
>VPropertyprotectedstring $_methodRegex = '/^[a-z][a-z0-9_.]*$/i'
inherited
Regex for method
Inherited from: \Zend_Json_Server_Request::$$_methodRegex
Default value'/^[a-z][a-z0-9_.]*$/i'Details
Type
string
Inherited_from
\Zend_Json_Server_Request::$$_methodRegex  
>VPropertyprotectedarray $_params = array()
inherited
Request parameters
Inherited from: \Zend_Json_Server_Request::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Json_Server_Request::$$_params  
>VPropertyprotectedstring $_rawJson
Raw JSON pulled from POST body
Details
Type
string
>VPropertyprotectedstring $_version = '1.0'
inherited
JSON-RPC version of request
Inherited from: \Zend_Json_Server_Request::$$_version
Default value'1.0'Details
Type
string
Inherited_from
\Zend_Json_Server_Request::$$_version  

Methods

methodpublic__construct() : void

Constructor

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

methodpublic__toString() : string
inherited

Cast request to string (JSON)

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

Add a parameter to the request

Inherited from: \Zend_Json_Server_Request::addParam()
Parameters
NameTypeDescription
$valuemixed
$keystring
Returns
TypeDescription
\Zend_Json_Server_Request
methodpublicaddParams(array $params) : \Zend_Json_Server_Request
inherited

Add many params

Inherited from: \Zend_Json_Server_Request::addParams()
Parameters
NameTypeDescription
$paramsarray
Returns
TypeDescription
\Zend_Json_Server_Request
methodpublicgetId() : mixed
inherited

Retrieve request identifier

Inherited from: \Zend_Json_Server_Request::getId()
Returns
TypeDescription
mixed
methodpublicgetMethod() : string
inherited

Get request method name

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

Retrieve param by index or key

Inherited from: \Zend_Json_Server_Request::getParam()
Parameters
NameTypeDescription
$indexint | string
Returns
TypeDescription
mixed | nullNull when not found
methodpublicgetParams() : array
inherited

Retrieve parameters

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

Get JSON from raw POST body

Returns
TypeDescription
string
methodpublicgetVersion() : string
inherited

Retrieve JSON-RPC version

Inherited from: \Zend_Json_Server_Request::getVersion()
Returns
TypeDescription
string
methodpublicisMethodError() : bool
inherited

Was a bad method provided?

Inherited from: \Zend_Json_Server_Request::isMethodError()
Returns
TypeDescription
bool
methodpublicloadJson(string $json) : void
inherited

Set request state based on JSON

Inherited from: \Zend_Json_Server_Request::loadJson()
Parameters
NameTypeDescription
$jsonstring
methodpublicsetId(mixed $name) : \Zend_Json_Server_Request
inherited

Set request identifier

Inherited from: \Zend_Json_Server_Request::setId()
Parameters
NameTypeDescription
$namemixed
Returns
TypeDescription
\Zend_Json_Server_Request
methodpublicsetMethod(string $name) : \Zend_Json_Server_Request
inherited

Set request method

Inherited from: \Zend_Json_Server_Request::setMethod()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Json_Server_Request
methodpublicsetOptions(array $options) : \Zend_Json_Server_Request
inherited

Set request state

Inherited from: \Zend_Json_Server_Request::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Json_Server_Request
methodpublicsetParams(array $params) : \Zend_Json_Server_Request
inherited

Overwrite params

Inherited from: \Zend_Json_Server_Request::setParams()
Parameters
NameTypeDescription
$paramsarray
Returns
TypeDescription
\Zend_Json_Server_Request
methodpublicsetVersion(string $version) : \Zend_Json_Server_Request
inherited

Set JSON-RPC version

Inherited from: \Zend_Json_Server_Request::setVersion()
Parameters
NameTypeDescription
$versionstring
Returns
TypeDescription
\Zend_Json_Server_Request
methodpublictoJson() : string
inherited

Cast request to JSON

Inherited from: \Zend_Json_Server_Request::toJson()
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.