Create Service Mapping Description for a method

package Zend_Json
subpackage Server
version $Id$
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

__construct(string|array $spec) : void

Parameters

$spec

stringarray

Exceptions

\Zend_Json_Server_Exception if no name provided

Cast to string

__toString() : string

Returns

string

Add a parameter to the service

addParam(string|array $type, array $options = array(), integer|null $order = null) : \Zend_Json_Server_Smd_Service

Parameters

$type

stringarray

$options

array

$order

integernull

Returns

\Zend_Json_Server_Smd_Service

Add params

addParams(array $params) : \Zend_Json_Server_Smd_Service

Each param should be an array, and should include the key 'type'.

Parameters

$params

array

Returns

\Zend_Json_Server_Smd_Service

Get envelope type

getEnvelope() : string

Returns

string

Retrieve name

getName() : string

Returns

string

Get all parameters

getParams() : array

Returns all params in specified order.

Returns

array

Get return type

getReturn() : string | array

Returns

stringarray

Get service target

getTarget() : string

Returns

string

Get transport

getTransport() : string

Returns

string

Set envelope type

setEnvelope(string $envelopeType) : \Zend_Json_Server_Smd_Service

Parameters

$envelopeType

string

Returns

\Zend_Json_Server_Smd_Service

Set service name

setName(string $name) : \Zend_Json_Server_Smd_Service

Parameters

$name

string

Exceptions

\Zend_Json_Server_Exception

Returns

\Zend_Json_Server_Smd_Service

Set object state

setOptions(array $options) : \Zend_Json_Server_Smd_Service

Parameters

$options

array

Returns

\Zend_Json_Server_Smd_Service

Overwrite all parameters

setParams(array $params) : \Zend_Json_Server_Smd_Service

Parameters

$params

array

Returns

\Zend_Json_Server_Smd_Service

Set return type

setReturn(string|array $type) : \Zend_Json_Server_Smd_Service

Parameters

$type

stringarray

Returns

\Zend_Json_Server_Smd_Service

Set service target

setTarget(string $target) : \Zend_Json_Server_Smd_Service

Parameters

$target

string

Returns

\Zend_Json_Server_Smd_Service

Set Transport

setTransport(string $transport) : \Zend_Json_Server_Smd_Service

Currently limited to POST

Parameters

$transport

string

Returns

\Zend_Json_Server_Smd_Service

Cast service description to array

toArray() : array

Returns

array

Return JSON encoding of service

toJson() : string

Returns

string

Validate parameter type

_validateParamType(string $type, $isReturn = false) : true

Parameters

$type

string

$isReturn

Exceptions

\Zend_Json_Server_Exception

Returns

true

 Properties

 

$_envelope

$_envelope 

Default

\Zend_Json_Server_Smd::ENV_JSONRPC_1
 

Allowed envelope types

$_envelopeTypes : array

Default

array(\Zend_Json_Server_Smd::ENV_JSONRPC_1, \Zend_Json_Server_Smd::ENV_JSONRPC_2)
 

$_name

$_name 

Default

 

Regex for names

$_nameRegex : string

Default

'/^[a-z][a-z0-9._]+$/i'
 

Mapping of parameter types to JSON-RPC types

$_paramMap : array

Default

array('any' => 'any', 'arr' => 'array', 'array' => 'array', 'assoc' => 'object', 'bool' => 'boolean', 'boolean' => 'boolean', 'dbl' => 'float', 'double' => 'float', 'false' => 'boolean', 'float' => 'float', 'hash' => 'object', 'integer' => 'integer', 'int' => 'integer', 'mixed' => 'any', 'nil' => 'null', 'null' => 'null', 'object' => 'object', 'string' => 'string', 'str' => 'string', 'struct' => 'object', 'true' => 'boolean', 'void' => 'null')
 

Parameter option types

$_paramOptionTypes : array

Default

array('name' => 'is_string', 'optional' => 'is_bool', 'default' => null, 'description' => 'is_string')
 

Service params

$_params : array

Default

array()
 

$_return

$_return 

Default

 

$_target

$_target 

Default

 

$_transport

$_transport 

Default

'POST'
 

Allowed transport types

$_transportTypes : array

Default

array('POST')