API Documentation

Json/Server.php

Includes Classes 
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
version
$Id: Server.php 22276 2010-05-24 18:31:59Z andyfowler $
Classes
Zend_Json_Server

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

Extends from
Zend_Server_Abstract
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
Constants
VERSION_1
VERSION_2
Properties
$_autoEmitResponse
$_overwriteExistingMethods
$_request
$_response
$_serviceMap
$_smdMethods
$_table
Methods
addFunction
setClass
fault
handle
loadFunctions
setPersistence
setRequest
getRequest
setResponse
getResponse
setAutoEmitResponse
autoEmitResponse
__call
getServiceMap
_addMethodServiceMap
_fixType
_getDefaultParams
_getParams
_getReadyResponse
_getReturnType
_getSmdMethods
_handle

Description

Constants

VERSION_1
jump to class

 VERSION_1 = '1.0'

Details

value
1.0

VERSION_2
jump to class

 VERSION_2 = '2.0'

Details

value
2.0

Properties

$_autoEmitResponse
jump to class

bool $_autoEmitResponse = 'true'

Flag: whether or not to auto-emit the response

Details

$_autoEmitResponse
bool
visibility
protected
default
true
final
false
static
false

$_overwriteExistingMethods
jump to class

bool $_overwriteExistingMethods = 'true'

Details

$_overwriteExistingMethods
bool
Flag; allow overwriting existing methods when creating server definition
visibility
protected
default
true
final
false
static
false

$_request
jump to class

Zend_Json_Server_Request $_request = ''

Request object

Details

$_request
Zend_Json_Server_Request
visibility
protected
default
final
false
static
false

$_response
jump to class

Zend_Json_Server_Response $_response = ''

Response object

Details

$_response
Zend_Json_Server_Response
visibility
protected
default
final
false
static
false

$_serviceMap
jump to class

Zend_Json_Server_Smd $_serviceMap = ''

SMD object

Details

$_serviceMap
Zend_Json_Server_Smd
visibility
protected
default
final
false
static
false

$_smdMethods
jump to class

array $_smdMethods = ''

SMD class accessors

Details

$_smdMethods
array
visibility
protected
default
final
false
static
false

$_table
jump to class

Zend_Server_Description $_table = ''

Details

$_table
Zend_Server_Description
visibility
protected
default
final
false
static
false

Methods

__call
jump to class

__call( string $method, array $args ) : mixed

Overload to accessors of SMD object

Arguments
$method
string
$args
array
Output
mixed
Details
visibility
public
final
false
static
false

_addMethodServiceMap
jump to class

_addMethodServiceMap( Zend_Server_Reflection_Function $method ) : void

Add service method to service map

Arguments
$method
Zend_Server_Reflection_Function
Details
visibility
protected
final
false
static
false

_fixType
jump to class

_fixType( string $type ) : string

Translate PHP type to JSON type

Arguments
$type
string
Output
string
Details
visibility
protected
final
false
static
false

_getDefaultParams
jump to class

_getDefaultParams( array $args, array $params ) : array

Get default params from signature

Arguments
$args
array
$params
array
Output
array
Details
visibility
protected
final
false
static
false

_getParams
jump to class

_getParams( Zend_Server_Reflection_Function_Abstract $method ) : string|array

Get method param type

Arguments
$method
Zend_Server_Reflection_Function_Abstract
Output
string|array
Details
visibility
protected
final
false
static
false

_getReadyResponse
jump to class

_getReadyResponse( ) : Zend_Json_Server_Response

Set response state

Output
Zend_Json_Server_Response
Details
visibility
protected
final
false
static
false

_getReturnType
jump to class

_getReturnType( Zend_Server_Reflection_Function_Abstract $method ) : string|array

Get method return type

Arguments
$method
Zend_Server_Reflection_Function_Abstract
Output
string|array
Details
visibility
protected
final
false
static
false

_getSmdMethods
jump to class

_getSmdMethods( ) : array

Retrieve list of allowed SMD methods for proxying

Output
array
Details
visibility
protected
final
false
static
false

_handle
jump to class

_handle( ) : void

Internal method for handling request

Details
visibility
protected
final
false
static
false

addFunction
jump to class

addFunction( string|array $function, string $namespace ) : Zend_Json_Server

Attach a function or callback to the server

Arguments
$function
stringarray
Valid PHP callback
$namespace
string
Ignored
Output
Zend_Json_Server
Details
visibility
public
final
false
static
false

autoEmitResponse
jump to class

autoEmitResponse( ) : bool

Will we auto-emit the response?

Output
bool
Details
visibility
public
final
false
static
false

fault
jump to class

fault( string $fault = null, int $code = 404,  $data = null ) : false

Indicate fault response

Arguments
$fault
string
$code
int
$data
Output
false
Details
visibility
public
final
false
static
false

getRequest
jump to class

getRequest( ) : Zend_Json_Server_Request

Get JSON-RPC request object

Output
Zend_Json_Server_Request
Details
visibility
public
final
false
static
false

getResponse
jump to class

getResponse( ) : Zend_Json_Server_Response

Get response object

Output
Zend_Json_Server_Response
Details
visibility
public
final
false
static
false

getServiceMap
jump to class

getServiceMap( ) : Zend_Json_Server_Smd

Retrieve SMD object

Output
Zend_Json_Server_Smd
Details
visibility
public
final
false
static
false

handle
jump to class

handle( Zend_Json_Server_Request $request = false ) : null|Zend_Json_Server_Response

Handle request

Arguments
$request
Zend_Json_Server_Request
Output
null|Zend_Json_Server_Response
Details
visibility
public
final
false
static
false

loadFunctions
jump to class

loadFunctions( array|Zend_Server_Definition $definition ) : void

Load function definitions

Arguments
$definition
arrayZend_Server_Definition
Details
visibility
public
final
false
static
false

setAutoEmitResponse
jump to class

setAutoEmitResponse( bool $flag ) : Zend_Json_Server

Set flag indicating whether or not to auto-emit response

Arguments
$flag
bool
Output
Zend_Json_Server
Details
visibility
public
final
false
static
false

setClass
jump to class

setClass( string $class, string $namespace, mixed $argv = null ) : Zend_Json_Server

Register a class with the server

Arguments
$class
string
$namespace
string
Ignored
$argv
mixed
Ignored
Output
Zend_Json_Server
Details
visibility
public
final
false
static
false

setPersistence
jump to class

setPersistence(  $mode ) :
Arguments
$mode
Details
visibility
public
final
false
static
false

setRequest
jump to class

setRequest( Zend_Json_Server_Request $request ) : Zend_Json_Server

Set request object

Arguments
$request
Zend_Json_Server_Request
Output
Zend_Json_Server
Details
visibility
public
final
false
static
false

setResponse
jump to class

setResponse( Zend_Json_Server_Response $response ) : Zend_Json_Server

Set response object

Arguments
$response
Zend_Json_Server_Response
Output
Zend_Json_Server
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.