Source for file Message.class.php

Documentation is available at Message.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 Message 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 Message Interface
  30.  * @version 0.0.1
  31.  */
  32.  
  33. interface Gumbo_Interface_Debug_Message {
  34.     
  35.     /** MUTATOR METHODS **/
  36.     /**
  37.      * Sets the message contents of the message
  38.      * @param string $mess 
  39.      */
  40.     public function setMessage ($mess);
  41.     
  42.     /**
  43.      * Sets the file where the message occured
  44.      * @precondition file_exists ($file)
  45.      * @param string $file 
  46.      */
  47.     public function setFile ($file);
  48.     
  49.     /**
  50.      * Sets the line number of the message
  51.      * @param int $line 
  52.      */
  53.     public function setLine ($line);
  54.     
  55.     /**
  56.      * Sets the function/method name
  57.      * @precondition function_exists ($func)
  58.      * @param string $func 
  59.      */
  60.     public function setFunction ($func);
  61.     
  62.     /**
  63.      * Sets the class name
  64.      * @precondtion class_exists ($cls)
  65.      * @param string $cls 
  66.      */
  67.     public function setClass ($cls);
  68.     
  69.     /**
  70.      * Sets the time (in seconds) to get to debug message from last message
  71.      * @param num $time 
  72.      */
  73.     public function setSeconds ($time=null);
  74.     
  75.     
  76.     
  77.     /** ACCESSOR METHODS **/
  78.     /**
  79.      * Returns the time when message occured
  80.      * @return num 
  81.      */
  82.     public function getTime ();
  83.     
  84.     /**
  85.      * Returns the message
  86.      * @return string 
  87.      */
  88.     public function getMessage ();
  89.     
  90.     /**
  91.      * Returns the file
  92.      * @return string 
  93.      */
  94.     public function getFile ();
  95.     
  96.     /**
  97.      * Returns the line number
  98.      * @return int 
  99.      */
  100.     public function getLine ();
  101.     
  102.     /**
  103.      * Returns the function/method
  104.      * @return string 
  105.      */
  106.     public function getFunction ();
  107.     
  108.     /**
  109.      * Returns the class name
  110.      * @return string 
  111.      */
  112.     public function getClass ();
  113.     
  114.     /**
  115.      * Returns the time (in seconds) it took to execute the code from last message
  116.      * @param num $time last message time value
  117.      * @return num 
  118.      */
  119.     public function getSeconds ($time=null);
  120.     
  121. }
  122.  
  123. ?>