Interface for objects representing user identity. More...
Inherits MediaWiki\DAO\WikiAwareEntity.
Inherited by MediaWiki\User\User, and MediaWiki\User\UserIdentityValue.
Public Member Functions | |
| equals (?UserIdentity $user) | |
| getId ( $wikiId=self::LOCAL) | |
| getName () | |
| isRegistered () | |
| This must be equivalent to getId() != 0 and is provided for code readability. | |
 Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity | |
| assertWiki ( $wikiId) | |
| Throws if $wikiId is different from the return value of getWikiId(). | |
| getWikiId () | |
| Get the ID of the wiki this page belongs to. | |
Additional Inherited Members | |
| Public Attributes inherited from MediaWiki\DAO\WikiAwareEntity | |
| const | LOCAL = false |
| Wiki ID value to use with instances that are defined relative to the local wiki. | |
Detailed Description
Interface for objects representing user identity.
This represents the identity of a user in the context of page revisions and log entries.
- Note
- Starting MediaWiki 1.37, UserIdentity objects should no longer expose an actor ID. The actor ID is considered a storage layer optimization and should not be exposed to and used by application logic. Storage layer code should use ActorNormalization to get an actor ID for a UserIdentity.
- Since
- 1.31
Definition at line 24 of file UserIdentity.php.
Member Function Documentation
◆ equals()
| MediaWiki\User\UserIdentity::equals | ( | ?UserIdentity | $user | ) |
- Since
- 1.32
- Parameters
-
UserIdentity | null $user
- Returns
- bool
Implemented in MediaWiki\User\User, and MediaWiki\User\UserIdentityValue.
◆ getId()
| MediaWiki\User\UserIdentity::getId | ( | $wikiId = self::LOCAL | ) |
- Since
- 1.31
- Parameters
-
string | false $wikiId The wiki ID expected by the caller
- Returns
- int The user ID. May be 0 for anonymous users or for users with no local account.
Implemented in MediaWiki\User\User, and MediaWiki\User\UserIdentityValue.
Referenced by MediaWiki\Block\BlockCacheKey\__construct(), MediaWiki\Deferred\UserEditCountUpdate\__construct(), MediaWiki\User\ActorCache\add(), MediaWiki\User\TalkPageNotificationManager\clearForPageView(), MediaWiki\Watchlist\WatchedItemStore\countUnreadNotifications(), MediaWiki\Page\WikiPage\doUpdateRestrictions(), MediaWiki\User\Registration\LocalUserRegistrationProvider\fetchRegistration(), MediaWiki\User\ActorMigrationBase\getInsertValues(), MediaWiki\Watchlist\WatchlistManager\getTitleNotificationTimestamp(), MediaWiki\Logging\LogFormatter\makeUserLink(), MediaWiki\Watchlist\ClearUserWatchlistJob\newForUser(), MediaWiki\Watchlist\WatchedItemStore\resetAllNotificationTimestampsForUser(), MediaWiki\RecentChanges\ChangesListQuery\SeenCondition\setUser(), MediaWiki\RecentChanges\ChangesListQuery\WatchedCondition\setUser(), MediaWiki\RecentChanges\ChangesListQuery\WatchlistJoin\setUser(), and MediaWiki\User\Options\LocalUserOptionsStore\store().
◆ getName()
| MediaWiki\User\UserIdentity::getName | ( | ) |
- Since
- 1.31
- Returns
- string The user's logical name. May be an IPv4 or IPv6 address for anonymous users.
Implemented in MediaWiki\User\User, and MediaWiki\User\UserIdentityValue.
Referenced by MediaWiki\Pager\ContributionsPager\__construct(), MediaWiki\User\ActorCache\add(), MediaWiki\Password\PasswordPolicyChecks\checkPasswordCannotBeSubstringInUsername(), MediaWiki\Password\PasswordPolicyChecks\checkPasswordCannotMatchDefaults(), MediaWiki\Page\WikiPage\doEditUpdates(), MediaWiki\Api\ApiQueryUserInfo\getCentralUserInfo(), MediaWiki\User\ActorMigrationBase\getInsertValues(), MediaWiki\User\Options\StaticUserOptionsLookup\getOptions(), MediaWiki\Specials\SpecialContributions\getResultsPageTitleMessageKey(), MediaWiki\Specials\SpecialDeletedContributions\getResultsPageTitleMessageKey(), MediaWiki\Parser\Parser\getUserSig(), MediaWiki\User\UserIdentityUtils\isNamed(), MediaWiki\User\UserIdentityUtils\isTemp(), MediaWiki\Logging\LogFormatter\makeUserLink(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), MediaWiki\Page\WikiPage\prepareContentForEdit(), MediaWiki\Specials\SpecialUserRights\saveUserGroups(), MediaWiki\Storage\DerivedPageDataUpdater\setPerformer(), MediaWiki\Upload\UploadBase\setSessionStatus(), and MediaWiki\Storage\PageUpdater\updateAuthor().
◆ isRegistered()
| MediaWiki\User\UserIdentity::isRegistered | ( | ) |
This must be equivalent to getId() != 0 and is provided for code readability.
There is no equivalent utility for checking whether a user is temporary, since that would introduce a service dependency. Use UserIdentityUtils::isTemp (or UserNameUtils::isTemp) instead.
- Since
- 1.34
- Returns
- 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).
Implemented in MediaWiki\User\User, and MediaWiki\User\UserIdentityValue.
Referenced by MediaWiki\User\UserEditTracker\clearUserEditCache(), MediaWiki\User\Registration\UserRegistrationLookup\getRegistration(), MediaWiki\Watchlist\WatchlistManager\getTitleNotificationTimestamp(), MediaWiki\Parser\Parser\getUserSig(), MediaWiki\Watchlist\WatchedItemStore\getWatchedItem(), MediaWiki\Watchlist\WatchedItemQueryService\getWatchedItemsForUser(), MediaWiki\User\UserEditTracker\incrementUserEditCount(), MediaWiki\User\UserIdentityUtils\isNamed(), MediaWiki\Watchlist\WatchedItemStore\loadWatchedItemsBatch(), MediaWiki\Watchlist\WatchedItemStore\resetAllNotificationTimestampsForUser(), and MediaWiki\User\UserEditTracker\setCachedUserEditCount().
The documentation for this interface was generated from the following file:
- includes/User/UserIdentity.php
