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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Permissions;
use MediaWiki\User\UserIdentity;
/**
* Represents the subject that rate limits are applied to.
*
* @unstable
* @since 1.39
*/
class RateLimitSubject {
/**
* @var UserIdentity
*/
private $user;
/**
* @var string|null
*/
private $ip;
/**
* @var array
*/
private $flags;
/** @var string Flag indicating the user is exempt from rate limits */
public const EXEMPT = 'exempt';
/** @var string Flag indicating the user is a newbie */
public const NEWBIE = 'newbie';
/**
* @internal
*
* @param UserIdentity $user
* @param string|null $ip
* @param array<string,bool> $flags
*/
public function __construct( UserIdentity $user, ?string $ip, array $flags ) {
$this->user = $user;
$this->ip = $ip;
$this->flags = $flags;
}
/**
* @return UserIdentity
*/
public function getUser(): UserIdentity {
return $this->user;
}
/**
* @return string|null
*/
public function getIP(): ?string {
return $this->ip;
}
/**
* Checks whether the given flag applies.
*
* @param string $flag
*
* @return bool
*/
public function is( string $flag ) {
return !empty( $this->flags[$flag] );
}
}
|
