Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
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 IDBAccessObject; |
24 | use InvalidArgumentException; |
25 | use Wikimedia\Rdbms\IReadableDatabase; |
26 | |
27 | /** |
28 | * Service for looking up UserIdentity |
29 | * |
30 | * @package MediaWiki\User |
31 | * @since 1.36 |
32 | */ |
33 | interface UserIdentityLookup { |
34 | |
35 | /** |
36 | * Find an identity of a user by $name |
37 | * |
38 | * @param string $name |
39 | * @param int $queryFlags one of IDBAccessObject constants |
40 | * @return UserIdentity|null |
41 | * @throws InvalidArgumentException if non-normalizable actor name is passed. |
42 | */ |
43 | public function getUserIdentityByName( |
44 | string $name, |
45 | int $queryFlags = IDBAccessObject::READ_NORMAL |
46 | ): ?UserIdentity; |
47 | |
48 | /** |
49 | * Find an identity of a user by $userId |
50 | * |
51 | * @param int $userId |
52 | * @param int $queryFlags one of IDBAccessObject constants |
53 | * @return UserIdentity|null |
54 | */ |
55 | public function getUserIdentityByUserId( |
56 | int $userId, |
57 | int $queryFlags = IDBAccessObject::READ_NORMAL |
58 | ): ?UserIdentity; |
59 | |
60 | /** |
61 | * Returns a specialized SelectQueryBuilder for querying the UserIdentity objects. |
62 | * |
63 | * @param IReadableDatabase|int $dbOrQueryFlags The database connection to perform the query on, |
64 | * or one of the IDBAccessObject::READ_* constants. |
65 | * @return UserSelectQueryBuilder |
66 | */ |
67 | public function newSelectQueryBuilder( $dbOrQueryFlags = IDBAccessObject::READ_NORMAL ): UserSelectQueryBuilder; |
68 | } |