environment/classes/Error.class.php

   1 <?php
   2
   3   /**
   4   * Error class
   5   *
   6   * Errors are similar to exceptions in PHP5 but without some cool tricks
   7   * that build in error handling provides.
   8   *
   9   * @package havoc
  10   * @subpackage Base classes
  11   * @version 1.0
  12   * @http://www.projectpier.org/
  13   */
  14   class Error extends Exception {
  15
  16     /**
  17     * Return error params (name -> value pairs). General params are file and line
  18     * and any specific error have their own params...
  19     *
  20     * @access public
  21     * @param void
  22     * @return array
  23     */
  24     function getParams() {
  25
  26       // Prepare base params...
  27       $base = array(
  28         'file' => $this->getFile(),
  29         'line' => $this->getLine()
  30       ); // array
  31
  32       // Get additional params...
  33       $additional = $this->getAdditionalParams();
  34
  35       // And return (join if we have additional params)
  36       return is_array($additional) ? array_merge($base, $additional) : $base;
  37
  38     } // getParams
  39
  40     /**
  41     * Return additional error params
  42     *
  43     * @access public
  44     * @param void
  45     * @return array
  46     */
  47     function getAdditionalParams() {
  48       return null;
  49     } // getAdditionalParams
  50
  51   } // Error
  52
  53 ?>