Zend_Json_Server Class Reference

Inheritance diagram for Zend_Json_Server:

Public Member Functions
	addFunction ($function, $namespace='')
	setClass ($class, $namespace='', $argv=null)
	fault ($fault=null, $code=404, $data=null)
	handle ($request=false)
	loadFunctions ($definition)
	setPersistence ($mode)
	setRequest (Zend_Json_Server_Request $request)
	getRequest ()
	setResponse (Zend_Json_Server_Response $response)
	getResponse ()
	setAutoEmitResponse ($flag)
	autoEmitResponse ()
	__call ($method, $args)
	getServiceMap ()
Public Member Functions inherited from Zend_Server_Abstract
	__construct ()
	getFunctions ()
Public Member Functions inherited from Zend_Server_Interface
	fault ($fault=null, $code=404)

Data Fields
const	VERSION_1 = '1.0'
const	VERSION_2 = '2.0'

Protected Member Functions
	_addMethodServiceMap (Zend_Server_Method_Definition $method)
	_fixType ($type)
	_getDefaultParams (array $args, array $params)
	_getParams (Zend_Server_Method_Definition $method)
	_getReadyResponse ()
	_getReturnType (Zend_Server_Method_Definition $method)
	_getSmdMethods ()
	_handle ()
Protected Member Functions inherited from Zend_Server_Abstract
	_buildCallback (Zend_Server_Reflection_Function_Abstract $reflection)
	_buildSignature (Zend_Server_Reflection_Function_Abstract $reflection, $class=null)
	_dispatch (Zend_Server_Method_Definition $invocable, array $params)
	_fixType ($type)

Protected Attributes
	$_autoEmitResponse = true
	$_overwriteExistingMethods = true
	$_request
	$_response
	$_serviceMap
	$_smdMethods
	$_table
Protected Attributes inherited from Zend_Server_Abstract
	$_overwriteExistingMethods = false
	$_table

Additional Inherited Members
Static Public Member Functions inherited from Zend_Server_Abstract
static	lowerCase (&$value, &$key)
Static Protected Attributes inherited from Zend_Server_Abstract
static	$magic_methods

Detailed Description

Definition at line 33 of file Server.php.

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Overload to accessors of SMD object

Parameters

string	$method
array	$args

Returns

mixed

Definition at line 311 of file Server.php.

    {
        if (preg_match('/^(set|get)/', $method, $matches)) {
            if (in_array($method, $this->_getSmdMethods())) {
                if ('set' == $matches[1]) {
                    $value = array_shift($args);
                    $this->getServiceMap()->$method($value);
                    return $this;
                } else {
                    return $this->getServiceMap()->$method();
                }
            }
        }
        return null;
    }

_addMethodServiceMap()

_addMethodServiceMap ( Zend_Server_Method_Definition  $method )

protected

Add service method to service map

Parameters

Zend_Server_Reflection_Function

$method

Returns

void

Definition at line 347 of file Server.php.

    {
        $serviceInfo = array(
            'name'   => $method->getName(),
            'return' => $this->_getReturnType($method),
        );
        $params = $this->_getParams($method);
        $serviceInfo['params'] = $params;
        $serviceMap = $this->getServiceMap();
        if (false !== $serviceMap->getService($serviceInfo['name'])) {
            $serviceMap->removeService($serviceInfo['name']);
        }
        $serviceMap->addService($serviceInfo);
    }

_fixType()

_fixType (   $type )

protected

Translate PHP type to JSON type

Parameters

string

$type

Returns

string

Definition at line 368 of file Server.php.

    {
        return $type;
    }

_getDefaultParams()

_getDefaultParams ( array  $args, array  $params  )

protected

Get default params from signature

Parameters

array	$args
array	$params

Returns

array

Definition at line 380 of file Server.php.

    {
        $defaultParams = array_slice($params, count($args));
        foreach ($defaultParams as $param) {
            $value = null;
            if (array_key_exists('default', $param)) {
                $value = $param['default'];
            }
            array_push($args, $value);
        }
        return $args;
    }

_getParams()

_getParams ( Zend_Server_Method_Definition  $method )

protected

Get method param type

Parameters

Zend_Server_Reflection_Function_Abstract

$method

Returns

string|array

Definition at line 399 of file Server.php.

    {
        $params = array();
        foreach ($method->getPrototypes() as $prototype) {
            foreach ($prototype->getParameterObjects() as $key => $parameter) {
                if (!isset($params[$key])) {
                    $params[$key] = array(
                        'type'     => $parameter->getType(),
                        'name'     => $parameter->getName(),
                        'optional' => $parameter->isOptional(),
                    );
                    if (null !== ($default = $parameter->getDefaultValue())) {
                        $params[$key]['default'] = $default;
                    }
                    $description = $parameter->getDescription();
                    if (!empty($description)) {
                        $params[$key]['description'] = $description;
                    }
                    continue;
                }
                $newType = $parameter->getType();
                if (!is_array($params[$key]['type'])) {
                    if ($params[$key]['type'] == $newType) {
                        continue;
                    }
                    $params[$key]['type'] = (array) $params[$key]['type'];
                } elseif (in_array($newType, $params[$key]['type'])) {
                    continue;
                }
                array_push($params[$key]['type'], $parameter->getType());
            }
        }
        return $params;
    }

_getReadyResponse()

_getReadyResponse ( )

protected

Set response state

Returns

Zend_Json_Server_Response

Definition at line 439 of file Server.php.

    {
        $request  = $this->getRequest();
        $response = $this->getResponse();

        $response->setServiceMap($this->getServiceMap());
        if (null !== ($id = $request->getId())) {
            $response->setId($id);
        }
        if (null !== ($version = $request->getVersion())) {
            $response->setVersion($version);
        }

        return $response;
    }

_getReturnType()

_getReturnType ( Zend_Server_Method_Definition  $method )

protected

Get method return type

Parameters

Zend_Server_Reflection_Function_Abstract

$method

Returns

string|array

Definition at line 461 of file Server.php.

    {
        $return = array();
        foreach ($method->getPrototypes() as $prototype) {
            $return[] = $prototype->getReturnType();
        }
        if (1 == count($return)) {
            return $return[0];
        }
        return $return;
    }

_getSmdMethods()

_getSmdMethods ( )

protected

Retrieve list of allowed SMD methods for proxying

Returns

array

Definition at line 478 of file Server.php.

    {
        if (null === $this->_smdMethods) {
            $this->_smdMethods = array();
            #require_once 'Zend/Json/Server/Smd.php';
            $methods = get_class_methods('Zend_Json_Server_Smd');
            foreach ($methods as $key => $method) {
                if (!preg_match('/^(set|get)/', $method)) {
                    continue;
                }
                if (strstr($method, 'Service')) {
                    continue;
                }
                $this->_smdMethods[] = $method;
            }
        }
        return $this->_smdMethods;
    }

_handle()

_handle ( )

protected

Internal method for handling request

Returns

void

Definition at line 502 of file Server.php.

    {
        $request = $this->getRequest();

        if (!$request->isMethodError() && (null === $request->getMethod())) {
            return $this->fault('Invalid Request', -32600);
        }

        if ($request->isMethodError()) {
            return $this->fault('Invalid Request', -32600);
        }

        $method = $request->getMethod();
        if (!$this->_table->hasMethod($method)) {
            return $this->fault('Method not found', -32601);
        }

        $params        = $request->getParams();
        $invocable     = $this->_table->getMethod($method);
        $serviceMap    = $this->getServiceMap();
        $service       = $serviceMap->getService($method);
        $serviceParams = $service->getParams();

        if (count($params) < count($serviceParams)) {
            $params = $this->_getDefaultParams($params, $serviceParams);
        }

        //Make sure named parameters are passed in correct order
        if ( is_string( key( $params ) ) ) {

            $callback = $invocable->getCallback();
            if ('function' == $callback->getType()) {
                $reflection = new ReflectionFunction( $callback->getFunction() );
                $refParams  = $reflection->getParameters();
            } else {

                $reflection = new ReflectionMethod(
                    $callback->getClass(),
                    $callback->getMethod()
                );
                $refParams = $reflection->getParameters();
            }

            $orderedParams = array();
            foreach( $reflection->getParameters() as $refParam ) {
                if( isset( $params[ $refParam->getName() ] ) ) {
                    $orderedParams[ $refParam->getName() ] = $params[ $refParam->getName() ];
                } elseif( $refParam->isOptional() ) {
                    $orderedParams[ $refParam->getName() ] = $refParam->getDefaultValue();
                } else {
                    throw new Zend_Server_Exception(
                        'Method ' . $request->getMethod() .  ' is missing required parameter: ' . $refParam->getName()
                    );
                }
            }
            $params = $orderedParams;
        }

        try {
            $result = $this->_dispatch($invocable, $params);
        } catch (Exception $e) {
            return $this->fault($e->getMessage(), $e->getCode(), $e);
        }

        $this->getResponse()->setResult($result);
    }

addFunction()

addFunction	(		$function,
			$namespace = ''
	)

Attach a function or callback to the server

Parameters

string | array	$function	Valid PHP callback
string	$namespace	Ignored

Returns

Zend_Json_Server

Implements Zend_Server_Interface.

Definition at line 89 of file Server.php.

    {
        if (!is_string($function) && (!is_array($function) || (2 > count($function)))) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Unable to attach function; invalid');
        }

        if (!is_callable($function)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Unable to attach function; does not exist');
        }

        $argv = null;
        if (2 < func_num_args()) {
            $argv = func_get_args();
            $argv = array_slice($argv, 2);
        }

        #require_once 'Zend/Server/Reflection.php';
        if (is_string($function)) {
            $method = Zend_Server_Reflection::reflectFunction($function, $argv, $namespace);
        } else {
            $class  = array_shift($function);
            $action = array_shift($function);
            $reflection = Zend_Server_Reflection::reflectClass($class, $argv, $namespace);
            $methods = $reflection->getMethods();
            $found   = false;
            foreach ($methods as $method) {
                if ($action == $method->getName()) {
                    $found = true;
                    break;
                }
            }
            if (!$found) {
                $this->fault('Method not found', -32601);
                return $this;
            }
        }

        $definition = $this->_buildSignature($method);
        $this->_addMethodServiceMap($definition);

        return $this;
    }

autoEmitResponse()

autoEmitResponse

(

)

Will we auto-emit the response?

Returns

bool

Definition at line 298 of file Server.php.

    {
        return $this->_autoEmitResponse;
    }

fault()

fault	(		$fault = null,
			$code = 404,
			$data = null
	)

Indicate fault response

Parameters

string	$fault
int	$code

Returns

false

Definition at line 167 of file Server.php.

    {
        #require_once 'Zend/Json/Server/Error.php';
        $error = new Zend_Json_Server_Error($fault, $code, $data);
        $this->getResponse()->setError($error);
        return $error;
    }

getRequest()

getRequest

(

)

Get JSON-RPC request object

Returns

Zend_Json_Server_Request

Definition at line 246 of file Server.php.

    {
        if (null === ($request = $this->_request)) {
            #require_once 'Zend/Json/Server/Request/Http.php';
            $this->setRequest(new Zend_Json_Server_Request_Http());
        }
        return $this->_request;
    }

getResponse()

getResponse

(

)

Get response object

Returns

Zend_Json_Server_Response

Definition at line 272 of file Server.php.

    {
        if (null === ($response = $this->_response)) {
            #require_once 'Zend/Json/Server/Response/Http.php';
            $this->setResponse(new Zend_Json_Server_Response_Http());
        }
        return $this->_response;
    }

getServiceMap()

getServiceMap

(

)

Retrieve SMD object

Returns

Zend_Json_Server_Smd

Definition at line 332 of file Server.php.

    {
        if (null === $this->_serviceMap) {
            #require_once 'Zend/Json/Server/Smd.php';
            $this->_serviceMap = new Zend_Json_Server_Smd();
        }
        return $this->_serviceMap;
    }

handle()

handle

(

$request = false

)

Handle request

Parameters

Zend_Json_Server_Request

$request

Returns

null|Zend_Json_Server_Response

Implements Zend_Server_Interface.

Definition at line 181 of file Server.php.

    {
        if ((false !== $request) && (!$request instanceof Zend_Json_Server_Request)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Invalid request type provided; cannot handle');
        } elseif ($request) {
            $this->setRequest($request);
        }

        // Handle request
        $this->_handle();

        // Get response
        $response = $this->_getReadyResponse();

        // Emit response?
        if ($this->autoEmitResponse()) {
            echo $response;
            return;
        }

        // or return it?
        return $response;
    }

loadFunctions()

loadFunctions

(

$definition

)

Load function definitions

Parameters

array | Zend_Server_Definition

$definition

Returns

void

Implements Zend_Server_Interface.

Definition at line 212 of file Server.php.

    {
        if (!is_array($definition) && (!$definition instanceof Zend_Server_Definition)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Invalid definition provided to loadFunctions()');
        }

        foreach ($definition as $key => $method) {
            $this->_table->addMethod($method, $key);
            $this->_addMethodServiceMap($method);
        }
    }

setAutoEmitResponse()

setAutoEmitResponse

(

$flag

)

Set flag indicating whether or not to auto-emit response

Parameters

bool

$flag

Returns

Zend_Json_Server

Definition at line 287 of file Server.php.

    {
        $this->_autoEmitResponse = (bool) $flag;
        return $this;
    }

setClass()

setClass	(		$class,
			$namespace = '',
			$argv = null
	)

Register a class with the server

Parameters

string	$class
string	$namespace	Ignored
mixed	$argv	Ignored

Returns

Zend_Json_Server

Implements Zend_Server_Interface.

Definition at line 142 of file Server.php.

    {
        $argv = null;
        if (3 < func_num_args()) {
            $argv = func_get_args();
            $argv = array_slice($argv, 3);
        }

        #require_once 'Zend/Server/Reflection.php';
        $reflection = Zend_Server_Reflection::reflectClass($class, $argv, $namespace);

        foreach ($reflection->getMethods() as $method) {
            $definition = $this->_buildSignature($method, $class);
            $this->_addMethodServiceMap($definition);
        }
        return $this;
    }

setPersistence()

setPersistence

(

$mode

)

Set server persistence

Todo:

Determine how to implement this

Parameters

int

$mode

Returns

void

Implements Zend_Server_Interface.

Definition at line 225 of file Server.php.

    {
    }

setRequest()

setRequest

(

Zend_Json_Server_Request

$request

)

Set request object

Parameters

Zend_Json_Server_Request

$request

Returns

Zend_Json_Server

Definition at line 235 of file Server.php.

    {
        $this->_request = $request;
        return $this;
    }

setResponse()

setResponse

(

Zend_Json_Server_Response

$response

)

Set response object

Parameters

Zend_Json_Server_Response

$response

Returns

Zend_Json_Server

Definition at line 261 of file Server.php.

    {
        $this->_response = $response;
        return $this;
    }

Field Documentation

$_autoEmitResponse

$_autoEmitResponse = true

protected

Definition at line 46 of file Server.php.

$_overwriteExistingMethods

$_overwriteExistingMethods = true

protected

Definition at line 51 of file Server.php.

$_request

$_request

protected

Definition at line 57 of file Server.php.

$_response

$_response

protected

Definition at line 63 of file Server.php.

$_serviceMap

$_serviceMap

protected

Definition at line 69 of file Server.php.

$_smdMethods

$_smdMethods

protected

Definition at line 75 of file Server.php.

$_table

$_table

protected

Definition at line 80 of file Server.php.

VERSION_1

const VERSION_1 = '1.0'

#+ Version Constants

Definition at line 38 of file Server.php.

VERSION_2

const VERSION_2 = '2.0'

Definition at line 39 of file Server.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Json/Server.php