Zend_Json_Server_Smd_Service Class Reference

Public Member Functions
	__construct ($spec)
	Constructor.
	setOptions (array $options)
	Set object state.
	setName ($name)
	Set service name.
	getName ()
	Retrieve name.
	setTransport ($transport)
	Set Transport.
	getTransport ()
	Get transport.
	setTarget ($target)
	Set service target.
	getTarget ()
	Get service target.
	setEnvelope ($envelopeType)
	Set envelope type.
	getEnvelope ()
	Get envelope type.
	addParam ($type, array $options=array(), $order=null)
	Add a parameter to the service.
	addParams (array $params)
	Add params.
	setParams (array $params)
	Overwrite all parameters.
	getParams ()
	Get all parameters.
	setReturn ($type)
	Set return type.
	getReturn ()
	Get return type.
	toArray ()
	Cast service description to array.
	toJson ()
	Return JSON encoding of service.
	__toString ()
	Cast to string.

Protected Member Functions
	_validateParamType ($type, $isReturn=false)
	Validate parameter type.

Protected Attributes
	$_envelope = Zend_Json_Server_Smd::ENV_JSONRPC_1
	$_name
	$_return
	$_target
	$_transport = 'POST'
	$_envelopeTypes
	$_nameRegex = '/^[a-z][a-z0-9._]+$/i'
	$_paramOptionTypes
	$_params = array()
	$_paramMap
	$_transportTypes

Constructor & Destructor Documentation

__construct

(

$spec

)

Constructor.

Parameters

string | array

$spec

Returns

void

Exceptions

Zend_Json_Server_Exception

if no name provided

Member Function Documentation

__toString

(

)

Cast to string.

Returns

string

_validateParamType (   $type,   $isReturn = false  )

protected

Validate parameter type.

Parameters

string

$type

Returns

true

Exceptions

Zend_Json_Server_Exception

addParam	(		$type,
		array	$options = array(),
			$order = null
	)

Add a parameter to the service.

Parameters

string | array	$type
array	$options
int | null	$order

Returns

Zend_Json_Server_Smd_Service

addParams

(

array

$params

)

Add params.

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

Parameters

array

$params

Returns

Zend_Json_Server_Smd_Service

getEnvelope

(

)

Get envelope type.

Returns

string

getName

(

)

Retrieve name.

Returns

string

getParams

(

)

Get all parameters.

Returns all params in specified order.

Returns

array

getReturn

(

)

Get return type.

Returns

string|array

getTarget

(

)

Get service target.

Returns

string

getTransport

(

)

Get transport.

Returns

string

setEnvelope

(

$envelopeType

)

Set envelope type.

Parameters

string

$envelopeType

Returns

Zend_Json_Server_Smd_Service

setName

(

$name

)

Set service name.

Parameters

string

$name

Returns

Zend_Json_Server_Smd_Service

Exceptions

Zend_Json_Server_Exception

setOptions

(

array

$options

)

Set object state.

Parameters

array

$options

Returns

Zend_Json_Server_Smd_Service

setParams

(

array

$params

)

Overwrite all parameters.

Parameters

array

$params

Returns

Zend_Json_Server_Smd_Service

setReturn

(

$type

)

Set return type.

Parameters

string | array

$type

Returns

Zend_Json_Server_Smd_Service

setTarget

(

$target

)

Set service target.

Parameters

string

$target

Returns

Zend_Json_Server_Smd_Service

setTransport

(

$transport

)

Set Transport.

Currently limited to POST

Parameters

string

$transport

Returns

Zend_Json_Server_Smd_Service

toArray

(

)

Cast service description to array.

Returns

array

toJson

(

)

Return JSON encoding of service.

Returns

string

Member Data Documentation

$_envelope = Zend_Json_Server_Smd::ENV_JSONRPC_1

protected

$_envelopeTypes

protected

Initial value:

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

$_name

protected

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

protected

$_paramMap

protected

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

$_paramOptionTypes

protected

Initial value:

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

$_params = array()

protected

$_return

protected

$_target

protected

$_transport = 'POST'

protected

$_transportTypes

protected

Initial value:

= array(
        'POST',
    )