Json/Server/Smd.php

Show:

inherited

Classes
- \Zend_Json_Server_Smd

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
Subpackage: Server
Version: $Id$

\Zend_Json_Server_Smd
jump to top

Package: Zend_Json\Server

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

Constants

 
                ENV_JSONRPC_1
                = 'JSON-RPC-1.0'

 
                ENV_JSONRPC_2
                = 'JSON-RPC-2.0'

 
                SMD_VERSION
                = '2.0'

Properties

string $_contentType = 'application/json'

Content type

Default value'application/json'Details

Type: string

string $_contentTypeRegex = '#[a-z]+/[a-z][a-z-]+#i'

Content type regex

Default value'#[a-z]+/[a-z][a-z-]+#i'Details

Type: string

string $_description

Service description

Details

Type: string

bool $_dojoCompatible = false

Generate Dojo-compatible SMD

Default valuefalseDetails

Type: bool

string $_envelope = self::ENV_JSONRPC_1

Current envelope

Default valueself::ENV_JSONRPC_1Details

Type: string

array $_envelopeTypes = array(self::ENV_JSONRPC_1, self::ENV_JSONRPC_2)

Allowed envelope types

Default valuearray(self::ENV_JSONRPC_1, self::ENV_JSONRPC_2)Details

Type: array

string $_id

Service id

Details

Type: string

array $_services = array()

Services offerred

Default valuearray()Details

Type: array

string $_target

Service target

Details

Type: string

string $_transport = 'POST'

Global transport

Default value'POST'Details

Type: string

array $_transportTypes = array('POST')

Allowed transport types

Default valuearray('POST')Details

Type: array

Methods

__toString() : string

Cast to string (JSON)

Returns

Type	Description
string

addService(\Zend_Json_Server_Smd_Service | array $service) : void

Add Service

Parameters

Name	Type	Description
$service	\Zend_Json_Server_Smd_Service \| array

addServices(array $services) : \Zend_Json_Server_Smd

Add many services

Parameters

Name	Type	Description
$services	array

Returns

Type	Description
\Zend_Json_Server_Smd

getContentType() : string

Retrieve content type

Returns

Type	Description
string

getDescription() : string

Get service description

Returns

Type	Description
string

getEnvelope() : string

Retrieve envelope

Returns

Type	Description
string

getId() : string

Get service id

Returns

Type	Description
string

getService(string $name) : false | \Zend_Json_Server_Smd_Service

Get service object

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| \Zend_Json_Server_Smd_Service

getServices() : array

Return services

Returns

Type	Description
array

getTarget() : string

Retrieve service target

Returns

Type	Description
string

getTransport() : string

Get transport

Returns

Type	Description
string

isDojoCompatible() : bool

Is this a Dojo compatible SMD?

Returns

Type	Description
bool

removeService(string $name) : boolean

Remove service

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

setContentType(string $type) : \Zend_Json_Server_Smd

Set content type

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Json_Server_Smd

setDescription(string $description) : \Zend_Json_Server_Smd

Set service description

Parameters

Name	Type	Description
$description	string

Returns

Type	Description
\Zend_Json_Server_Smd

setDojoCompatible(bool $flag) : \Zend_Json_Server_Smd

Indicate whether or not to generate Dojo-compatible SMD

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Json_Server_Smd

setEnvelope(string $envelopeType) : \Zend_Json_Server_Smd

Set envelope

Parameters

Name	Type	Description
$envelopeType	string

Returns

Type	Description
\Zend_Json_Server_Smd

setId( $id) : \Zend_Json_Server_Smd

Set service ID

Parameters

Name	Type	Description
$id

Returns

Type	Description
\Zend_Json_Server_Smd

setOptions(array $options) : \Zend_Json_Server_Smd

Set object state via options

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Json_Server_Smd

setServices(array $services) : \Zend_Json_Server_Smd

Overwrite existing services with new ones

Parameters

Name	Type	Description
$services	array

Returns

Type	Description
\Zend_Json_Server_Smd

setTarget(string $target) : \Zend_Json_Server_Smd

Set service target

Parameters

Name	Type	Description
$target	string

Returns

Type	Description
\Zend_Json_Server_Smd

setTransport(string $transport) : \Zend_Json_Server_Smd

Set transport

Parameters

Name	Type	Description
$transport	string

Returns

Type	Description
\Zend_Json_Server_Smd

toArray() : array

Cast to array

Returns

Type	Description
array

toDojoArray() : array

Export to DOJO-compatible SMD array

Returns

Type	Description
array

toJson() : string

Cast to JSON

Returns

Type	Description
string

Json/Server/Smd.php

\Zend_Json_Server_Smdjump to top

Constants

Properties

Methods

\Zend_Json_Server_Smd
jump to top