Passed
Push — master ( 95c098...0f0be5 )
by Joas
16:23 queued 12s
created

ARateLimit::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 0

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 0
nc 1
nop 2
dl 0
loc 4
rs 10
c 1
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
/**
6
 * @copyright Copyright (c) 2023 Joas Schilling <[email protected]>
7
 *
8
 * @author Joas Schilling <[email protected]>
9
 *
10
 * @license GNU AGPL version 3 or any later version
11
 *
12
 * This program is free software: you can redistribute it and/or modify
13
 * it under the terms of the GNU Affero General Public License as
14
 * published by the Free Software Foundation, either version 3 of the
15
 * License, or (at your option) any later version.
16
 *
17
 * This program is distributed in the hope that it will be useful,
18
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
 * GNU Affero General Public License for more details.
21
 *
22
 * You should have received a copy of the GNU Affero General Public License
23
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
24
 */
25
26
namespace OCP\AppFramework\Http\Attribute;
27
28
/**
29
 * Attribute for controller methods that want to limit the times a logged-in
30
 * user can call the endpoint in a given time period.
31
 *
32
 * @since 27.0.0
33
 */
34
abstract class ARateLimit {
35
	/**
36
	 * @since 27.0.0
37
	 */
38
	public function __construct(
39
		protected int $limit,
40
		protected int $period,
41
	) {
42
	}
43
44
	/**
45
	 * @since 27.0.0
46
	 */
47
	public function getLimit(): int {
48
		return $this->limit;
49
	}
50
51
	/**
52
	 * @since 27.0.0
53
	 */
54
	public function getPeriod(): int {
55
		return $this->period;
56
	}
57
}
58