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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
/**
* Value object representing a user's identity.
*
* 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\User;
use Wikimedia\Assert\Assert;
/**
* Value object representing a user's identity.
*
* @since 1.31
*/
class UserIdentityValue implements UserIdentity {
/**
* @var int
*/
private $id;
/**
* @var string
*/
private $name;
/**
* @var int
*/
private $actor;
/**
* @param int $id
* @param string $name
* @param int $actor
*/
public function __construct( $id, $name, $actor ) {
Assert::parameterType( 'integer', $id, '$id' );
Assert::parameterType( 'string', $name, '$name' );
Assert::parameterType( 'integer', $actor, '$actor' );
$this->id = $id;
$this->name = $name;
$this->actor = $actor;
}
/**
* @return int The user ID. May be 0 for anonymous users or for users with no local account.
*/
public function getId() {
return $this->id;
}
/**
* @return string The user's logical name. May be an IPv4 or IPv6 address for anonymous users.
*/
public function getName() {
return $this->name;
}
/**
* @return int The user's actor ID. May be 0 if no actor ID has been assigned.
*/
public function getActorId() {
return $this->actor;
}
/**
* @since 1.32
*
* @param UserIdentity $user
* @return bool
*/
public function equals( UserIdentity $user ) {
// XXX it's not clear whether central ID providers are supposed to obey this
return $this->getName() === $user->getName();
}
/**
* @since 1.34
*
* @return bool True if user is registered on this wiki, i.e., has a user ID. False if user is
* anonymous or has no local account (which can happen when importing). This is equivalent to
* getId() != 0 and is provided for code readability.
*/
public function isRegistered() {
return $this->getId() != 0;
}
}
|
