Json/Server/Request/Http.php

Show:

inherited

Classes
- \Zend_Json_Server_Request_Http

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 [email protected] 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
jump to top

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

mixed $_id =

inherited

Request ID

Inherited from: \Zend_Json_Server_Request::$$_id

Details

Type: mixed
Inherited_from: \Zend_Json_Server_Request::$$_id

bool $_isMethodError = false

inherited

Flag

Inherited from: \Zend_Json_Server_Request::$$_isMethodError

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Json_Server_Request::$$_isMethodError

string $_method =

inherited

Requested method

Inherited from: \Zend_Json_Server_Request::$$_method

Details

Type: string
Inherited_from: \Zend_Json_Server_Request::$$_method

string $_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

array $_params = array()

inherited

Request parameters

Inherited from: \Zend_Json_Server_Request::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Zend_Json_Server_Request::$$_params

string $_rawJson =

Raw JSON pulled from POST body

Details

Type: string

string $_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

__construct() : void

Constructor

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

__toString() : string

inherited

Cast request to string (JSON)

Inherited from: \Zend_Json_Server_Request::__toString()

Returns

Type	Description
string

addParam(mixed $value, string $key = null) : \Zend_Json_Server_Request

inherited

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

addParams(array $params) : \Zend_Json_Server_Request

inherited

Add many params

Inherited from: \Zend_Json_Server_Request::addParams()

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Json_Server_Request

getId() : mixed

inherited

Retrieve request identifier

Inherited from: \Zend_Json_Server_Request::getId()

Returns

Type	Description
mixed

getMethod() : string

inherited

Get request method name

Inherited from: \Zend_Json_Server_Request::getMethod()

Returns

Type	Description
string

getParam(int | string $index) : mixed | null

inherited

Retrieve param by index or key

Inherited from: \Zend_Json_Server_Request::getParam()

Parameters

Name	Type	Description
$index	int \| string

Returns

Type	Description
mixed \| null	Null when not found

getParams() : array

inherited

Retrieve parameters

Inherited from: \Zend_Json_Server_Request::getParams()

Returns

Type	Description
array

getRawJson() : string

Get JSON from raw POST body

Returns

Type	Description
string

getVersion() : string

inherited

Retrieve JSON-RPC version

Inherited from: \Zend_Json_Server_Request::getVersion()

Returns

Type	Description
string

isMethodError() : bool

inherited

Was a bad method provided?

Inherited from: \Zend_Json_Server_Request::isMethodError()

Returns

Type	Description
bool

loadJson(string $json) : void

inherited

Set request state based on JSON

Inherited from: \Zend_Json_Server_Request::loadJson()

Parameters

Name	Type	Description
$json	string

setId(mixed $name) : \Zend_Json_Server_Request

inherited

Set request identifier

Inherited from: \Zend_Json_Server_Request::setId()

Parameters

Name	Type	Description
$name	mixed

Returns

Type	Description
\Zend_Json_Server_Request

setMethod(string $name) : \Zend_Json_Server_Request

inherited

Set request method

Inherited from: \Zend_Json_Server_Request::setMethod()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Json_Server_Request

setOptions(array $options) : \Zend_Json_Server_Request

inherited

Set request state

Inherited from: \Zend_Json_Server_Request::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Json_Server_Request

setParams(array $params) : \Zend_Json_Server_Request

inherited

Overwrite params

Inherited from: \Zend_Json_Server_Request::setParams()

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Json_Server_Request

setVersion(string $version) : \Zend_Json_Server_Request

inherited

Set JSON-RPC version

Inherited from: \Zend_Json_Server_Request::setVersion()

Parameters

Name	Type	Description
$version	string

Returns

Type	Description
\Zend_Json_Server_Request

toJson() : string

inherited

Cast request to JSON

Inherited from: \Zend_Json_Server_Request::toJson()

Returns

Type	Description
string

Json/Server/Request/Http.php

\Zend_Json_Server_Request_Httpjump to top

Properties

Methods

\Zend_Json_Server_Request_Http
jump to top