97 lines
2.6 KiB
PHP
97 lines
2.6 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Rest_Interface
|
||
|
|
* These are all public functions that implemented in the
|
||
|
|
* Rest Interface
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
interface Rest_Interface
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Attach a function as a server method
|
||
|
|
*
|
||
|
|
* Namespacing is primarily for xmlrpc, but may be used with other
|
||
|
|
* implementations to prevent naming collisions.
|
||
|
|
*
|
||
|
|
* @param string $function
|
||
|
|
* @param string $namespace
|
||
|
|
* @param null|array Optional array of arguments to pass to callbacks at
|
||
|
|
* dispatch.
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function addFunction($function, $namespace = '');
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
*
|
||
|
|
* @param mixed $class Class name or object instance to examine and attach
|
||
|
|
* to the server.
|
||
|
|
* @param string $namespace Optional namespace with which to prepend method
|
||
|
|
* names in the dispatch table.
|
||
|
|
* methods in the class will be valid callbacks.
|
||
|
|
* @param null|array Optional array of arguments to pass to callbacks at
|
||
|
|
* dispatch.
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function setClass($class, $namespace = '', $argv = null);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Generate a server fault
|
||
|
|
*
|
||
|
|
* @param mixed $fault
|
||
|
|
* @param int $code
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function fault($fault = null, $code = 404);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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
|
||
|
|
*
|
||
|
|
* @param mixed $request
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function handle($request = false);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return a server definition array
|
||
|
|
*
|
||
|
|
* Returns a server definition array as created using
|
||
|
|
* {@link * Rest_Reflection}. Can be used for server introspection,
|
||
|
|
* documentation, or persistence.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getFunctions();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Load server definition
|
||
|
|
*
|
||
|
|
* Used for persistence; loads a construct as returned by {@link getFunctions()}.
|
||
|
|
*
|
||
|
|
* @param array $array
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function loadFunctions($definition);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set server persistence
|
||
|
|
*
|
||
|
|
* @param int $mode
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function setPersistence($mode);
|
||
|
|
}
|