Json/Server/Smd.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
subpackage: Server
version: $Id: Smd.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Json_Server_Smd

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

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
subpackage: Server
Constants: ENV_JSONRPC_1; ENV_JSONRPC_2; SMD_VERSION
Properties: $_contentType; $_contentTypeRegex; $_description; $_dojoCompatible; $_envelope; $_envelopeTypes; $_id; $_services; $_target; $_transport; $_transportTypes
Methods: setOptions; setTransport; getTransport; setEnvelope; getEnvelope; setContentType; getContentType; setTarget; getTarget; setId; getId; setDescription; getDescription; setDojoCompatible; isDojoCompatible; addService; addServices; setServices; getService; getServices; removeService; toArray; toDojoArray; toJson; __toString

Description

Constants

ENV_JSONRPC_1
jump to class

 ENV_JSONRPC_1 = 'JSON-RPC-1.0'

Details

value: JSON-RPC-1.0

ENV_JSONRPC_2
jump to class

 ENV_JSONRPC_2 = 'JSON-RPC-2.0'

Details

value: JSON-RPC-2.0

SMD_VERSION
jump to class

 SMD_VERSION = '2.0'

Details

value: 2.0

Properties

$_contentType
jump to class

string $_contentType = 'application/json'

Content type

Details

$_contentType: string
visibility: protected
default: application/json
final: false
static: false

$_contentTypeRegex
jump to class

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

Content type regex

Details

$_contentTypeRegex: string
visibility: protected
default: #[a-z]+/[a-z][a-z-]+#i
final: false
static: false

$_description
jump to class

string $_description = ''

Service description

Details

$_description: string
visibility: protected
default
final: false
static: false

$_dojoCompatible
jump to class

bool $_dojoCompatible = 'false'

Generate Dojo-compatible SMD

Details

$_dojoCompatible: bool
visibility: protected
default: false
final: false
static: false

$_envelope
jump to class

string $_envelope = 'self'

Current envelope

Details

$_envelope: string
visibility: protected
default: self
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

$_id
jump to class

string $_id = ''

Service id

Details

$_id: string
visibility: protected
default
final: false
static: false

$_services
jump to class

array $_services = 'array'

Services offerred

Details

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

$_target
jump to class

string $_target = ''

Service target

Details

$_target: string
visibility: protected
default
final: false
static: false

$_transport
jump to class

string $_transport = 'POST'

Global transport

Details

$_transport: string
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

__toString
jump to class

__toString(
          
          )
        
        :
        string

Cast to string (JSON)

Output

string

Details

visibility: public
final: false
static: false

addService
jump to class

addService(
          Zend_Json_Server_Smd_Service|array $service
          )
        
        :
        void

Add Service

Arguments

$service: Zend_Json_Server_Smd_Servicearray

Details

visibility: public
final: false
static: false

addServices
jump to class

addServices(
          array $services
          )
        
        :
        Zend_Json_Server_Smd

Add many services

Arguments

$services: array

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

getContentType
jump to class

getContentType(
          
          )
        
        :
        string

Retrieve content type

Output

string

Details

visibility: public
final: false
static: false

getDescription
jump to class

getDescription(
          
          )
        
        :
        string

Get service description

Output

string

Details

visibility: public
final: false
static: false

getEnvelope
jump to class

getEnvelope(
          
          )
        
        :
        string

Retrieve envelope

Output

string

Details

visibility: public
final: false
static: false

getId
jump to class

getId(
          
          )
        
        :
        string

Get service id

Output

string

Details

visibility: public
final: false
static: false

getService
jump to class

getService(
          string $name
          )
        
        :
        false|Zend_Json_Server_Smd_Service

Get service object

Arguments

$name: string

Output

false|Zend_Json_Server_Smd_Service

Details

visibility: public
final: false
static: false

getServices
jump to class

getServices(
          
          )
        
        :
        array

Return services

Output

array

Details

visibility: public
final: false
static: false

getTarget
jump to class

getTarget(
          
          )
        
        :
        string

Retrieve 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

isDojoCompatible
jump to class

isDojoCompatible(
          
          )
        
        :
        bool

Is this a Dojo compatible SMD?

Output

bool

Details

visibility: public
final: false
static: false

removeService
jump to class

removeService(
          string $name
          )
        
        :
        boolean

Remove service

Arguments

$name: string

Output

boolean

Details

visibility: public
final: false
static: false

setContentType
jump to class

setContentType(
          string $type
          )
        
        :
        Zend_Json_Server_Smd

Set content type

Arguments

$type: string

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setDescription
jump to class

setDescription(
          string $description
          )
        
        :
        Zend_Json_Server_Smd

Set service description

Arguments

$description: string

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setDojoCompatible
jump to class

setDojoCompatible(
          bool $flag
          )
        
        :
        Zend_Json_Server_Smd

Indicate whether or not to generate Dojo-compatible SMD

Arguments

$flag: bool

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setEnvelope
jump to class

setEnvelope(
          string $envelopeType
          )
        
        :
        Zend_Json_Server_Smd

Set envelope

Arguments

$envelopeType: string

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setId
jump to class

setId(
           $id
          )
        
        :
        Zend_Json_Server_Smd

Set service ID

Arguments

$id

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Json_Server_Smd

Set object state via options

Arguments

$options: array

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setServices
jump to class

setServices(
          array $services
          )
        
        :
        Zend_Json_Server_Smd

Overwrite existing services with new ones

Arguments

$services: array

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setTarget
jump to class

setTarget(
          string $target
          )
        
        :
        Zend_Json_Server_Smd

Set service target

Arguments

$target: string

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

setTransport
jump to class

setTransport(
          string $transport
          )
        
        :
        Zend_Json_Server_Smd

Set transport

Arguments

$transport: string

Output

Zend_Json_Server_Smd

Details

visibility: public
final: false
static: false

toArray
jump to class

toArray(
          
          )
        
        :
        array

Cast to array

Output

array

Details

visibility: public
final: false
static: false

toDojoArray
jump to class

toDojoArray(
          
          )
        
        :
        array

Export to DOJO-compatible SMD array

Output

array

Details

visibility: public
final: false
static: false

toJson
jump to class

toJson(
          
          )
        
        :
        string

Cast to JSON

Output

string

Details

visibility: public
final: false
static: false

API Documentation

Json/Server/Smd.php

Description

Zend_Json_Server_Smdjump to top

Description

Constants

ENV_JSONRPC_1jump to class

Details

ENV_JSONRPC_2jump to class

Details

SMD_VERSIONjump to class

Details

Properties

$_contentTypejump to class

Details

$_contentTypeRegexjump to class

Details

$_descriptionjump to class

Details

$_dojoCompatiblejump to class

Details

$_envelopejump to class

Details

$_envelopeTypesjump to class

Details

$_idjump to class

Details

$_servicesjump to class

Details

$_targetjump to class

Details

$_transportjump to class

Details

$_transportTypesjump to class

Details

Methods

__toStringjump to class

Output

Details

addServicejump to class

Arguments

Details

addServicesjump to class

Arguments

Output

Details

getContentTypejump to class

Output

Details

getDescriptionjump to class

Output

Details

getEnvelopejump to class

Output

Details

getIdjump to class

Output

Details

getServicejump to class

Arguments

Output

Details

getServicesjump to class

Output

Details

getTargetjump to class

Output

Details

getTransportjump to class

Output

Details

isDojoCompatiblejump to class

Output

Details

removeServicejump to class

Arguments

Output

Details

setContentTypejump to class

Arguments

Zend_Json_Server_Smd
jump to top

ENV_JSONRPC_1
jump to class

ENV_JSONRPC_2
jump to class

SMD_VERSION
jump to class

$_contentType
jump to class

$_contentTypeRegex
jump to class

$_description
jump to class

$_dojoCompatible
jump to class

$_envelope
jump to class

$_envelopeTypes
jump to class

$_id
jump to class

$_services
jump to class

$_target
jump to class

$_transport
jump to class

$_transportTypes
jump to class

__toString
jump to class

addService
jump to class

addServices
jump to class

getContentType
jump to class

getDescription
jump to class

getEnvelope
jump to class

getId
jump to class

getService
jump to class

getServices
jump to class

getTarget
jump to class

getTransport
jump to class

isDojoCompatible
jump to class

removeService
jump to class

setContentType
jump to class

setDescription
jump to class

setDojoCompatible
jump to class

setEnvelope
jump to class

setId
jump to class

setOptions
jump to class

setServices
jump to class

setTarget
jump to class

setTransport
jump to class

toArray
jump to class

toDojoArray
jump to class

toJson
jump to class