api/Exception.php

   1 <?php
   2 /**
   3  * File for the CiviCRM APIv3 API wrapper
   4  *
   5  * @package CiviCRM_APIv3
   6  * @subpackage API
   7  *
   8  * @copyright CiviCRM LLC (c) 2004-2014
   9  */
  10
  11 /**
  12  * This api exception returns more information than the default one. The aim
  13  * it let the api consumer know better what is exactly the error without
  14  * having to parse the error message.
  15  *
  16  * If you consume an api that doesn't return an error_code or the extra data
  17  * you need, consider improving the api and contribute.
  18  */
  19 class API_Exception extends Exception {
  20   const UNAUTHORIZED = 'unauthorized';
  21   const NOT_IMPLEMENTED = 'not-found';
  22
  23   private $extraParams = array();
  24
  25   /**
  26    * @param string $message
  27    *   The human friendly error message.
  28    * @param mixed $error_code
  29    *   A computer friendly error code. By convention, no space (but underscore
  30    *   allowed) (ex: mandatory_missing, duplicate, invalid_format).
  31    * @param array $extraParams
  32    *   Extra params to return. eg an extra array of ids. It is not mandatory,
  33    *   but can help the computer using the api. Keep in mind the api consumer
  34    *   isn't to be trusted. eg. the database password is NOT a good extra data.
  35    * @param Exception|NULL $previous
  36    *   A previous exception which caused this new exception.
  37    */
  38   public function __construct($message, $error_code = 0, $extraParams = array(), Exception $previous = NULL) {
  39     // Using int for error code "old way") ?
  40     if (is_numeric($error_code)) {
  41       $code = $error_code;
  42     }
  43     else {
  44       $code = 0;
  45     }
  46     parent::__construct(ts($message), $code, $previous);
  47     $this->extraParams = $extraParams + array('error_code' => $error_code);
  48   }
  49
  50   /**
  51    * custom string representation of object
  52    * @return string
  53    */
  54   public function __toString() {
  55     return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
  56   }
  57
  58   /**
  59    * @return array
  60    */
  61   public function getExtraParams() {
  62     return $this->extraParams;
  63   }
  64
  65   /**
  66    * @return array
  67    */
  68   public function getErrorCodes() {
  69     return array(
  70       2000 => '$params was not an array',
  71       2001 => 'Invalid Value for Date field',
  72       2100 => 'String value is longer than permitted length',
  73       self::UNAUTHORIZED => 'Unauthorized',
  74       self::NOT_IMPLEMENTED => 'Entity or method is not implemented',
  75     );
  76   }
  77 }
  78
  79 /**
  80  * This api exception returns more information than the default one. We are using it rather than
  81  * API_Exception from the api wrapper as the namespace is more generic
  82  */
  83 class CiviCRM_API3_Exception extends Exception {
  84   private $extraParams = array();
  85
  86   /**
  87    * @param string $message
  88    *   The human friendly error message.
  89    * @param mixed $error_code
  90    *   A computer friendly error code. By convention, no space (but underscore
  91    *   allowed) (ex: mandatory_missing, duplicate, invalid_format).
  92    * @param array $extraParams
  93    *   Extra params to return. eg an extra array of ids. It is not mandatory,
  94    *   but can help the computer using the api. Keep in mind the api consumer
  95    *   isn't to be trusted. eg. the database password is NOT a good extra data.
  96    * @param Exception|NULL $previous
  97    *   A previous exception which caused this new exception.
  98    */
  99   public function __construct($message, $error_code, $extraParams = array(), Exception $previous = NULL) {
 100     parent::__construct(ts($message));
 101     $this->extraParams = $extraParams + array('error_code' => $error_code);
 102   }
 103
 104   /**
 105    * custom string representation of object
 106    * @return string
 107    */
 108   public function __toString() {
 109     return __CLASS__ . ": [{$this->extraParams['error_code']}: {$this->message}\n";
 110   }
 111
 112   /**
 113    * @return mixed
 114    */
 115   public function getErrorCode() {
 116     return $this->extraParams['error_code'];
 117   }
 118
 119   /**
 120    * @return array
 121    */
 122   public function getExtraParams() {
 123     return $this->extraParams;
 124   }
 125 }