MediaWiki  master
UserArray Class Reference
Inheritance diagram for UserArray:
Collaboration diagram for UserArray:

Public Member Functions

 current ()
 
 key ()
 

Static Public Member Functions

static newFromIDs ( $ids)
 
static newFromNames ( $names)
 
static newFromResult ( $res)
 

Detailed Description

Definition at line 25 of file UserArray.php.

Member Function Documentation

◆ current()

UserArray::current ( )
abstract
Returns
User

Reimplemented in UserArrayFromResult.

◆ key()

UserArray::key ( )
abstract
Returns
int

Reimplemented in UserArrayFromResult.

◆ newFromIDs()

static UserArray::newFromIDs (   $ids)
static
Note
Try to avoid in new code, in case getting UserIdentity batch is enough, use (). In case you need full User objects, you can keep using this method, but it's moving towards deprecation.
Parameters
array$ids
Returns
UserArrayFromResult|ArrayIterator

Definition at line 52 of file UserArray.php.

References $dbr, $res, DB_REPLICA, User\getQueryInfo(), newFromResult(), and wfGetDB().

Referenced by EmailNotification\actuallyNotifyOnPageChange(), and User\findUsersByGroup().

◆ newFromNames()

static UserArray::newFromNames (   $names)
static
Note
Try to avoid in new code, in case getting UserIdentity batch is enough, use (). In case you need full User objects, you can keep using this method, but it's moving towards deprecation.
Since
1.25
Parameters
array$names
Returns
UserArrayFromResult|ArrayIterator

Definition at line 81 of file UserArray.php.

References $dbr, $res, DB_REPLICA, User\getQueryInfo(), newFromResult(), and wfGetDB().

◆ newFromResult()

static UserArray::newFromResult (   $res)
static
Note
Try to avoid in new code, in case getting UserIdentity batch is enough, use (). In case you need full User objects, you can keep using this method, but it's moving towards deprecation.
Parameters
IResultWrapper$res
Returns
UserArrayFromResult

Definition at line 35 of file UserArray.php.

References $res, and Hooks\runner().

Referenced by newFromIDs(), and newFromNames().


The documentation for this class was generated from the following file: