MediaWiki  REL1_31
UserArray.php
Go to the documentation of this file.
1 <?php
24 
25 abstract class UserArray implements Iterator {
30  static function newFromResult( $res ) {
31  $userArray = null;
32  if ( !Hooks::run( 'UserArrayFromResult', [ &$userArray, $res ] ) ) {
33  return null;
34  }
35  if ( $userArray === null ) {
36  $userArray = self::newFromResult_internal( $res );
37  }
38  return $userArray;
39  }
40 
45  static function newFromIDs( $ids ) {
46  $ids = array_map( 'intval', (array)$ids ); // paranoia
47  if ( !$ids ) {
48  // Database::select() doesn't like empty arrays
49  return new ArrayIterator( [] );
50  }
51  $dbr = wfGetDB( DB_REPLICA );
52  $userQuery = User::getQueryInfo();
53  $res = $dbr->select(
54  $userQuery['tables'],
55  $userQuery['fields'],
56  [ 'user_id' => array_unique( $ids ) ],
57  __METHOD__,
58  [],
59  $userQuery['joins']
60  );
61  return self::newFromResult( $res );
62  }
63 
69  static function newFromNames( $names ) {
70  $names = array_map( 'strval', (array)$names ); // paranoia
71  if ( !$names ) {
72  // Database::select() doesn't like empty arrays
73  return new ArrayIterator( [] );
74  }
75  $dbr = wfGetDB( DB_REPLICA );
76  $userQuery = User::getQueryInfo();
77  $res = $dbr->select(
78  $userQuery['tables'],
79  $userQuery['fields'],
80  [ 'user_name' => array_unique( $names ) ],
81  __METHOD__,
82  [],
83  $userQuery['joins']
84  );
85  return self::newFromResult( $res );
86  }
87 
92  protected static function newFromResult_internal( $res ) {
93  return new UserArrayFromResult( $res );
94  }
95 }
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$res
$res
Definition: database.txt:21
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
$dbr
$dbr
Definition: testCompression.php:50
Wikimedia\Rdbms\IResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: IResultWrapper.php:24
UserArray\newFromResult_internal
static newFromResult_internal( $res)
Definition: UserArray.php:92
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
UserArrayFromResult
Definition: UserArrayFromResult.php:25
UserArray\newFromResult
static newFromResult( $res)
Definition: UserArray.php:30
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
UserArray
Definition: UserArray.php:25
UserArray\newFromIDs
static newFromIDs( $ids)
Definition: UserArray.php:45
UserArray\newFromNames
static newFromNames( $names)
Definition: UserArray.php:69
User\getQueryInfo
static getQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new user object.
Definition: User.php:5672
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203