MediaWiki  master
UsersPager Class Reference

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

Inheritance diagram for UsersPager:
Collaboration diagram for UsersPager:

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. 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, LinkRenderer $linkRenderer=null)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getLimit ()
 Get the current limit. More...
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 getResultOffset ()
 
 reallyDoQuery ( $offset, $limit, $order)
 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...
 
 getAuthority ()
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 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. More...
 
int $mDefaultLimit = 50
 The default entry limit choosen for clients. More...
 
bool $mIsBackwards
 
bool $mIsFirst
 True if the current result set is the first one. More...
 
bool $mIsLast
 
int $mLimit
 The maximum number of entries to show. More...
 
int[] $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 List of default entry limit options to be presented to clients. More...
 
mixed $mOffset
 The starting point to enumerate entries. More...
 
stdClass bool null $mPastTheEndRow
 Extra row fetched at the end to see if the end was reached. More...
 
bool $mQueryDone = false
 Whether the listing query completed. More...
 
WebRequest $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const DIR_DESCENDING = true
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const QUERY_ASCENDING = true
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 
const QUERY_DESCENDING = false
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 

Protected Member Functions

 buildGroupLink ( $group, $username)
 Format a link to a group description page. More...
 
 canSeeHideuser ()
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
 getGroupMemberships ( $user)
 Get an associative array containing groups the specified user belongs to, and the relevant UserGroupMembership objects. 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
 buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper. More...
 
 extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. More...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_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 ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 getLimitLinks ()
 
 getLinkRenderer ()
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment. More...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar" @stable to override. More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

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. More...
 
- Protected Attributes inherited from IndexPager
array $mDefaultQuery
 
string[] $mExtraSortFields
 An array of secondary columns to order by. More...
 
array $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string string[] $mIndexField
 The index to actually be used for ordering. More...
 
array $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
array $mPastTheEndIndex
 

Private Member Functions

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

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$includingWhether 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 ContextSource\$context, $including, $linkBatchFactory, $userGroupManager, DB_REPLICA, IndexPager\DIR_ASCENDING, IndexPager\DIR_DESCENDING, Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), ContextSource\getRequest(), MediaWiki\User\UserGroupManager\listAllGroups(), Title\makeTitleSafe(), 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$groupGroup name or UserGroupMembership object
string$username
Returns
string

Definition at line 486 of file UsersPager.php.

References ContextSource\getContext(), and UserGroupMembership\getLink().

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

◆ canSeeHideuser()

UsersPager::canSeeHideuser ( )
protected

Definition at line 429 of file UsersPager.php.

References ContextSource\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.

@stable to override

Returns
void

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 283 of file UsersPager.php.

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

◆ formatRow()

UsersPager::formatRow (   $row)

◆ getAllGroups()

UsersPager::getAllGroups ( )
private

Get a list of all explicit groups.

Returns
array

Definition at line 437 of file UsersPager.php.

References UserGroupMembership\getGroupName().

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.

References $requestedGroup, and $requestedUser.

◆ 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()

◆ getQueryInfo()

UsersPager::getQueryInfo ( )
Returns
array

Reimplemented from IndexPager.

Definition at line 155 of file UsersPager.php.

References $dbr, $requestedGroup, 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.

Referenced by getPageHeader().

◆ $editsOnly

bool UsersPager::$editsOnly
protected

Definition at line 52 of file UsersPager.php.

Referenced by getPageHeader().

◆ $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 __construct(), and ActiveUsersPager\__construct().

◆ $requestedGroup

string UsersPager::$requestedGroup

Definition at line 49 of file UsersPager.php.

Referenced by getDefaultQuery(), getPageHeader(), and getQueryInfo().

◆ $requestedUser

string UsersPager::$requestedUser
protected

Definition at line 64 of file UsersPager.php.

Referenced by getDefaultQuery(), and getPageHeader().

◆ $temporaryGroupsOnly

bool UsersPager::$temporaryGroupsOnly
protected

Definition at line 55 of file UsersPager.php.

Referenced by getPageHeader().

◆ $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 __construct(), and ActiveUsersPager\__construct().


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