Update to last upstream version of libomb: coding style updates, static call fix...

[quix0rs-gnu-social.git] / extlib / libomb / invalidparameterexception.php

diff --git a/extlib/libomb/invalidparameterexception.php b/extlib/libomb/invalidparameterexception.php
index 163e1dd4cc8eee71c3b58338875e6ea0f6c5da1d..d95c7022cbdd83a4beb87043ff778ff25f7398b4 100755 (executable)
--- a/extlib/libomb/invalidparameterexception.php
+++ b/extlib/libomb/invalidparameterexception.php
@@ -1,8 +1,6 @@
 <?php
 /**
- * Exception stating that a passed parameter is invalid
- *
- * This exception is raised when a parameter does not obey the OMB standard.
+ * This file is part of libomb
  *
  * PHP version 5
  *
@@ -19,14 +17,36 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
- * @package   OMB
- * @author    Adrian Lang <mail@adrianlang.de>
- * @copyright 2009 Adrian Lang
- * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL 3.0
- **/
-class OMB_InvalidParameterException extends Exception {
-  public function __construct($value, $type, $parameter) {
-    parent::__construct("Invalid value $value for parameter $parameter in $type");
-  }
+ * @package OMB
+ * @author  Adrian Lang <mail@adrianlang.de>
+ * @license http://www.gnu.org/licenses/agpl.html GNU AGPL 3.0
+ * @version 0.1a-20090828
+ * @link    http://adrianlang.de/libomb
+ */
+
+/**
+ * Exception stating that a passed parameter is invalid
+ *
+ * This exception is raised when a parameter does not obey the OMB standard.
+ */
+class OMB_InvalidParameterException extends Exception
+{
+    /**
+     * Constructor
+     *
+     * Creates a new exception based on a parameter name, value, and object
+     * type.
+     *
+     * @param string $value     The wrong value passed
+     * @param string $type      The object type the parameter belongs to;
+     *                          Currently OMB uses profiles and notices
+     * @param string $parameter The name of the parameter the wrong value has
+     *                          been passed for
+     */
+    public function __construct($value, $type, $parameter)
+    {
+        parent::__construct("Invalid value ‘${value}’ for parameter " .
+                            "‘${parameter}’ in $type");
+    }
 }
 ?>