Source for file Exception.class.php

Documentation is available at Exception.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 Error
  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.  * Exception Interface
  22.  * 
  23.  * The Interface adds a few extra methods to the pre-defined Exception class
  24.  * in PHP5.
  25.  *
  26.  * @category Gumbo
  27.  * @package Error
  28.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  29.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  30.  * @author Michael Luster <mluster79@yahoo.com>
  31.  * @link http://sourceforge.net/projects/phpgumbo
  32.  * @desc Exception Interface
  33.  * @version 0.0.1
  34.  */
  35.  
  36. interface Gumbo_Interface_Exception {
  37.     
  38.     /** ACTION METHODS **/
  39.     /**
  40.      * Displays the error title from __toString()
  41.      * @param bool $val 
  42.      */
  43.     public static function displayTitle ($val);
  44.     
  45.     /**
  46.      * Displays the function information from __toString()
  47.      * @param bool $val 
  48.      */
  49.     public static function displayFile ($val);
  50.     
  51.     /**
  52.      * Displays the file information from __toString()
  53.      * @param bool $val 
  54.      */
  55.     public static function displayFunction ($val);
  56.     
  57.     /**
  58.      * Displays the error trace information from __toString()
  59.      * @param bool $val 
  60.      */
  61.     public static function displayTrace ($val);
  62.     
  63.     
  64.     
  65.     /** MUTATOR METHODS **/
  66.     /**
  67.      * Sets the Message text
  68.      * @param string $mess 
  69.      */
  70.     public function setMessage ($mess);
  71.     
  72.     /**
  73.      * Sets the error level code
  74.      * @param int $code 
  75.      */
  76.     public function setCode ($code);
  77.     
  78.     /**
  79.      * Sets the file name where error occured (__FILE__)
  80.      * @param string $file 
  81.      */
  82.     public function setFile ($file);
  83.     
  84.     /**
  85.      * Sets the line number where error occured (__LINE__)
  86.      * @param int $line 
  87.      */
  88.     public function setLine ($line);
  89.     
  90.     /**
  91.      * Sets the function or class method (__METHOD__) or (__FUNCTION__)
  92.      * @param string $func function/method name
  93.      */
  94.     public function setFunction ($func);
  95.     
  96.     
  97.     
  98.     /** ACCESSOR METHOD **/
  99.     /**
  100.      * Returns the function / class method name
  101.      * @return string 
  102.      */
  103.     public function getFunction ();
  104.     
  105. }
  106.  
  107. ?>