(dev/core#2258) CryptoRegistry - Keep track of available keys+suites. Hookable.

[civicrm-core.git] / Civi / API / Exception / NotImplementedException.php

diff --git a/Civi/API/Exception/NotImplementedException.php b/Civi/API/Exception/NotImplementedException.php
index 68ca54478a42b3080026de73bb8d1cf3c215df2c..b8f253f13ebdde72c4fecf7fc514335a2621ba3b 100644 (file)
--- a/Civi/API/Exception/NotImplementedException.php
+++ b/Civi/API/Exception/NotImplementedException.php
@@ -8,12 +8,19 @@ require_once 'api/Exception.php';
  * @package Civi\API\Exception
  */
 class NotImplementedException extends \API_Exception {
+
   /**
    * @param string $message
+   *   The human friendly error message.
    * @param array $extraParams
-   * @param Exception $previous
+   *   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, $extraParams = array(), Exception $previous = NULL) {
+  public function __construct($message, $extraParams = [], \Exception $previous = NULL) {
     parent::__construct($message, \API_Exception::NOT_IMPLEMENTED, $extraParams, $previous);
   }
+
 }