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

Inheritance diagram for UsersPager:

[legend]

Collaboration diagram for UsersPager:

[legend]

Public Member Functions
	__construct (IContextSource $context=null, $par=null, $including=null)

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

	formatRow ( $row)

	getAllGroups ()
	Get a list of all explicit groups. More...

	getDefaultQuery ()
	Preserve group and username offset parameters when paging. More...

	getIndexField ()

	getPageHeader ()

	getQueryInfo ()

Public Member Functions inherited from AlphabeticPager
	getNavigationBar ()
	Shamelessly stolen bits from ReverseChronologicalPager, didn't want to do class magic as may be still revamped. More...

Public Member Functions inherited from IndexPager
	__construct (IContextSource $context=null)

	doQuery ()
	Do the query, using information from the object context. More...

	extractResultInfo ( $isFirst, $limit, ResultWrapper $res)
	Extract some useful data from the result object for use by the navigation bar, put it into $this. More...

	getBody ()
	Get the formatted result list. More...

	getDatabase ()
	Get the Database object in use. More...

	getLimit ()
	Get the current limit. More...

	getLimitLinks ()

	getNumRows ()
	Get the number of rows in the result set. More...

	getPagingLinks ( $linkTexts, $disabledTexts=array())
	Get paging links. More...

	getPagingQueries ()
	Get a URL query array for the prev, next, first and last links. More...

	getResult ()

	getSqlComment ()
	Get some text to go in brackets in the "function name" part of the SQL comment. More...

	isNavigationBarShown ()
	Returns whether to show the "navigation bar". More...

	makeLink ( $text, array $query=null, $type=null)
	Make a self-link. More...

	reallyDoQuery ( $offset, $limit, $descending)
	Do a query with specified parameters, rather than using the object context. More...

	setIncludeOffset ( $include)
	Set whether a row matching exactly the offset should be also included in the result or not. More...

	setLimit ( $limit)
	Set the limit from an other source than the request. More...

	setOffset ( $offset)
	Set the offset from an other source than the request. More...

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage(). More...

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID. More...

	getConfig ()
	Get the Config object. More...

	getContext ()
	Get the RequestContext object. More...

	getLang ()
	Get the Language object. More...

	getLanguage ()
	Get the Language object. More...

	getOutput ()
	Get the OutputPage object. More...

	getRequest ()
	Get the WebRequest object. More...

	getSkin ()
	Get the Skin object. More...

	getTitle ()
	Get the Title object. More...

	getUser ()
	Get the User object. More...

	getWikiPage ()
	Get the WikiPage object. More...

	msg ()
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)
	Set the IContextSource object. More...

Static Protected Member Functions
static	buildGroupLink ( $group, $username)
	Format a link to a group description page. More...

static	getGroups ( $uid)
	Get a list of groups the specified user belongs to. More...

Additional Inherited Members
Public Attributes inherited from IndexPager
	$mDb

	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: false for ascending, true for descending. More...

	$mDefaultLimit = 50

	$mDefaultQuery

	$mFirstShown

	$mIsBackwards

	$mIsFirst
	True if the current result set is the first one. More...

	$mIsLast

	$mLimit

	$mLimitsShown = array( 20, 50, 100, 250, 500 )

	$mNavigationBar

	$mOffset

	$mPastTheEndIndex

	$mPastTheEndRow

	$mQueryDone = false

	$mRequest

ResultWrapper	$mResult
	Result object for the query. More...

Protected Member Functions inherited from AlphabeticPager
	getOrderTypeMessages ()
	If this supports multiple order type messages, give the message key for enabling each one in getNavigationBar. More...

Protected Member Functions inherited from IndexPager
	buildQueryInfo ( $offset, $limit, $descending)
	Build variables to use by the database wrapper. More...

	getDefaultDirections ()
	Return the default sorting direction: false for ascending, true for descending. More...

	getEmptyBody ()
	Hook into getBody(), for the bit between the start and the end when there are no rows. More...

	getEndBody ()
	Hook into getBody() for the end of the list. More...

	getExtraSortFields ()
	This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More...

	getStartBody ()
	Hook into getBody(), allows text to be inserted at the start. More...

	preprocessResults ( $result)
	Pre-process results; useful for performing batch existence checks, etc. More...

Protected Attributes inherited from IndexPager
	$mExtraSortFields
	An array of secondary columns to order by. More...

	$mIncludeOffset = false
	Whether to include the offset in the query. More...

	$mIndexField
	The index to actually be used for ordering. More...

	$mLastShown

	$mOrderType
	For pages that support multiple types of ordering, which one to use. More...

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

◆ __construct()

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

Parameters

	$context	IContextSource
array	$par	(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(), NS_USER, and ContextSource\setContext().

Member Function Documentation

◆ buildGroupLink()

static UsersPager::buildGroupLink	(	$group,
		$username
	)

staticprotected

Format a link to a group description page.

Parameters

string	$group	group name
string	$username	Username

Returns: string

Definition at line 353 of file SpecialListusers.php.

References User\getGroupMember().

Referenced by ActiveUsersPager\formatRow(), and formatRow().

◆ doBatchLookups()

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.

Reimplemented in ActiveUsersPager.

Definition at line 220 of file SpecialListusers.php.

References $batch, as, NS_USER, and NS_USER_TALK.

◆ formatRow()

UsersPager::formatRow ( $row )

Parameters

$row Object

Returns: String

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 160 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().

◆ getAllGroups()

UsersPager::getAllGroups ( )

Get a list of all explicit groups.

Returns: array

Definition at line 306 of file SpecialListusers.php.

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

Referenced by getPageHeader().

◆ getDefaultQuery()

UsersPager::getDefaultQuery ( )

Preserve group and username offset parameters when paging.

Returns: array

Reimplemented from IndexPager.

Definition at line 320 of file SpecialListusers.php.

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

◆ getGroups()

static UsersPager::getGroups ( $uid )

staticprotected

Get a list of groups the specified user belongs to.

Parameters

$uid	Integer: user id

Returns: array

Definition at line 339 of file SpecialListusers.php.

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

Referenced by formatRow().

◆ getIndexField()

UsersPager::getIndexField ( )

Returns: string

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 90 of file SpecialListusers.php.

◆ getPageHeader()

UsersPager::getPageHeader ( )

Returns: string

Reimplemented in ActiveUsersPager.

Definition at line 234 of file SpecialListusers.php.

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

◆ getQueryInfo()

UsersPager::getQueryInfo ( )

Returns: Array

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 97 of file SpecialListusers.php.

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

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

includes/specials/SpecialListusers.php

Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildGroupLink()

◆ doBatchLookups()

◆ formatRow()

◆ getAllGroups()

◆ getDefaultQuery()

◆ getGroups()

◆ getIndexField()

◆ getPageHeader()

◆ getQueryInfo()