includes/user/UserIdentityLookup.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 namespace MediaWiki\User;
  22
  23 use InvalidArgumentException;
  24 use Wikimedia\Rdbms\IDBAccessObject;
  25 use Wikimedia\Rdbms\IReadableDatabase;
  26
  27 /**
  28  * Service for looking up UserIdentity
  29  *
  30  * Default implementation is MediaWiki\User\ActorStore.
  31  *
  32  * @since 1.36
  33  * @ingroup User
  34  */
  35 interface UserIdentityLookup {
  36
  37         /**
  38          * Find an identity of a user by $name
  39          *
  40          * @param string $name
  41          * @param int $queryFlags one of IDBAccessObject constants
  42          * @return UserIdentity|null
  43          * @throws InvalidArgumentException if non-normalizable actor name is passed.
  44          */
  45         public function getUserIdentityByName(
  46                 string $name,
  47                 int $queryFlags = IDBAccessObject::READ_NORMAL
  48         ): ?UserIdentity;
  49
  50         /**
  51          * Find an identity of a user by $userId
  52          *
  53          * @param int $userId
  54          * @param int $queryFlags one of IDBAccessObject constants
  55          * @return UserIdentity|null
  56          */
  57         public function getUserIdentityByUserId(
  58                 int $userId,
  59                 int $queryFlags = IDBAccessObject::READ_NORMAL
  60         ): ?UserIdentity;
  61
  62         /**
  63          * Returns a specialized SelectQueryBuilder for querying the UserIdentity objects.
  64          *
  65          * @param IReadableDatabase|int $dbOrQueryFlags The database connection to perform the query on,
  66          *   or one of the IDBAccessObject::READ_* constants.
  67          * @return UserSelectQueryBuilder
  68          */
  69         public function newSelectQueryBuilder( $dbOrQueryFlags = IDBAccessObject::READ_NORMAL ): UserSelectQueryBuilder;
  70 }