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.

	formatRow ( $row)

	getAllGroups ()
	Get a list of all explicit groups.

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

	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.

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

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

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

	getBody ()
	Get the formatted result list.

	getDatabase ()
	Get the Database object in use.

	getLimit ()
	Get the current limit.

	getLimitLinks ()

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

	getPagingLinks ( $linkTexts, $disabledTexts=[])
	Get paging links.

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

	getResult ()

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

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

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

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

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

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

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

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

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

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)

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

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

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

	getDefaultDirections ()
	Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING.

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

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

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

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

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

Static Protected Member Functions
static	getGroupMemberships ( $uid, $cache=null)
	Get an associative array containing groups the specified user belongs to, and the relevant UserGroupMembership objects.

Protected Attributes
array[]	$userGroupCache
	A array with user ids as key and a array of groups as value.

Protected Attributes inherited from IndexPager
	$mDefaultQuery

	$mExtraSortFields
	An array of secondary columns to order by.

	$mFirstShown

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

	$mIndexField
	The index to actually be used for ordering.

	$mLastShown

	$mNavigationBar

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

	$mPastTheEndIndex

Additional Inherited Members
Public Attributes inherited from IndexPager
IDatabase	$mDb

	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.

	$mDefaultLimit = 50

	$mIsBackwards

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

	$mIsLast

	$mLimit

	$mLimitsShown = [ 20, 50, 100, 250, 500 ]

	$mOffset

	$mPastTheEndRow

	$mQueryDone = false

	$mRequest

IResultWrapper	$mResult
	Result object for the query.

const	DIR_ASCENDING = false
	Constants for the $mDefaultDirection field.

const	DIR_DESCENDING = true

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 33 of file UsersPager.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

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

Definition at line 46 of file UsersPager.php.

References ContextSource\$context, $request, $username, IndexPager\DIR_ASCENDING, IndexPager\DIR_DESCENDING, User\getAllGroups(), ContextSource\getRequest(), and ContextSource\setContext().

Member Function Documentation

◆ buildGroupLink()

UsersPager::buildGroupLink	(		$group,
			$username )

protected

Format a link to a group description page.

Parameters

string \| UserGroupMembership	$group	Group name or UserGroupMembership object
string	$username

Returns: string

Definition at line 425 of file UsersPager.php.

References $username, and ContextSource\getContext().

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 226 of file UsersPager.php.

References $batch, $cache, $dbr, DB_REPLICA, NS_USER_TALK, and wfGetDB().

◆ formatRow()

UsersPager::formatRow ( $row )

Parameters

stdClass $row

Returns: string

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 169 of file UsersPager.php.

References $lang, $t, buildGroupLink(), ContextSource\getConfig(), getGroupMemberships(), ContextSource\getLanguage(), ContextSource\getUser(), ContextSource\msg(), Linker\userLink(), and Linker\userToolLinksRedContribs().

◆ getAllGroups()

UsersPager::getAllGroups ( )

Get a list of all explicit groups.

Returns: array

Definition at line 374 of file UsersPager.php.

References $result, and User\getAllGroups().

Referenced by getPageHeader().

◆ getDefaultQuery()

UsersPager::getDefaultQuery ( )

Preserve group and username offset parameters when paging.

Returns: array

Reimplemented from IndexPager.

Definition at line 388 of file UsersPager.php.

References $query.

◆ getGroupMemberships()

static UsersPager::getGroupMemberships	(		$uid,
			$cache = null )

staticprotected

Get an associative array containing groups the specified user belongs to, and the relevant UserGroupMembership objects.

Parameters

int	$uid	User id
array[] \| null	$cache

Returns: UserGroupMembership[] (group name => UserGroupMembership object)

Definition at line 409 of file UsersPager.php.

References $cache, and User\newFromId().

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

◆ getIndexField()

UsersPager::getIndexField ( )

Returns: string

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 96 of file UsersPager.php.

◆ getPageHeader()

UsersPager::getPageHeader ( )

Returns: string

Definition at line 275 of file UsersPager.php.

References $formDescriptor, IndexPager\$mDefaultDirection, IndexPager\$mLimit, $self, getAllGroups(), ContextSource\getContext(), ContextSource\getTitle(), list, and ContextSource\msg().

◆ getQueryInfo()

UsersPager::getQueryInfo ( )

Returns: array

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 103 of file UsersPager.php.

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

Member Data Documentation

◆ $userGroupCache

array [] UsersPager::$userGroupCache

protected

A array with user ids as key and a array of groups as value.

Definition at line 38 of file UsersPager.php.

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

includes/specials/pagers/UsersPager.php

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildGroupLink()

◆ doBatchLookups()

◆ formatRow()

◆ getAllGroups()

◆ getDefaultQuery()

◆ getGroupMemberships()

◆ getIndexField()

◆ getPageHeader()

◆ getQueryInfo()

Member Data Documentation

◆ $userGroupCache