API Documentation

Server/Interface.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Server  

\Zend_Server_Interface

Zend_Server_Interface

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Server  
version
$Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $  

Methods

methodpublicaddFunction( string $function, string $namespace ) : void

Attach a function as a server method

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

Parameters
Name Type Description
$function string
$namespace string
methodpublicfault( mixed $fault = null, int $code = 404 ) : mixed

Generate a server fault

Parameters
Name Type Description
$fault mixed
$code int
Returns
Type Description
mixed
methodpublicgetFunctions( ) : array

Return a server definition array

Returns a server definition array as created using {@link * Zend_Server_Reflection}. Can be used for server introspection, documentation, or persistence.

Returns
Type Description
array
Details
access
public  
methodpublichandle( mixed $request = false ) : mixed

Handle a 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 mixed
Returns
Type Description
mixed
methodpublicloadFunctions(  $definition ) : void

Load server definition

Used for persistence; loads a construct as returned by {@link getFunctions()}.

Parameters
Name Type Description
$definition
methodpublicsetClass( mixed $class, string $namespace, null|array $argv = null ) : void

Attach a class to a 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 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.
methodpublicsetPersistence( int $mode ) : void

Set server persistence

Parameters
Name Type Description
$mode int
Details
todo
Determine how to implement this  
Documentation was generated by DocBlox 0.13.3.