aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/AppFramework/Http/ParameterOutOfRangeException.php
blob: 3286917d4d0916c042c6979b9b128cd83be8ff74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

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;
	}
}