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, $par, $including, LinkBatchFactory $linkBatchFactory, HookContainer $hookContainer, ILoadBalancer $loadBalancer, UserGroupManager $userGroupManager)

	formatRow ( $row)

	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, LinkRenderer $linkRenderer=null)

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

	getBody ()
	Get the formatted result list.

	getDatabase ()
	Get the Database object in use.

	getLimit ()
	Get the current limit.

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

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

	getResult ()

	reallyDoQuery ( $offset, $limit, $order)
	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.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)

Public Attributes
string	$requestedGroup

Public Attributes inherited from IndexPager
IDatabase	$mDb

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

int	$mDefaultLimit = 50
	The default entry limit choosen for clients.

bool	$mIsBackwards

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

bool	$mIsLast

int	$mLimit
	The maximum number of entries to show.

int[]	$mLimitsShown = [ 20, 50, 100, 250, 500 ]
	List of default entry limit options to be presented to clients.

mixed	$mOffset
	The starting point to enumerate entries.

stdClass bool null	$mPastTheEndRow
	Extra row fetched at the end to see if the end was reached.

bool	$mQueryDone = false
	Whether the listing query completed.

WebRequest	$mRequest

IResultWrapper	$mResult
	Result object for the query.

const	DIR_ASCENDING = false
	Backwards-compatible constant for $mDefaultDirection field (do not change)

const	DIR_DESCENDING = true
	Backwards-compatible constant for $mDefaultDirection field (do not change)

const	QUERY_ASCENDING = true
	Backwards-compatible constant for reallyDoQuery() (do not change)

const	QUERY_DESCENDING = false
	Backwards-compatible constant for reallyDoQuery() (do not change)

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

	canSeeHideuser ()

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

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

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
	buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	buildQueryInfo ( $offset, $limit, $order)
	Build variables to use by the database wrapper.

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

	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 ()
	Returns the names of secondary columns to order by in addition to the column in getIndexField().

	getLimitLinks ()

	getLinkRenderer ()

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

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

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

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

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

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

Protected Attributes
bool	$creationSort

bool	$editsOnly

bool null	$including

string	$requestedUser

bool	$temporaryGroupsOnly

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

Protected Attributes inherited from IndexPager
array	$mDefaultQuery

string[]	$mExtraSortFields
	An array of secondary columns to order by.

array	$mFirstShown

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

string string[]	$mIndexField
	The index to actually be used for ordering.

array	$mLastShown

string	$mNavigationBar

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

array	$mPastTheEndIndex

Private Member Functions
	getAllGroups ()
	Get a list of all explicit groups.

Private Attributes
HookRunner	$hookRunner

LinkBatchFactory	$linkBatchFactory

UserGroupManager	$userGroupManager

Additional Inherited Members
Static Protected Member Functions inherited from IndexPager
static	oppositeOrder ( $order)

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

Constructor & Destructor Documentation

◆ __construct()

UsersPager::__construct	(	?IContextSource	$context,
			$par,
			$including,
		LinkBatchFactory	$linkBatchFactory,
		HookContainer	$hookContainer,
		ILoadBalancer	$loadBalancer,
		UserGroupManager	$userGroupManager
	)

Parameters

IContextSource \| null	$context
string \| null	$par
bool \| null	$including	Whether this page is being transcluded in another page
LinkBatchFactory	$linkBatchFactory
HookContainer	$hookContainer
ILoadBalancer	$loadBalancer
UserGroupManager	$userGroupManager

Definition at line 85 of file UsersPager.php.

References $including, IndexPager\DIR_ASCENDING, IndexPager\DIR_DESCENDING, Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), ContextSource\getRequest(), MediaWiki\User\UserGroupManager\listAllGroups(), NS_USER, 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 486 of file UsersPager.php.

References getContext().

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

◆ canSeeHideuser()

UsersPager::canSeeHideuser ( )

protected

Definition at line 429 of file UsersPager.php.

References getAuthority().

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

◆ doBatchLookups()

UsersPager::doBatchLookups ( )

protected

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.

Stability: stable: to override

Returns: void

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 283 of file UsersPager.php.

References $cache, $dbr, IndexPager\getDatabase(), NS_USER, and NS_USER_TALK.

◆ formatRow()

UsersPager::formatRow ( $row )

Parameters

stdClass $row

Returns: string

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

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

private

Get a list of all explicit groups.

Returns: array

Definition at line 437 of file UsersPager.php.

Referenced by getPageHeader().

◆ getDefaultQuery()

UsersPager::getDefaultQuery ( )

Preserve group and username offset parameters when paging.

Returns: array

Reimplemented from IndexPager.

Definition at line 451 of file UsersPager.php.

◆ getGroupMemberships()

UsersPager::getGroupMemberships ( $user )

protected

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

Parameters

UserIdentity $user

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

Definition at line 471 of file UsersPager.php.

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

◆ getIndexField()

UsersPager::getIndexField ( )

Returns: string

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 148 of file UsersPager.php.

◆ getPageHeader()

UsersPager::getPageHeader ( )

Returns: string

Definition at line 334 of file UsersPager.php.

References $self, getAllGroups(), getContext(), getTitle(), and ContextSource\msg().

◆ getQueryInfo()

UsersPager::getQueryInfo ( )

Returns: array

Reimplemented from IndexPager.

Definition at line 155 of file UsersPager.php.

References $dbr, canSeeHideuser(), IndexPager\getDatabase(), and User\idFromName().

Referenced by ActiveUsersPager\buildQueryInfo().

Member Data Documentation

◆ $creationSort

bool UsersPager::$creationSort

protected

Definition at line 58 of file UsersPager.php.

◆ $editsOnly

bool UsersPager::$editsOnly

protected

Definition at line 52 of file UsersPager.php.

◆ $hookRunner

HookRunner UsersPager::$hookRunner

private

Definition at line 70 of file UsersPager.php.

◆ $including

bool null UsersPager::$including

protected

Definition at line 61 of file UsersPager.php.

Referenced by __construct().

◆ $linkBatchFactory

LinkBatchFactory UsersPager::$linkBatchFactory

private

Definition at line 67 of file UsersPager.php.

Referenced by ActiveUsersPager\__construct().

◆ $requestedGroup

string UsersPager::$requestedGroup

Definition at line 49 of file UsersPager.php.

◆ $requestedUser

string UsersPager::$requestedUser

protected

Definition at line 64 of file UsersPager.php.

◆ $temporaryGroupsOnly

bool UsersPager::$temporaryGroupsOnly

protected

Definition at line 55 of file UsersPager.php.

◆ $userGroupCache

array [] UsersPager::$userGroupCache

protected

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

Definition at line 46 of file UsersPager.php.

◆ $userGroupManager

UserGroupManager UsersPager::$userGroupManager

private

Definition at line 73 of file UsersPager.php.

Referenced by ActiveUsersPager\__construct().

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

includes/specials/pagers/UsersPager.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildGroupLink()

◆ canSeeHideuser()

◆ doBatchLookups()

◆ formatRow()

◆ getAllGroups()

◆ getDefaultQuery()

◆ getGroupMemberships()

◆ getIndexField()

◆ getPageHeader()

◆ getQueryInfo()

Member Data Documentation

◆ $creationSort

◆ $editsOnly

◆ $hookRunner

◆ $including

◆ $linkBatchFactory

◆ $requestedGroup

◆ $requestedUser

◆ $temporaryGroupsOnly

◆ $userGroupCache

◆ $userGroupManager