Source for file Server.class.php

Documentation is available at Server.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Debug
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Debug Server Interface
  22.  *
  23.  * @category Gumbo
  24.  * @package Debug
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc Debug Server Interface
  30.  * @version 0.0.1
  31.  */
  32.  
  33. interface Gumbo_Interface_Debug_Server {
  34.     
  35.     /** ACTION METHODS **/
  36.     /**
  37.      * Activates a Server Report
  38.      * @param string $report Debug Server Report Name
  39.      * @param arr $args additional arguments
  40.      */
  41.     public function activate ($report, $args=null);
  42.     
  43.     /**
  44.      * Deactivates a Server Report
  45.      * @param string $report Debug Server Report Name
  46.      */
  47.     public function deactivate ($report);
  48.     
  49.     /**
  50.      * Resets the Reports
  51.      * @postcondition !isActive()
  52.      */
  53.     public function reset ();
  54.     
  55.     
  56.     
  57.     /** ACCESSOR METHODS **/
  58.     /**
  59.      * Returns a single Report
  60.      * @param string $report 
  61.      * @return Gumbo_Interface_Debug_Server_Report 
  62.      */
  63.     public function getReport ($report);
  64.     
  65.     /**
  66.      * Returns the Debug Server Reports
  67.      * @return Gumbo_Interface_Debug_Server_Report[] 
  68.      */
  69.     public function getReports ();
  70.     
  71.     /**
  72.      * Returns if a particular Report is active
  73.      * @param string $report 
  74.      * @return bool 
  75.      */
  76.     public function isActive ($report);
  77.     
  78.     /**
  79.      * Returns if the Report exists
  80.      * @param string $report 
  81.      * @return bool 
  82.      */
  83.     public function exists ($report);
  84.     
  85. }
  86.  
  87. ?>