MediaWiki  master
ActiveUsersPager Class Reference

This class is used to get a list of active users. More...

Inheritance diagram for ActiveUsersPager:
Collaboration diagram for ActiveUsersPager:

Public Member Functions

 __construct (IContextSource $context, HookContainer $hookContainer, LinkBatchFactory $linkBatchFactory, ILoadBalancer $loadBalancer, UserGroupManager $userGroupManager, FormOptions $opts)
 
 formatRow ( $row)
 
 getIndexField ()
 
 getQueryInfo ( $data=null)
 
- Public Member Functions inherited from UsersPager
 __construct (IContextSource $context, HookContainer $hookContainer, LinkBatchFactory $linkBatchFactory, ILoadBalancer $loadBalancer, UserGroupManager $userGroupManager, $par, $including)
 
 getDefaultQuery ()
 Preserve group and username offset parameters when paging. More...
 
 getPageHeader ()
 
 getQueryInfo ()
 
- Public Member Functions inherited from AlphabeticPager
 getNavigationBar ()
 
- 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...
 
 getModuleStyles ()
 ResourceLoader modules that must be loaded to provide correct styling for this pager. More...
 
 getNavigationBuilder ()
 @stable to override More...
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getOffsetQuery ()
 Get the current offset for the URL query parameter. 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...
 
 getActionName ()
 Get the action name for the current web request. 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 ()
 
 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)
 

Protected Member Functions

 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
- Protected Member Functions inherited from UsersPager
 buildGroupLink ( $group, $username)
 Format a link to a group description page. More...
 
 canSeeHideuser ()
 
 getGroupMemberships ( $user)
 Get an associative array containing groups the specified user belongs to, and the relevant UserGroupMembership objects. 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...
 
 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...
 
 getFooter ()
 Classes can extend to output a footer at the bottom of the pager list. More...
 
 getLimitLinks ()
 
 getLinkRenderer ()
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getRow ( $row)
 Get the HTML of a pager row. 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". 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

string[] $groups
 
FormOptions $opts
 
- Protected Attributes inherited from UsersPager
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
 

Additional Inherited Members

- Public Attributes inherited from UsersPager
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...
 
- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 

Detailed Description

This class is used to get a list of active users.

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

Definition at line 36 of file ActiveUsersPager.php.

Constructor & Destructor Documentation

◆ __construct()

ActiveUsersPager::__construct ( IContextSource  $context,
HookContainer  $hookContainer,
LinkBatchFactory  $linkBatchFactory,
ILoadBalancer  $loadBalancer,
UserGroupManager  $userGroupManager,
FormOptions  $opts 
)
Parameters
IContextSource$context
HookContainer$hookContainer
LinkBatchFactory$linkBatchFactory
ILoadBalancer$loadBalancer
UserGroupManager$userGroupManager
FormOptions$opts

Definition at line 67 of file ActiveUsersPager.php.

References $opts, ContextSource\getConfig(), FormOptions\getValue(), Title\makeTitleSafe(), and NS_USER.

Member Function Documentation

◆ buildQueryInfo()

ActiveUsersPager::buildQueryInfo (   $offset,
  $limit,
  $order 
)
protected

Build variables to use by the database wrapper.

Note
For b/c, query direction is true for ascending and false for descending
Stability: stable
to override
Parameters
int | string$offsetIndex offset, inclusive
int$limitExact query limit
bool$orderIndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING
Returns
array

Reimplemented from IndexPager.

Definition at line 185 of file ActiveUsersPager.php.

References IndexPager\getDatabase(), UsersPager\getQueryInfo(), and IndexPager\getSqlComment().

◆ doBatchLookups()

ActiveUsersPager::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 UsersPager.

Definition at line 217 of file ActiveUsersPager.php.

References $dbr, $res, and IndexPager\getDatabase().

◆ formatRow()

ActiveUsersPager::formatRow (   $row)

◆ getIndexField()

ActiveUsersPager::getIndexField ( )
Returns
string

Reimplemented from UsersPager.

Definition at line 107 of file ActiveUsersPager.php.

◆ getQueryInfo()

Member Data Documentation

◆ $groups

string [] ActiveUsersPager::$groups
protected

Definition at line 46 of file ActiveUsersPager.php.

Referenced by formatRow(), and getQueryInfo().

◆ $opts

FormOptions ActiveUsersPager::$opts
protected

Definition at line 41 of file ActiveUsersPager.php.

Referenced by __construct().


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