UsersPager Class Reference

This class is used to get a list of user. More...

Inheritance diagram for UsersPager:

Collaboration diagram for UsersPager:

List of all members.

Public Member Functions
	__construct (IContextSource $context=null, $par=null, $including=null)
	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.
	formatRow ($row)
	getAllGroups ()
	Get a list of all explicit groups.
	getDefaultQuery ()
	Preserve group and username offset parameters when paging.
	getIndexField ()
	getPageHeader ()
	getQueryInfo ()
Static Protected Member Functions
static	buildGroupLink ($group, $username)
	Format a link to a group description page.
static	getGroups ($uid)
	Get a list of groups the specified user belongs to.

---

Detailed Description

This class is used to get a list of user.

The ones with specials rights (sysop, bureaucrat, developer) will have them displayed next to their names.

Definition at line 35 of file SpecialListusers.php.

---

Constructor & Destructor Documentation

UsersPager::__construct	(	IContextSource $	context = null,
		$	par = null,
		$	including = null
	)

Parameters:

$context	IContextSource
$par	array (Default null)
$including	boolean Whether this page is being transcluded in another page

Reimplemented in ActiveUsersPager.

Definition at line 43 of file SpecialListusers.php.

References ContextSource\$context, array(), User\getAllGroups(), ContextSource\getRequest(), Title\makeTitleSafe(), and ContextSource\setContext().

---

Member Function Documentation

static UsersPager::buildGroupLink	(	$	group,
		$	username
	)		[static, protected]

Format a link to a group description page.

Parameters:

$group	String: group name
$username	String Username

Returns:

string

Definition at line 295 of file SpecialListusers.php.

References User\getGroupMember().

Referenced by formatRow().

UsersPager::doBatchLookups

(

)

Called from getBody(), before getStartBody() is called and after doQuery() was called.

This will be called only if there are rows in the result set.

Returns:

void

Reimplemented from IndexPager.

Definition at line 195 of file SpecialListusers.php.

References $batch, and as.

UsersPager::formatRow

(

$

row

)

Parameters:

$row

Object

Returns:

String

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 148 of file SpecialListusers.php.

References $t, $user, array(), as, Bug, buildGroupLink(), getGroups(), ContextSource\getLanguage(), ContextSource\getUser(), global, ContextSource\msg(), Html\rawElement(), Linker\userLink(), Linker\userToolLinksRedContribs(), and wfRunHooks().

UsersPager::getAllGroups

(

)

Get a list of all explicit groups.

Returns:

array

Definition at line 251 of file SpecialListusers.php.

References $result, array(), as, User\getAllGroups(), and User\getGroupName().

Referenced by getPageHeader().

UsersPager::getDefaultQuery

(

)

Preserve group and username offset parameters when paging.

Returns:

array

Reimplemented from IndexPager.

Definition at line 264 of file SpecialListusers.php.

References $query, array(), and wfRunHooks().

static UsersPager::getGroups

(

$

uid

)

[static, protected]

Get a list of groups the specified user belongs to.

Parameters:

$uid	Integer: user id

Returns:

array

Definition at line 282 of file SpecialListusers.php.

References $user, User\getImplicitGroups(), and User\newFromId().

Referenced by formatRow().

UsersPager::getIndexField

(

)

Returns:

string

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 82 of file SpecialListusers.php.

UsersPager::getPageHeader

(

)

Returns:

string

Reimplemented in ActiveUsersPager.

Definition at line 209 of file SpecialListusers.php.

References $out, $self, array(), as, Xml\checkLabel(), Xml\closeElement(), Xml\fieldset(), getAllGroups(), ContextSource\getTitle(), global, Html\hidden(), Xml\input(), Xml\label(), list, ContextSource\msg(), Xml\openElement(), Xml\option(), Xml\submitButton(), text, and wfRunHooks().

UsersPager::getQueryInfo

(

)

Returns:

Array

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 89 of file SpecialListusers.php.

References $dbr, $options, $query, array(), ContextSource\getUser(), User\idFromName(), wfGetDB(), and wfRunHooks().

---

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

• includes/specials/SpecialListusers.php