includes/user/UserIdentity.php

   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 /**
  26  * Interface for objects representing user identity.
  27  *
  28  * This represents the identity of a user in the context of page revisions and log entries.
  29  *
  30  * @since 1.31
  31  */
  32 interface UserIdentity {
  33
  34         /**
  35          * @since 1.31
  36          *
  37          * @return int The user ID. May be 0 for anonymous users or for users with no local account.
  38          */
  39         public function getId();
  40
  41         /**
  42          * @since 1.31
  43          *
  44          * @return string The user's logical name. May be an IPv4 or IPv6 address for anonymous users.
  45          */
  46         public function getName();
  47
  48         /**
  49          * @since 1.31
  50          *
  51          * @return int The user's actor ID. May be 0 if no actor ID is set.
  52          */
  53         public function getActorId();
  54
  55         // TODO: we may want to (optionally?) provide a global ID, see CentralIdLookup.
  56
  57         /**
  58          * @since 1.32
  59          *
  60          * @param UserIdentity $user
  61          * @return bool
  62          */
  63         public function equals( UserIdentity $user );
  64
  65         /**
  66          * @since 1.34
  67          *
  68          * @return bool True if user is registered on this wiki, i.e., has a user ID. False if user is
  69          *   anonymous or has no local account (which can happen when importing). This must be
  70          *   equivalent to getId() != 0 and is provided for code readability.
  71          */
  72         public function isRegistered();
  73 }