Merge pull request #10535 from jitendrapurohit/CRM-20752

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

diff --git a/api/Exception.php b/api/Exception.php
index 1b5d544f8e15a6c0c2b2020e15e9317368ded74c..8c6ca5ba73d26c9e04381065d2416509547692f6 100644 (file)
--- a/api/Exception.php
+++ b/api/Exception.php
@@ -1,16 +1,20 @@
 <?php
 /**
+ * @file
  * File for the CiviCRM APIv3 API wrapper
  *
  * @package CiviCRM_APIv3
- * @subpackage API
  *
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2017
  */
 
 /**
- * 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
+ * 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.
  */
 class API_Exception extends Exception {
   const UNAUTHORIZED = 'unauthorized';
@@ -19,6 +23,8 @@ class API_Exception extends Exception {
   private $extraParams = array();
 
   /**
+   * Class constructor.
+   *
    * @param string $message
    *   The human friendly error message.
    * @param mixed $error_code
@@ -43,8 +49,9 @@ class API_Exception extends Exception {
     $this->extraParams = $extraParams + array('error_code' => $error_code);
   }
 
-  // custom string representation of object
   /**
+   * Custom string representation of object.
+   *
    * @return string
    */
   public function __toString() {
@@ -52,6 +59,8 @@ class API_Exception extends Exception {
   }
 
   /**
+   * Get extra parameters.
+   *
    * @return array
    */
   public function getExtraParams() {
@@ -59,6 +68,8 @@ class API_Exception extends Exception {
   }
 
   /**
+   * Get error codes.
+   *
    * @return array
    */
   public function getErrorCodes() {
@@ -70,6 +81,7 @@ class API_Exception extends Exception {
       self::NOT_IMPLEMENTED => 'Entity or method is not implemented',
     );
   }
+
 }
 
 /**
@@ -80,6 +92,8 @@ class CiviCRM_API3_Exception extends Exception {
   private $extraParams = array();
 
   /**
+   * Class constructor.
+   *
    * @param string $message
    *   The human friendly error message.
    * @param mixed $error_code
@@ -97,8 +111,9 @@ class CiviCRM_API3_Exception extends Exception {
     $this->extraParams = $extraParams + array('error_code' => $error_code);
   }
 
-  // custom string representation of object
   /**
+   * Custom string representation of object.
+   *
    * @return string
    */
   public function __toString() {
@@ -106,6 +121,8 @@ class CiviCRM_API3_Exception extends Exception {
   }
 
   /**
+   * Get error code.
+   *
    * @return mixed
    */
   public function getErrorCode() {
@@ -113,9 +130,12 @@ class CiviCRM_API3_Exception extends Exception {
   }
 
   /**
+   * Get extra parameters.
+   *
    * @return array
    */
   public function getExtraParams() {
     return $this->extraParams;
   }
+
 }