Json/Server/Smd/Service.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
Classes: Zend_Json_Server_Smd_Service

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_Smd_Service
jump to top

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: Service.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties: $_envelope; $_name; $_return; $_target; $_transport; $_envelopeTypes; $_nameRegex; $_paramOptionTypes; $_params; $_paramMap; $_transportTypes
Methods: __construct; setOptions; setName; getName; setTransport; getTransport; setTarget; getTarget; setEnvelope; getEnvelope; addParam; addParams; setParams; getParams; setReturn; getReturn; toArray; toJson; __toString; _validateParamType

Description

Create Service Mapping Description for a method

Properties

$_envelope
jump to class

$_envelope = 'Zend_Json_Server_Smd'

Details

visibility: protected
default: Zend_Json_Server_Smd
final: false
static: false

$_envelopeTypes
jump to class

array $_envelopeTypes = 'array'

Allowed envelope types

Details

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

$_name
jump to class

$_name = ''

Details

visibility: protected
default
final: false
static: false

$_nameRegex
jump to class

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

Regex for names

Details

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

$_paramMap
jump to class

array $_paramMap = 'array'

Mapping of parameter types to JSON-RPC types

Details

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

$_paramOptionTypes
jump to class

array $_paramOptionTypes = 'array'

Parameter option types

Details

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

$_params
jump to class

array $_params = 'array'

Service params

Details

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

$_return
jump to class

$_return = ''

Details

visibility: protected
default
final: false
static: false

$_target
jump to class

$_target = ''

Details

visibility: protected
default
final: false
static: false

$_transport
jump to class

$_transport = 'POST'

Details

visibility: protected
default: POST
final: false
static: false

$_transportTypes
jump to class

array $_transportTypes = 'array'

Allowed transport types

Details

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

Methods

__construct
jump to class

__construct(
          string|array $spec
          )
        
        :
        void

Constructor

Arguments

$spec: stringarray

Details

visibility: public
final: false
static: false
throws: if no name provided

__toString
jump to class

__toString(
          
          )
        
        :
        string

Cast to string

Output

string

Details

visibility: public
final: false
static: false

_validateParamType
jump to class

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

Validate parameter type

Arguments

$type: string
$isReturn

Output

true

Details

visibility: protected
final: false
static: false
throws

addParam
jump to class

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

Add a parameter to the service

Arguments

$type: stringarray
$options: array
$order: intnull

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

addParams
jump to class

addParams(
          array $params
          )
        
        :
        Zend_Json_Server_Smd_Service

Add params

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

Arguments

$params: array

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

getEnvelope
jump to class

getEnvelope(
          
          )
        
        :
        string

Get envelope type

Output

string

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        string

Retrieve name

Output

string

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Get all parameters

Returns all params in specified order.

Output

array

Details

visibility: public
final: false
static: false

getReturn
jump to class

getReturn(
          
          )
        
        :
        string|array

Get return type

Output

string|array

Details

visibility: public
final: false
static: false

getTarget
jump to class

getTarget(
          
          )
        
        :
        string

Get service target

Output

string

Details

visibility: public
final: false
static: false

getTransport
jump to class

getTransport(
          
          )
        
        :
        string

Get transport

Output

string

Details

visibility: public
final: false
static: false

setEnvelope
jump to class

setEnvelope(
          string $envelopeType
          )
        
        :
        Zend_Json_Server_Smd_Service

Set envelope type

Arguments

$envelopeType: string

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

setName
jump to class

setName(
          string $name
          )
        
        :
        Zend_Json_Server_Smd_Service

Set service name

Arguments

$name: string

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false
throws

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Json_Server_Smd_Service

Set object state

Arguments

$options: array

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          array $params
          )
        
        :
        Zend_Json_Server_Smd_Service

Overwrite all parameters

Arguments

$params: array

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

setReturn
jump to class

setReturn(
          string|array $type
          )
        
        :
        Zend_Json_Server_Smd_Service

Set return type

Arguments

$type: stringarray

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

setTarget
jump to class

setTarget(
          string $target
          )
        
        :
        Zend_Json_Server_Smd_Service

Set service target

Arguments

$target: string

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

setTransport
jump to class

setTransport(
          string $transport
          )
        
        :
        Zend_Json_Server_Smd_Service

Set Transport

Currently limited to POST

Arguments

$transport: string

Output

Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

toArray
jump to class

toArray(
          
          )
        
        :
        array

Cast service description to array

Output

array

Details

visibility: public
final: false
static: false

toJson
jump to class

toJson(
          
          )
        
        :
        string

Return JSON encoding of service

Output

string

Details

visibility: public
final: false
static: false

API Documentation

Json/Server/Smd/Service.php

Description

Zend_Json_Server_Smd_Servicejump to top

Description

Properties

$_envelopejump to class

Details

$_envelopeTypesjump to class

Details

$_namejump to class

Details

$_nameRegexjump to class

Details

$_paramMapjump to class

Details

$_paramOptionTypesjump to class

Details

$_paramsjump to class

Details

$_returnjump to class

Details

$_targetjump to class

Details

$_transportjump to class

Details

$_transportTypesjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_validateParamTypejump to class

Arguments

Output

Details

addParamjump to class

Arguments

Output

Details

addParamsjump to class

Arguments

Output

Details

getEnvelopejump to class

Output

Details

getNamejump to class

Output

Details

getParamsjump to class

Output

Details

getReturnjump to class

Output

Details

getTargetjump to class

Output

Details

getTransportjump to class

Output

Details

setEnvelopejump to class

Arguments

Output

Details

setNamejump to class

Arguments

Output

Details

setOptionsjump to class

Arguments

Output

Details

setParamsjump to class

Arguments

Output

Zend_Json_Server_Smd_Service
jump to top

$_envelope
jump to class

$_envelopeTypes
jump to class

$_name
jump to class

$_nameRegex
jump to class

$_paramMap
jump to class

$_paramOptionTypes
jump to class

$_params
jump to class

$_return
jump to class

$_target
jump to class

$_transport
jump to class

$_transportTypes
jump to class

__construct
jump to class

__toString
jump to class

_validateParamType
jump to class

addParam
jump to class

addParams
jump to class

getEnvelope
jump to class

getName
jump to class

getParams
jump to class

getReturn
jump to class

getTarget
jump to class

getTransport
jump to class

setEnvelope
jump to class

setName
jump to class

setOptions
jump to class

setParams
jump to class

setReturn
jump to class

setTarget
jump to class

setTransport
jump to class

toArray
jump to class

toJson
jump to class