Server/Abstract.php

Show:

inherited

Classes
- \Zend_Server_Abstract

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 license@zend.com 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_Server

\Zend_Server_Abstract
jump to top

Package: Zend\Server

Zend_Server_Abstract

Implements: \Zend_Server_Interface
Children: \Zend_XmlRpc_Server; \Zend_Json_Server
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 $

Properties

bool $_overwriteExistingMethods = false

Flag; whether or not overwriting existing methods is allowed

Default valuefalseDetails

Type: bool

\Zend_Server_Definition $_table

Details

Type: \Zend_Server_Definition

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

static

List of PHP magic methods (lowercased)

Default value

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

Details

Type: array
Deprecated

Methods

__construct() : void

Constructor

Setup server description

_buildCallback(\Zend_Server_Reflection_Function_Abstract $reflection) : \Zend_Server_Method_Callback

Build callback for method signature

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

Build a method signature

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

Dispatch method

Parameters

Name	Type	Description
$invocable	\Zend_Server_Method_Definition
$params	array

Returns

Type	Description
mixed

_fixType(string $type) : string

abstract

Map PHP type to protocol type

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
string

addFunction(string $function, string $namespace = '') : void

inherited

Attach a function as a server method

Inherited from: \Zend_Server_Interface::addFunction()

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

Parameters

Name	Type	Description
$function	string
$namespace	string

fault(mixed $fault = null, int $code = 404) : mixed

inherited

Generate a server fault

Inherited from: \Zend_Server_Interface::fault()

Parameters

Name	Type	Description
$fault	mixed
$code	int

Returns

Type	Description
mixed

getFunctions() : \Zend_Server_Definition

Returns a list of registered methods

Returns an array of method definitions.

Returns

Type	Description
\Zend_Server_Definition

handle(mixed $request = false) : mixed

inherited

Handle a request

Inherited from: \Zend_Server_Interface::handle()

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	mixed

Returns

Type	Description
mixed

loadFunctions( $definition) : void

inherited

Load server definition

Inherited from: \Zend_Server_Interface::loadFunctions()

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

Parameters

Name	Type	Description
$definition

lowerCase( $value, string $key) : string

static

Lowercase a string

Lowercase's a string by reference

Parameters

Name	Type	Description
$value
$key	string

Returns

Type	Description
string	Lower cased string

Details

Deprecated

setClass(mixed $class, string $namespace = '', null | array $argv = null) : void

inherited

Attach a class to a server

Inherited from: \Zend_Server_Interface::setClass()

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	mixed	Class name or object instance to examine and attach to the server.
$namespace	string	Optional namespace with which to prepend method names in the dispatch table. methods in the class will be valid callbacks.
$argv	null \| array	Optional array of arguments to pass to callbacks at dispatch.

setPersistence(int $mode) : void

inherited

Set server persistence

Inherited from: \Zend_Server_Interface::setPersistence()

Parameters

Name	Type	Description
$mode	int

Server/Abstract.php

\Zend_Server_Abstractjump to top

Properties

Methods

\Zend_Server_Abstract
jump to top