1	<?php
2	/**
3	* Interface for objects representing user identity.
4	*
5	* This program is free software; you can redistribute it and/or modify
6	* it under the terms of the GNU General Public License as published by
7	* the Free Software Foundation; either version 2 of the License, or
8	* (at your option) any later version.
9	*
10	* This program is distributed in the hope that it will be useful,
11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	* GNU General Public License for more details.
14	*
15	* You should have received a copy of the GNU General Public License along
16	* with this program; if not, write to the Free Software Foundation, Inc.,
17	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18	* http://www.gnu.org/copyleft/gpl.html
19	*
20	* @file
21	*/
22
23	namespace MediaWiki\User;
24
25	use MediaWiki\DAO\WikiAwareEntity;
26
27	/**
28	* Interface for objects representing user identity.
29	*
30	* This represents the identity of a user in the context of page revisions and log entries.
31	*
32	* @note Starting MediaWiki 1.37, UserIdentity objects should no longer expose an actor ID.
33	* The actor ID is considered a storage layer optimization and should not be exposed to
34	* and used by application logic. Storage layer code should use ActorNormalization to
35	* get an actor ID for a UserIdentity.
36	*
37	* @since 1.31
38	*/
39	interface UserIdentity extends WikiAwareEntity {
40
41	/**
42	* @since 1.31
43	*
44	* @param string|false $wikiId The wiki ID expected by the caller
45	* @return int The user ID. May be 0 for anonymous users or for users with no local account.
46	*
47	*/
48	public function getId( $wikiId = self::LOCAL ): int;
49
50	/**
51	* @since 1.31
52	*
53	* @return string The user's logical name. May be an IPv4 or IPv6 address for anonymous users.
54	*/
55	public function getName(): string;
56
57	/**
58	* @since 1.32
59	*
60	* @param UserIdentity|null $user
61	* @return bool
62	*/
63	public function equals( ?UserIdentity $user ): bool;
64
65	/**
66	* This must be equivalent to getId() != 0 and is provided for code readability. There is no
67	* equivalent utility for checking whether a user is temporary, since that would introduce a
68	* service dependency. Use UserIdentityUtils::isTemp (or UserNameUtils::isTemp) instead.
69	*
70	* @since 1.34
71	*
72	* @return bool True if user is registered on this wiki, i.e., has a user ID. False if user is
73	*   anonymous or has no local account (which can happen when importing).
74	*/
75	public function isRegistered(): bool;
76	}