MediaWiki\User\UserArray Class Reference

Class to walk into a list of User objects. More...

Inherits Iterator, and Countable.

Inherited by MediaWiki\User\UserArrayFromResult.

Collaboration diagram for MediaWiki\User\UserArray:

Public Member Functions
	count ()
	current ()
	key ()

Static Public Member Functions
static	newFromIDs (array $ids)
static	newFromNames (array $names)
static	newFromResult ( $res)

Detailed Description

Class to walk into a list of User objects.

Definition at line 33 of file UserArray.php.

Member Function Documentation

count()

MediaWiki\User\UserArray::count ( )

abstract

Reimplemented in MediaWiki\User\UserArrayFromResult.

current()

MediaWiki\User\UserArray::current ( )

abstract

Reimplemented in MediaWiki\User\UserArrayFromResult.

key()

MediaWiki\User\UserArray::key ( )

abstract

Reimplemented in MediaWiki\User\UserArrayFromResult.

newFromIDs()

static MediaWiki\User\UserArray::newFromIDs ( array $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

int[]

$ids

Returns

self

Definition at line 61 of file UserArray.php.

Referenced by MediaWiki\User\User\findUsersByGroup().

newFromNames()

static MediaWiki\User\UserArray::newFromNames ( array $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

string[]

$names

Returns

self

Definition at line 85 of file UserArray.php.

newFromResult()

static MediaWiki\User\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

self

Definition at line 43 of file UserArray.php.

---

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

• includes/user/UserArray.php