vendor/zendframework/zend-server/src/Server.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-server for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-server/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Server;
   9
  10 /**
  11  * Server Interface
  12  */
  13 interface Server
  14 {
  15     /**
  16      * Attach a function as a server method
  17      *
  18      * Namespacing is primarily for xmlrpc, but may be used with other
  19      * implementations to prevent naming collisions.
  20      *
  21      * @param  string $function
  22      * @param  string $namespace
  23      * @param  null|array Optional array of arguments to pass to callback at
  24      *                    dispatch.
  25      * @return void
  26      */
  27     public function addFunction($function, $namespace = '');
  28
  29     /**
  30      * Attach a class to a server
  31      *
  32      * The individual implementations should probably allow passing a variable
  33      * number of arguments in, so that developers may define custom runtime
  34      * arguments to pass to server methods.
  35      *
  36      * Namespacing is primarily for xmlrpc, but could be used for other
  37      * implementations as well.
  38      *
  39      * @param  mixed $class Class name or object instance to examine and attach
  40      *                      to the server.
  41      * @param  string $namespace Optional namespace with which to prepend method
  42      *                           names in the dispatch table.
  43      *                           methods in the class will be valid callbacks.
  44      * @param  null|array Optional array of arguments to pass to callbacks at
  45      *                    dispatch.
  46      * @return void
  47      */
  48     public function setClass($class, $namespace = '', $argv = null);
  49
  50     /**
  51      * Generate a server fault
  52      *
  53      * @param  mixed $fault
  54      * @param  int $code
  55      * @return mixed
  56      */
  57     public function fault($fault = null, $code = 404);
  58
  59     /**
  60      * Handle a request
  61      *
  62      * Requests may be passed in, or the server may automatically determine the
  63      * request based on defaults. Dispatches server request to appropriate
  64      * method and returns a response
  65      *
  66      * @param  mixed $request
  67      * @return mixed
  68      */
  69     public function handle($request = false);
  70
  71     /**
  72      * Return a server definition array
  73      *
  74      * Returns a server definition array as created using
  75      * {@link Reflection}. Can be used for server introspection,
  76      * documentation, or persistence.
  77      *
  78      * @return array
  79      */
  80     public function getFunctions();
  81
  82     /**
  83      * Load server definition
  84      *
  85      * Used for persistence; loads a construct as returned by {@link getFunctions()}.
  86      *
  87      * @param  array $definition
  88      * @return void
  89      */
  90     public function loadFunctions($definition);
  91
  92     /**
  93      * Set server persistence
  94      *
  95      * @todo Determine how to implement this
  96      * @param  int $mode
  97      * @return void
  98      */
  99     public function setPersistence($mode);
 100
 101     /**
 102      * Sets auto-response flag for the server.
 103      *
 104      * To unify all servers, default behavior should be to auto-emit response.
 105      *
 106      * @param  bool $flag
 107      * @return Server Self instance.
 108      */
 109     public function setReturnResponse($flag = true);
 110
 111     /**
 112      * Returns auto-response flag of the server.
 113      *
 114      * @return bool $flag Current status.
 115      */
 116     public function getReturnResponse();
 117
 118     /**
 119      * Returns last produced response.
 120      *
 121      * @return string|object Content of last response, or response object that
 122      *                       implements __toString() methods.
 123      */
 124     public function getResponse();
 125 }