fix(API): Use a distinct exception so apps can react to it and customize the return

Signed-off-by: Joas Schilling <coding@schilljs.com>

1 files changed, 79 insertions, 0 deletions

diff --git a/lib/public/AppFramework/Http/ParameterOutOfRangeException.php b/lib/public/AppFramework/Http/ParameterOutOfRangeException.php
new file mode 100644
index 00000000000..22518d8eddf
--- /dev/null
+++ b/lib/public/AppFramework/Http/ParameterOutOfRangeException.php
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * 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/>.
+ *
+ */
+
+namespace OCP\AppFramework\Http;
+
+/**
+ * @since 29.0.0
+ */
+class ParameterOutOfRangeException extends \OutOfRangeException {
+	/**
+	 * @since 29.0.0
+	 */
+	public function __construct(
+		protected string $parameterName,
+		protected int $actualValue,
+		protected int $minValue,
+		protected int $maxValue,
+	) {
+		parent::__construct(
+			sprintf(
+				'Parameter %s must be between %d and %d',
+				$this->parameterName,
+				$this->minValue,
+				$this->maxValue,
+			)
+		);
+	}
+
+	/**
+	 * @since 29.0.0
+	 */
+	public function getParameterName(): string {
+		return $this->parameterName;
+	}
+
+	/**
+	 * @since 29.0.0
+	 */
+	public function getActualValue(): int {
+		return $this->actualValue;
+	}
+
+	/**
+	 * @since 29.0.0
+	 */
+	public function getMinValue(): int {
+		return $this->minValue;
+	}
+
+	/**
+	 * @since 29.0.0
+	 */
+	public function getMaxValue(): int {
+		return $this->maxValue;
+	}
+}