CRM/Core/Exception.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * Base class for exceptions generated by CiviCRM.
  31  * This Exception returns more information than the default one. We are using it from the
  32  * form layer to allow redirects to occur without having redirects in the BAO
  33  * @param string $message the human friendly error message
  34  * @param string $error_code a computer friendly error code. By convention, no space (but underscore allowed)
  35  *  ex: mandatory_missing, duplicate, invalid_format
  36  * @param array $data extra params to return. eg an extra array of ids. It is not mandatory, but can help the computer using the api. Keep in mind the api consumer isn't to be trusted. eg. the database password is NOT a good extra data
  37  */
  38
  39 class CRM_Core_Exception extends PEAR_Exception {
  40   private $errorData = array();
  41   public function __construct($message, $error_code = 0, $errorData = array(), $previous = null) {
  42     parent::__construct(ts($message));
  43     $this->errorData = $errorData + array('error_code' => $error_code);
  44   }
  45
  46   // custom string representation of object
  47   public function __toString() {
  48     return __CLASS__ . ": [{$this->errorData['error_code']}: {$this->message}\n";
  49   }
  50
  51   public function getErrorCode() {
  52     return $this->errorData['error_code'];
  53   }
  54   public function getErrorData() {
  55     return $this->errorData;
  56   }
  57 }
  58