4dce6dd0c3
Note: User::getActorId() is not (yet) deprecated. Bug: T274179 Change-Id: Ic2ca6d489db821fc2334e53bf2496c7b0d3ea5b1
90 lines
2.8 KiB
PHP
90 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* Interface for objects representing user 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 MediaWiki\DAO\WikiAwareEntity;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
interface UserIdentity extends WikiAwareEntity {
|
|
|
|
/**
|
|
* @since 1.31
|
|
*
|
|
* @param string|false $wikiId The wiki ID expected by the caller
|
|
* @return int The user ID. May be 0 for anonymous users or for users with no local account.
|
|
*
|
|
*/
|
|
public function getId( $wikiId = self::LOCAL ) : int;
|
|
|
|
/**
|
|
* @since 1.31
|
|
*
|
|
* @return string The user's logical name. May be an IPv4 or IPv6 address for anonymous users.
|
|
*/
|
|
public function getName() : string;
|
|
|
|
/**
|
|
* @since 1.31
|
|
*
|
|
* @param string|false $wikiId The wiki ID expected by the caller.
|
|
* Use self::LOCAL for the local wiki.
|
|
*
|
|
* @deprecated since 1.36, use ActorNormalization::findActorId() instead.
|
|
*
|
|
* @return int The user's actor ID. May be 0 if no actor ID is set.
|
|
*
|
|
* @note This will trigger a deprecation warning when $wikiId mismatches $this->getWikiId().
|
|
* In the future, it will throw PreconditionException.
|
|
*/
|
|
public function getActorId( $wikiId = self::LOCAL ) : int;
|
|
|
|
// TODO: we may want to (optionally?) provide a global ID, see CentralIdLookup.
|
|
|
|
/**
|
|
* @since 1.32
|
|
*
|
|
* @param UserIdentity $user
|
|
* @return bool
|
|
*/
|
|
public function equals( UserIdentity $user ) : bool;
|
|
|
|
/**
|
|
* @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 must be
|
|
* equivalent to getId() != 0 and is provided for code readability.
|
|
*/
|
|
public function isRegistered() : bool;
|
|
}
|