CRM/Core/Exception.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Base class for exceptions generated by CiviCRM.
  30  * This Exception returns more information than the default one. We are using it from the
  31  * form layer to allow redirects to occur without having redirects in the BAO
  32  * @param string $message
  33  *   The human friendly error message.
  34  * @param string $error_code
  35  *   A computer friendly error code. By convention, no space (but underscore allowed).
  36  *   ex: mandatory_missing, duplicate, invalid_format
  37  * @param array $data
  38  *   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.
  39  */
  40 class CRM_Core_Exception extends PEAR_Exception {
  41   private $errorData = array();
  42
  43   /**
  44    * Class constructor.
  45    *
  46    * @param string $message
  47    * @param int $error_code
  48    * @param array $errorData
  49    * @param null $previous
  50    */
  51   public function __construct($message, $error_code = 0, $errorData = array(), $previous = NULL) {
  52     parent::__construct(ts($message));
  53     $this->errorData = $errorData + array('error_code' => $error_code);
  54   }
  55
  56   /**
  57    * Custom string representation of object.
  58    *
  59    * @return string
  60    */
  61   public function __toString() {
  62     return __CLASS__ . ": [{$this->errorData['error_code']}: {$this->message}\n";
  63   }
  64
  65   /**
  66    * Get error code.
  67    *
  68    * @return mixed
  69    */
  70   public function getErrorCode() {
  71     return $this->errorData['error_code'];
  72   }
  73
  74   /**
  75    * Return specific error information.
  76    *
  77    * (Can be used for more detailed error messages or translation.)
  78    *
  79    * This method may be overridden in child exception classes in order
  80    * to add functionality not present in PEAR_Exception and is a placeholder
  81    * to define API
  82    *
  83    * The returned array must be an associative array of parameter => value like so:
  84    * <pre>
  85    * array('name' => $name, 'context' => array(...))
  86    * </pre>
  87    * @return array
  88    */
  89   public function getErrorData() {
  90     return $this->errorData;
  91   }
  92
  93 }