Zend_Server_Abstract

category Zend
package Zend_Json
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Server_Abstract

 Methods

Overload to accessors of SMD object

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

Parameters

$method

string

$args

array

Returns

mixed

Constructor

__construct() : void
Inherited

Setup server description

Attach a function or callback to the server

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

Parameters

$function

stringarray

Valid PHP callback

$namespace

string

Ignored

Returns

\Zend_Json_Server

Will we auto-emit the response?

autoEmitResponse() : boolean

Returns

boolean

Indicate fault response

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

Parameters

$fault

string

$code

integer

$data

Returns

false

Returns a list of registered methods

getFunctions() : \Zend_Server_Definition
Inherited

Returns an array of method definitions.

inherited_from \Zend_Server_Interface::getFunctions()

Returns

\Zend_Server_Definition

Get JSON-RPC request object

getRequest() : \Zend_Json_Server_Request

Returns

\Zend_Json_Server_Request

Get response object

getResponse() : \Zend_Json_Server_Response

Returns

\Zend_Json_Server_Response

Retrieve SMD object

getServiceMap() : \Zend_Json_Server_Smd

Returns

\Zend_Json_Server_Smd

Handle request

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

Parameters

$request

\Zend_Json_Server_Request

Returns

null\Zend_Json_Server_Response

Load function definitions

loadFunctions(array|\Zend_Server_Definition $definition) : void

Parameters

$definition

array\Zend_Server_Definition

Lowercase a string

lowerCase($value, string $key) : string
InheritedStatic

Lowercase's a string by reference

deprecated

Parameters

$value

$key

string

Returns

stringLower cased string

Set flag indicating whether or not to auto-emit response

setAutoEmitResponse(boolean $flag) : \Zend_Json_Server

Parameters

$flag

boolean

Returns

\Zend_Json_Server

Register a class with the server

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

Parameters

$class

string

$namespace

string

Ignored

$argv

mixed

Ignored

Returns

\Zend_Json_Server

setPersistence()

setPersistence($mode) 

Parameters

$mode

Set request object

setRequest(\Zend_Json_Server_Request $request) : \Zend_Json_Server

Parameters

$request

\Zend_Json_Server_Request

Returns

\Zend_Json_Server

Set response object

setResponse(\Zend_Json_Server_Response $response) : \Zend_Json_Server

Parameters

$response

\Zend_Json_Server_Response

Returns

\Zend_Json_Server

Add service method to service map

_addMethodServiceMap(\Zend_Server_Reflection_Function $method) : void

Parameters

$method

\Zend_Server_Reflection_Function

Build callback for method signature

_buildCallback(\Zend_Server_Reflection_Function_Abstract $reflection) : \Zend_Server_Method_Callback
Inherited

Parameters

$reflection

\Zend_Server_Reflection_Function_Abstract

Returns

\Zend_Server_Method_Callback

Build a method signature

_buildSignature(\Zend_Server_Reflection_Function_Abstract $reflection, null|string|object $class = null) : \Zend_Server_Method_Definition
Inherited

Parameters

$reflection

\Zend_Server_Reflection_Function_Abstract

$class

nullstringobject

Exceptions

\Zend_Server_Exception on duplicate entry

Returns

\Zend_Server_Method_Definition

Dispatch method

_dispatch(\Zend_Server_Method_Definition $invocable, array $params) : mixed
Inherited

Parameters

$invocable

\Zend_Server_Method_Definition

$params

array

Returns

mixed

Translate PHP type to JSON type

_fixType(string $type) : string
inherited_from \Zend_Server_Abstract::_fixType()

Parameters

$type

string

Returns

string

Map PHP type to protocol type

_fixType(string $type) : string
Inherited

Parameters

$type

string

Returns

string

Get default params from signature

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

Parameters

$args

array

$params

array

Returns

array

Get method param type

_getParams(\Zend_Server_Reflection_Function_Abstract $method) : string | array

Parameters

$method

\Zend_Server_Reflection_Function_Abstract

Returns

stringarray

Set response state

_getReadyResponse() : \Zend_Json_Server_Response

Returns

\Zend_Json_Server_Response

Get method return type

_getReturnType(\Zend_Server_Reflection_Function_Abstract $method) : string | array

Parameters

$method

\Zend_Server_Reflection_Function_Abstract

Returns

stringarray

Retrieve list of allowed SMD methods for proxying

_getSmdMethods() : array

Returns

array

Internal method for handling request

_handle() : void

 Properties

 

Flag: whether or not to auto-emit the response

$_autoEmitResponse : boolean

Default

true
 

Flag; allow overwriting existing methods when creating server definition

$_overwriteExistingMethods : boolean

Default

true
inherited_from \Zend_Server_Abstract::_overwriteExistingMethods
 

Flag; whether or not overwriting existing methods is allowed

$_overwriteExistingMethods : boolean

Default

false
 

Request object

$_request : \Zend_Json_Server_Request

Default

 

Response object

$_response : \Zend_Json_Server_Response

Default

 

SMD object

$_serviceMap : \Zend_Json_Server_Smd

Default

 

SMD class accessors

$_smdMethods : array

Default

 

$_table

$_table : \Zend_Server_Description

Default

inherited_from \Zend_Server_Abstract::_table
 

$_table

$_table : \Zend_Server_Definition

Default

 

List of PHP magic methods (lowercased)

$magic_methods : array

Default

array('__call', '__clone', '__construct', '__destruct', '__get', '__isset', '__set', '__set_state', '__sleep', '__tostring', '__unset', '__wakeup')
Static
deprecated

 Constants

 

VERSION_1

VERSION_1 = '1.0' 
 

VERSION_2

VERSION_2 = '2.0'