Merge pull request #4827 from colemanw/CRM-15759

[civicrm-core.git] / api / Exception.php

diff --git a/api/Exception.php b/api/Exception.php
index ea4705820e010eeb8997a1ef0eb8cd6996d4dfdb..1b5d544f8e15a6c0c2b2020e15e9317368ded74c 100644 (file)
--- a/api/Exception.php
+++ b/api/Exception.php
@@ -5,73 +5,116 @@
  * @package CiviCRM_APIv3
  * @subpackage API
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
  * This api exception returns more information than the default one. The aim it let the api consumer know better what is exactly the error without having to parse the error message.
  * If you consume an api that doesn't return an error_code or the extra data you need, consider improving the api and contribute
- * @param string $message
- *   the human friendly error message
- * @param string $error_code
- *   a computer friendly error code. By convention, no space (but underscore allowed)
- *  ex: mandatory_missing, duplicate, invalid_format
- * @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
  */
-class API_Exception extends Exception
-{
+class API_Exception extends Exception {
+  const UNAUTHORIZED = 'unauthorized';
+  const NOT_IMPLEMENTED = 'not-found';
+
   private $extraParams = array();
-  public function __construct($message, $error_code = 0, $extraParams = array(),Exception $previous = null) {
-    if (is_numeric ($error_code)) // using int for error code "old way")
+
+  /**
+   * @param string $message
+   *   The human friendly error message.
+   * @param mixed $error_code
+   *   A computer friendly error code. By convention, no space (but underscore
+   *   allowed) (ex: mandatory_missing, duplicate, invalid_format).
+   * @param array $extraParams
+   *   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.
+   * @param Exception|NULL $previous
+   *   A previous exception which caused this new exception.
+   */
+  public function __construct($message, $error_code = 0, $extraParams = array(), Exception $previous = NULL) {
+    // Using int for error code "old way") ?
+    if (is_numeric($error_code)) {
       $code = $error_code;
-    else
-      $code=0;
+    }
+    else {
+      $code = 0;
+    }
     parent::__construct(ts($message), $code, $previous);
     $this->extraParams = $extraParams + array('error_code' => $error_code);
   }
 
   // custom string representation of object
+  /**
+   * @return string
+   */
   public function __toString() {
     return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
   }
 
+  /**
+   * @return array
+   */
   public function getExtraParams() {
     return $this->extraParams;
   }
 
-  public function getErrorCodes(){
+  /**
+   * @return array
+   */
+  public function getErrorCodes() {
     return array(
-        2000 => '$params was not an array',
-        2001 => 'Invalid Value for Date field',
-        2100 => 'String value is longer than permitted length'
-        );
+      2000 => '$params was not an array',
+      2001 => 'Invalid Value for Date field',
+      2100 => 'String value is longer than permitted length',
+      self::UNAUTHORIZED => 'Unauthorized',
+      self::NOT_IMPLEMENTED => 'Entity or method is not implemented',
+    );
   }
 }
+
 /**
  * This api exception returns more information than the default one. We are using it rather than
  * API_Exception from the api wrapper as the namespace is more generic
- * @param string $message the human friendly error message
- * @param string $error_code a computer friendly error code. By convention, no space (but underscore allowed)
- *  ex: mandatory_missing, duplicate, invalid_format
- * @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
  */
-class CiviCRM_API3_Exception extends Exception
-{
+class CiviCRM_API3_Exception extends Exception {
   private $extraParams = array();
-  public function __construct($message, $error_code, $extraParams = array(),Exception $previous = null) {
+
+  /**
+   * @param string $message
+   *   The human friendly error message.
+   * @param mixed $error_code
+   *   A computer friendly error code. By convention, no space (but underscore
+   *   allowed) (ex: mandatory_missing, duplicate, invalid_format).
+   * @param array $extraParams
+   *   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.
+   * @param Exception|NULL $previous
+   *   A previous exception which caused this new exception.
+   */
+  public function __construct($message, $error_code, $extraParams = array(), Exception $previous = NULL) {
     parent::__construct(ts($message));
     $this->extraParams = $extraParams + array('error_code' => $error_code);
   }
 
   // custom string representation of object
+  /**
+   * @return string
+   */
   public function __toString() {
     return __CLASS__ . ": [{$this->extraParams['error_code']}: {$this->message}\n";
   }
 
+  /**
+   * @return mixed
+   */
   public function getErrorCode() {
     return $this->extraParams['error_code'];
   }
+
+  /**
+   * @return array
+   */
   public function getExtraParams() {
     return $this->extraParams;
   }