Json/Server.php

Show:

inherited

Classes
- \Zend_Json_Server

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Json
Version: $Id: Server.php 25085 2012-11-06 21:11:41Z rob $

\Zend_Json_Server
jump to top

Package: Zend\Json

Zend_Server_Abstract

Parent(s): \Zend_Server_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                VERSION_1
                = '1.0'

 
                VERSION_2
                = '2.0'

Properties

bool $_autoEmitResponse = true

Flag: whether or not to auto-emit the response

Default valuetrueDetails

Type: bool

bool $_overwriteExistingMethods = true

<p>Flag; allow overwriting existing methods when creating server definition</p>

Default valuetrueDetails

Type: bool

\Zend_Json_Server_Request $_request =

Request object

Details

Type: \Zend_Json_Server_Request

\Zend_Json_Server_Response $_response =

Response object

Details

Type: \Zend_Json_Server_Response

\Zend_Json_Server_Smd $_serviceMap =

SMD object

Details

Type: \Zend_Json_Server_Smd

array $_smdMethods =

SMD class accessors

Details

Type: array

\Zend_Server_Description $_table =

Details

Type: \Zend_Server_Description

array $magic_methods = array('__call', '__clone', '__construct', '__destruct', '__get', '__isset', '__set', '__set_state', '__sleep', '__tostring', '__unset', '__wakeup')

staticinherited

<p>List of PHP magic methods (lowercased)</p> Inherited from: \Zend_Server_Abstract::$$magic_methods

Default value

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

Details

Type: array
Inherited_from: \Zend_Server_Abstract::$$magic_methods

Methods

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

Overload to accessors of SMD object

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

__construct() : void

inherited

Constructor

Inherited from: \Zend_Server_Abstract::__construct()

Setup server description

_addMethodServiceMap(\Zend_Server_Reflection_Function $method) : void

Add service method to service map

Parameters

Name	Type	Description
$method	\Zend_Server_Reflection_Function

_buildCallback(\Zend_Server_Reflection_Function_Abstract $reflection) : \Zend_Server_Method_Callback

inherited

Build callback for method signature

Inherited from: \Zend_Server_Abstract::_buildCallback()

Parameters

Name	Type	Description
$reflection	\Zend_Server_Reflection_Function_Abstract

Returns

Type	Description
\Zend_Server_Method_Callback

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

inherited

Build a method signature

Inherited from: \Zend_Server_Abstract::_buildSignature()

Parameters

Name	Type	Description
$reflection	\Zend_Server_Reflection_Function_Abstract
$class	null \| string \| object

Returns

Type	Description
\Zend_Server_Method_Definition

Throws

Exception	Description
\Zend_Server_Exception	on duplicate entry

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

inherited

Dispatch method

Inherited from: \Zend_Server_Abstract::_dispatch()

Parameters

Name	Type	Description
$invocable	\Zend_Server_Method_Definition
$params	array

Returns

Type	Description
mixed

_fixType(string $type) : string

Translate PHP type to JSON type

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
string

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

Get default params from signature

Parameters

Name	Type	Description
$args	array
$params	array

Returns

Type	Description
array

_getParams(\Zend_Server_Reflection_Function_Abstract $method) : string | array

Get method param type

Parameters

Name	Type	Description
$method	\Zend_Server_Reflection_Function_Abstract

Returns

Type	Description
string \| array

_getReadyResponse() : \Zend_Json_Server_Response

Set response state

Returns

Type	Description
\Zend_Json_Server_Response

_getReturnType(\Zend_Server_Reflection_Function_Abstract $method) : string | array

Get method return type

Parameters

Name	Type	Description
$method	\Zend_Server_Reflection_Function_Abstract

Returns

Type	Description
string \| array

_getSmdMethods() : array

Retrieve list of allowed SMD methods for proxying

Returns

Type	Description
array

_handle() : void

Internal method for handling request

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

Attach a function or callback to the server

Namespacing is primarily for xmlrpc, but may be used with other implementations to prevent naming collisions.

Parameters

Name	Type	Description
$function	string \| array	Valid PHP callback
$namespace	string	Ignored

Returns

Type	Description
\Zend_Json_Server

autoEmitResponse() : bool

Will we auto-emit the response?

Returns

Type	Description
bool

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

Indicate fault response

Parameters

Name	Type	Description
$fault	string
$code	int
$data

Returns

Type	Description
false

getFunctions() : \Zend_Server_Definition

inherited

Returns a list of registered methods

Inherited from: \Zend_Server_Abstract::getFunctions()

Returns an array of method definitions.

Returns

Type	Description
\Zend_Server_Definition

getRequest() : \Zend_Json_Server_Request

Get JSON-RPC request object

Returns

Type	Description
\Zend_Json_Server_Request

getResponse() : \Zend_Json_Server_Response

Get response object

Returns

Type	Description
\Zend_Json_Server_Response

getServiceMap() : \Zend_Json_Server_Smd

Retrieve SMD object

Returns

Type	Description
\Zend_Json_Server_Smd

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

Handle request

Requests may be passed in, or the server may automagically determine the request based on defaults. Dispatches server request to appropriate method and returns a response

Parameters

Name	Type	Description
$request	\Zend_Json_Server_Request

Returns

Type	Description
null \| \Zend_Json_Server_Response

loadFunctions(array | \Zend_Server_Definition $definition) : void

Load function definitions

Used for persistence; loads a construct as returned by getFunctions().

Parameters

Name	Type	Description
$definition	array \| \Zend_Server_Definition

lowerCase( $value, string $key) : string

staticinherited

Lowercase a string

Inherited from: \Zend_Server_Abstract::lowerCase()

Lowercase's a string by reference

Parameters

Name	Type	Description
$value
$key	string

Returns

Type	Description
string	Lower cased string

setAutoEmitResponse(bool $flag) : \Zend_Json_Server

Set flag indicating whether or not to auto-emit response

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Json_Server

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

The individual implementations should probably allow passing a variable number of arguments in, so that developers may define custom runtime arguments to pass to server methods.

Namespacing is primarily for xmlrpc, but could be used for other implementations as well.

Parameters

Name	Type	Description
$class	string
$namespace	string	Ignored
$argv	mixed	Ignored

Returns

Type	Description
\Zend_Json_Server

setPersistence(int $mode) : void

Set server persistence

Parameters

Name	Type	Description
$mode	int

setRequest(\Zend_Json_Server_Request $request) : \Zend_Json_Server

Set request object

Parameters

Name	Type	Description
$request	\Zend_Json_Server_Request

Returns

Type	Description
\Zend_Json_Server

setResponse(\Zend_Json_Server_Response $response) : \Zend_Json_Server

Set response object

Parameters

Name	Type	Description
$response	\Zend_Json_Server_Response

Returns

Type	Description
\Zend_Json_Server

Json/Server.php

\Zend_Json_Serverjump to top

Constants

Properties

Methods

\Zend_Json_Server
jump to top