]> scripts.mit.edu Git - autoinstalls/mediawiki.git/blobdiff - vendor/wikimedia/assert/src/ParameterAssertionException.php
MediaWiki 1.30.2
[autoinstalls/mediawiki.git] / vendor / wikimedia / assert / src / ParameterAssertionException.php
diff --git a/vendor/wikimedia/assert/src/ParameterAssertionException.php b/vendor/wikimedia/assert/src/ParameterAssertionException.php
new file mode 100644 (file)
index 0000000..cb42cc6
--- /dev/null
@@ -0,0 +1,49 @@
+<?php
+
+namespace Wikimedia\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * Exception indicating that an parameter assertion failed.
+ * This generally means a disagreement between the caller and the implementation of a function.
+ *
+ * @license MIT
+ * @author Daniel Kinzler
+ * @copyright Wikimedia Deutschland e.V.
+ */
+class ParameterAssertionException extends InvalidArgumentException implements AssertionException {
+
+       /**
+        * @var string
+        */
+       private $parameterName;
+
+       /**
+        * @param string $parameterName
+        * @param string $description
+        *
+        * @throws ParameterTypeException
+        */
+       public function __construct( $parameterName, $description ) {
+               if ( !is_string( $parameterName ) ) {
+                       throw new ParameterTypeException( 'parameterName', 'string' );
+               }
+
+               if ( !is_string( $description ) ) {
+                       throw new ParameterTypeException( 'description', 'string' );
+               }
+
+               parent::__construct( "Bad value for parameter $parameterName: $description" );
+
+               $this->parameterName = $parameterName;
+       }
+
+       /**
+        * @return string
+        */
+       public function getParameterName() {
+               return $this->parameterName;
+       }
+
+}