Interface for objects representing user identity. More...
Public Member Functions | |
| equals (UserIdentity $user) | |
| getActorId () | |
| getId () | |
| getName () | |
Detailed Description
Interface for objects representing user identity.
This represents the identity of a user in the context of page revisions and log entries.
- Since
- 1.31
Definition at line 32 of file UserIdentity.php.
Member Function Documentation
◆ equals()
| MediaWiki\User\UserIdentity::equals | ( | UserIdentity | $user | ) |
- Since
- 1.32
- Parameters
-
UserIdentity $user
- Returns
- bool
Implemented in User, and MediaWiki\User\UserIdentityValue.
◆ getActorId()
| MediaWiki\User\UserIdentity::getActorId | ( | ) |
- Since
- 1.31
- Returns
- int The user's actor ID. May be 0 if no actor ID is set.
Implemented in MediaWiki\User\UserIdentityValue.
Referenced by User\newFromIdentity().
◆ getId()
| MediaWiki\User\UserIdentity::getId | ( | ) |
- Since
- 1.31
- Returns
- int The user ID. May be 0 for anonymous users or for users with no local account.
Implemented in User, and MediaWiki\User\UserIdentityValue.
Referenced by User\newFromIdentity().
◆ 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 User, and MediaWiki\User\UserIdentityValue.
Referenced by User\equals(), MediaWiki\User\UserIdentityValue\equals(), MediaWiki\Storage\DerivedPageDataUpdater\isReusableFor(), User\newFromIdentity(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareUpdate().
The documentation for this interface was generated from the following file:
- includes/user/UserIdentity.php
