Json/Server/Smd/Service.php

Show:

inherited

Classes
- \Zend_Json_Server_Smd_Service

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Json

\Zend_Json_Server_Smd_Service
jump to top

Package: Zend_Json\Server

Create Service Mapping Description for a method

Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id$

Properties

$_envelope = \Zend_Json_Server_Smd::ENV_JSONRPC_1

Default value\Zend_Json_Server_Smd::ENV_JSONRPC_1Details

Type: n/a

array $_envelopeTypes = array(\Zend_Json_Server_Smd::ENV_JSONRPC_1, \Zend_Json_Server_Smd::ENV_JSONRPC_2)

Allowed envelope types

Default valuearray(\Zend_Json_Server_Smd::ENV_JSONRPC_1, \Zend_Json_Server_Smd::ENV_JSONRPC_2)Details

Type: array

$_name

Details

Type: n/a

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

Regex for names

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

Type: string

array $_paramMap = 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')

Mapping of parameter types to JSON-RPC types

Default value

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')

Details

Type: array

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

Parameter option types

Default valuearray('name' => 'is_string', 'optional' => 'is_bool', 'default' => null, 'description' => 'is_string')Details

Type: array

array $_params = array()

Service params

Default valuearray()Details

Type: array

$_return

Details

Type: n/a

$_target

Details

Type: n/a

$_transport = 'POST'

Default value'POST'Details

Type: n/a

array $_transportTypes = array('POST')

Allowed transport types

Default valuearray('POST')Details

Type: array

Methods

__construct(string | array $spec) : void

Constructor

Parameters

Name	Type	Description
$spec	string \| array

Throws

Exception	Description
\Zend_Json_Server_Exception	if no name provided

__toString() : string

Cast to string

Returns

Type	Description
string

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

Validate parameter type

Parameters

Name	Type	Description
$type	string
$isReturn

Returns

Type	Description
true

Throws

Exception	Description
\Zend_Json_Server_Exception

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

Add a parameter to the service

Parameters

Name	Type	Description
$type	string \| array
$options	array
$order	int \| null

Returns

Type	Description
\Zend_Json_Server_Smd_Service

addParams(array $params) : \Zend_Json_Server_Smd_Service

Add params

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

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Json_Server_Smd_Service

getEnvelope() : string

Get envelope type

Returns

Type	Description
string

getName() : string

Retrieve name

Returns

Type	Description
string

getParams() : array

Get all parameters

Returns all params in specified order.

Returns

Type	Description
array

getReturn() : string | array

Get return type

Returns

Type	Description
string \| array

getTarget() : string

Get service target

Returns

Type	Description
string

getTransport() : string

Get transport

Returns

Type	Description
string

setEnvelope(string $envelopeType) : \Zend_Json_Server_Smd_Service

Set envelope type

Parameters

Name	Type	Description
$envelopeType	string

Returns

Type	Description
\Zend_Json_Server_Smd_Service

setName(string $name) : \Zend_Json_Server_Smd_Service

Set service name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Json_Server_Smd_Service

Throws

Exception	Description
\Zend_Json_Server_Exception

setOptions(array $options) : \Zend_Json_Server_Smd_Service

Set object state

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Json_Server_Smd_Service

setParams(array $params) : \Zend_Json_Server_Smd_Service

Overwrite all parameters

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Json_Server_Smd_Service

setReturn(string | array $type) : \Zend_Json_Server_Smd_Service

Set return type

Parameters

Name	Type	Description
$type	string \| array

Returns

Type	Description
\Zend_Json_Server_Smd_Service

setTarget(string $target) : \Zend_Json_Server_Smd_Service

Set service target

Parameters

Name	Type	Description
$target	string

Returns

Type	Description
\Zend_Json_Server_Smd_Service

setTransport(string $transport) : \Zend_Json_Server_Smd_Service

Set Transport

Currently limited to POST

Parameters

Name	Type	Description
$transport	string

Returns

Type	Description
\Zend_Json_Server_Smd_Service

toArray() : array

Cast service description to array

Returns

Type	Description
array

toJson() : string

Return JSON encoding of service

Returns

Type	Description
string

Json/Server/Smd/Service.php

\Zend_Json_Server_Smd_Servicejump to top

Properties

Methods

\Zend_Json_Server_Smd_Service
jump to top