Source for file Interface_Exception.php

Documentation is available at Interface_Exception.php

  1. <?php
  2. /**
  3.  *    LAIKA FRAMEWORK Release Notes:
  4.  *
  5.  *    @filesource     Interface_Exception.php
  6.  *
  7.  *    @version        0.1.0b
  8.  *    @package        Laika
  9.  *    @subpackage     core
  10.  *    @category       interface
  11.  *    @date           2011-05-22 08:52:15 -0400 (Sun, 22 May 2011)
  12.  *
  13.  *    @author         Leonard M. Witzel <witzel@post.harvard.edu>
  14.  *    @copyright      Copyright (c) 2011  Laika Soft <{@link http://oafbot.com}>
  15.  *
  16.  */
  17. /**
  18.  * Laika_Interface_Exception interface.
  19.  * 
  20.  * @interface
  21.  */
  22. interface Laika_Interface_Exception{
  23.  
  24. //-------------------------------------------------------------------
  25. //    CONSTRUCTOR
  26. //-------------------------------------------------------------------
  27.     /**
  28.      * __construct function.
  29.      * 
  30.      * Overrideable constructor method inherited from Exception class
  31.      *
  32.      * @access public
  33.      * @param mixed $message (default: null)
  34.      * @param int $code (default: 0)
  35.      * @return void 
  36.      */
  37.     public function __construct($message = null, $code = 0);
  38.  
  39. //-------------------------------------------------------------------
  40. //    METHODS
  41. //-------------------------------------------------------------------
  42.     /**
  43.      * __toString function.
  44.      *
  45.      * Overrideable toString method inherited from Exception class
  46.      * 
  47.      * @access public
  48.      * @return void 
  49.      */
  50.     public function __toString();
  51.     
  52.     /* Protected methods inherited from Exception class */
  53.     public function getMessage();                 // Exception message
  54.     public function getCode();                    // User-defined Exception code
  55.     public function getFile();                    // Source filename
  56.     public function getLine();                    // Source line
  57.     public function getTrace();                   // An array of the backtrace()
  58.     public function getTraceAsString();           // Formated string of trace
  59.     
  60. }

Documentation generated on Sat, 19 May 2012 02:17:01 -0400 by phpDocumentor 1.4.4