Merge pull request #5580 from eileenmcnaughton/CRM-16247

[civicrm-core.git] / CRM / Core / Exception.php

diff --git a/CRM/Core/Exception.php b/CRM/Core/Exception.php
index 88231c792a03c184cbc27f485aba72b8eb7ccee7..0484b0d0caafb38e89cc90a3d5c628ab3ab4b47c 100644 (file)
--- a/CRM/Core/Exception.php
+++ b/CRM/Core/Exception.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -24,26 +23,38 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * Base class for exceptions generated by CiviCRM.
  * This Exception returns more information than the default one. We are using it from the
  * form layer to allow redirects to occur without having redirects in the BAO
- * @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
+ * @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 CRM_Core_Exception extends PEAR_Exception {
   private $errorData = array();
-  public function __construct($message, $error_code = 0, $errorData = array(), $previous = null) {
+
+  /**
+   * @param $message
+   * @param int $error_code
+   * @param array $errorData
+   * @param null $previous
+   */
+  public function __construct($message, $error_code = 0, $errorData = array(), $previous = NULL) {
     parent::__construct(ts($message));
     $this->errorData = $errorData + array('error_code' => $error_code);
   }
 
-  // custom string representation of object
+  /**
+   * custom string representation of object.
+   * @return string
+   */
   public function __toString() {
     return __CLASS__ . ": [{$this->errorData['error_code']}: {$this->message}\n";
   }
@@ -51,8 +62,23 @@ class CRM_Core_Exception extends PEAR_Exception {
   public function getErrorCode() {
     return $this->errorData['error_code'];
   }
+
+  /**
+   * Return specific error information that can be used for more detailed
+   * error messages or translation.
+   *
+   * This method may be overridden in child exception classes in order
+   * to add functionality not present in PEAR_Exception and is a placeholder
+   * to define API
+   *
+   * The returned array must be an associative array of parameter => value like so:
+   * <pre>
+   * array('name' => $name, 'context' => array(...))
+   * </pre>
+   * @return array
+   */
   public function getErrorData() {
     return $this->errorData;
   }
-}
 
+}