Json/Server/Request.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Json
subpackage: Server
version: $Id: Request.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Json_Server_Request

Description

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.

Zend_Json_Server_Request
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Json
subpackage: Server
Properties: $_id; $_isMethodError; $_method; $_methodRegex; $_params; $_version
Methods: setOptions; addParam; addParams; setParams; getParam; getParams; setMethod; getMethod; isMethodError; setId; getId; setVersion; getVersion; loadJson; toJson; __toString

Description

Properties

$_id
jump to class

mixed $_id = ''

Request ID

Details

$_id: mixed
visibility: protected
default
final: false
static: false

$_isMethodError
jump to class

bool $_isMethodError = 'false'

Flag

Details

$_isMethodError: bool
visibility: protected
default: false
final: false
static: false

$_method
jump to class

string $_method = ''

Requested method

Details

$_method: string
visibility: protected
default
final: false
static: false

$_methodRegex
jump to class

string $_methodRegex = '/^[a-z][a-z0-9_.]*$/i'

Regex for method

Details

$_methodRegex: string
visibility: protected
default: /^[a-z][a-z0-9_.]*$/i
final: false
static: false

$_params
jump to class

array $_params = 'array'

Request parameters

Details

$_params: array
visibility: protected
default: array
final: false
static: false

$_version
jump to class

string $_version = '1.0'

JSON-RPC version of request

Details

$_version: string
visibility: protected
default: 1.0
final: false
static: false

Methods

__toString
jump to class

__toString(
          
          )
        
        :
        string

Cast request to string (JSON)

Output

string

Details

visibility: public
final: false
static: false

addParam
jump to class

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

Add a parameter to the request

Arguments

$value: mixed
$key: string

Output

Zend_Json_Server_Request

Details

visibility: public
final: false
static: false

addParams
jump to class

addParams(
          array $params
          )
        
        :
        Zend_Json_Server_Request

Add many params

Arguments

$params: array

Output

Zend_Json_Server_Request

Details

visibility: public
final: false
static: false

getId
jump to class

getId(
          
          )
        
        :
        mixed

Retrieve request identifier

Output

mixed

Details

visibility: public
final: false
static: false

getMethod
jump to class

getMethod(
          
          )
        
        :
        string

Get request method name

Output

string

Details

visibility: public
final: false
static: false

getParam
jump to class

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

Retrieve param by index or key

Arguments

$index: intstring

Output

mixed|null: Null when not found

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Retrieve parameters

Output

array

Details

visibility: public
final: false
static: false

getVersion
jump to class

getVersion(
          
          )
        
        :
        string

Retrieve JSON-RPC version

Output

string

Details

visibility: public
final: false
static: false

isMethodError
jump to class

isMethodError(
          
          )
        
        :
        bool

Was a bad method provided?

Output

bool

Details

visibility: public
final: false
static: false

loadJson
jump to class

loadJson(
          string $json
          )
        
        :
        void

Set request state based on JSON

Arguments

$json: string

Details

visibility: public
final: false
static: false

setId
jump to class

setId(
          mixed $name
          )
        
        :
        Zend_Json_Server_Request

Set request identifier

Arguments

$name: mixed

Output

Zend_Json_Server_Request

Details

visibility: public
final: false
static: false

setMethod
jump to class

setMethod(
          string $name
          )
        
        :
        Zend_Json_Server_Request

Set request method

Arguments

$name: string

Output

Zend_Json_Server_Request

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Json_Server_Request

Set request state

Arguments

$options: array

Output

Zend_Json_Server_Request

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          array $params
          )
        
        :
        Zend_Json_Server_Request

Overwrite params

Arguments

$params: array

Output

Zend_Json_Server_Request

Details

visibility: public
final: false
static: false

setVersion
jump to class

setVersion(
          string $version
          )
        
        :
        Zend_Json_Server_Request

Set JSON-RPC version

Arguments

$version: string

Output

Zend_Json_Server_Request

Details

visibility: public
final: false
static: false

toJson
jump to class

toJson(
          
          )
        
        :
        string

Cast request to JSON

Output

string

Details

visibility: public
final: false
static: false

API Documentation

Json/Server/Request.php

Description

Zend_Json_Server_Requestjump to top

Description

Properties

$_idjump to class

Details

$_isMethodErrorjump to class

Details

$_methodjump to class

Details

$_methodRegexjump to class

Details

$_paramsjump to class

Details

$_versionjump to class

Details

Methods

__toStringjump to class

Output

Details

addParamjump to class

Arguments

Output

Details

addParamsjump to class

Arguments

Output

Details

getIdjump to class

Output

Details

getMethodjump to class

Output

Details

getParamjump to class

Arguments

Output

Details

getParamsjump to class

Output

Details

getVersionjump to class

Output

Details

isMethodErrorjump to class

Output

Details

loadJsonjump to class

Arguments

Details

setIdjump to class

Arguments

Output

Details

setMethodjump to class

Arguments

Output

Details

setOptionsjump to class

Arguments

Output

Details

setParamsjump to class

Arguments

Output

Details

setVersionjump to class

Arguments

Output

Details

toJsonjump to class

Output

Details

Zend_Json_Server_Request
jump to top

$_id
jump to class

$_isMethodError
jump to class

$_method
jump to class

$_methodRegex
jump to class

$_params
jump to class

$_version
jump to class

__toString
jump to class

addParam
jump to class

addParams
jump to class

getId
jump to class

getMethod
jump to class

getParam
jump to class

getParams
jump to class

getVersion
jump to class

isMethodError
jump to class

loadJson
jump to class

setId
jump to class

setMethod
jump to class

setOptions
jump to class

setParams
jump to class

setVersion
jump to class

toJson
jump to class