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=null, FormOptions $opts) | |
| doBatchLookups () | |
| Called from getBody(), before getStartBody() is called and after doQuery() was called. More... | |
| formatRow ( $row) | |
| getIndexField () | |
| getQueryInfo () | |
 Public Member Functions inherited from UsersPager | |
| __construct (IContextSource $context=null, $par=null, $including=null) | |
| getAllGroups () | |
| Get a list of all explicit groups. More... | |
| getDefaultQuery () | |
| Preserve group and username offset parameters when paging. More... | |
| getPageHeader () | |
| 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=[]) | |
| 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 base IContextSource 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... | |
| getStats () | |
| Get the Stats object. More... | |
| getTiming () | |
| Get the Timing 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... | |
Protected Attributes | |
| string[] | $groups |
| FormOptions | $opts |
| Protected Attributes inherited from UsersPager | |
| array | $userGroupCache |
| A array with user ids as key and a array of groups as value. 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... | |
Private Attributes | |
| array | $blockStatusByUid |
Additional Inherited Members | |
| Public Attributes inherited from IndexPager | |
| $mDb | |
| $mDefaultDirection | |
| $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More... | |
| $mDefaultLimit = 50 | |
| $mDefaultQuery | |
| $mFirstShown | |
| $mIsBackwards | |
| $mIsFirst | |
| True if the current result set is the first one. More... | |
| $mIsLast | |
| $mLimit | |
| $mLimitsShown = [ 20, 50, 100, 250, 500 ] | |
| $mNavigationBar | |
| $mOffset | |
| $mPastTheEndIndex | |
| $mPastTheEndRow | |
| $mQueryDone = false | |
| $mRequest | |
| ResultWrapper | $mResult |
| Result object for the query. More... | |
| const | DIR_ASCENDING = false |
| Constants for the $mDefaultDirection field. More... | |
| const | DIR_DESCENDING = true |
| Protected Member Functions inherited from UsersPager | |
| buildGroupLink ( $group, $username) | |
| Format a link to a group description page. 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: 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 () | |
| 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... | |
| Static Protected Member Functions inherited from UsersPager | |
| static | getGroupMemberships ( $uid, $cache=null) |
| Get an associative array containing groups the specified user belongs to, and the relevant UserGroupMembership objects. More... | |
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 31 of file ActiveUsersPager.php.
Constructor & Destructor Documentation
◆ __construct()
| ActiveUsersPager::__construct | ( | IContextSource | $context = null, |
| FormOptions | $opts | ||
| ) |
- Parameters
-
IContextSource $context FormOptions $opts
Definition at line 52 of file ActiveUsersPager.php.
References ContextSource\$context, $opts, $username, ContextSource\getConfig(), FormOptions\getValue(), groups(), Title\makeTitleSafe(), and NS_USER.
Member Function Documentation
◆ doBatchLookups()
| ActiveUsersPager::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 UsersPager.
Definition at line 136 of file ActiveUsersPager.php.
References $dbr, $res, as, and IndexPager\getDatabase().
◆ formatRow()
| ActiveUsersPager::formatRow | ( | $row | ) |
- Parameters
-
stdClass $row
- Returns
- string
Reimplemented from UsersPager.
Definition at line 161 of file ActiveUsersPager.php.
References $groups, $lang, $user, as, UsersPager\buildGroupLink(), UsersPager\getGroupMemberships(), ContextSource\getLanguage(), ContextSource\msg(), User\newFromId(), Html\rawElement(), Linker\userLink(), and Linker\userToolLinks().
◆ getIndexField()
| ActiveUsersPager::getIndexField | ( | ) |
◆ getQueryInfo()
| ActiveUsersPager::getQueryInfo | ( | ) |
- Returns
- array
Reimplemented from UsersPager.
Definition at line 81 of file ActiveUsersPager.php.
References $dbr, $groups, $tables, as, ContextSource\getConfig(), IndexPager\getDatabase(), ContextSource\getUser(), groups(), NS_USER, RC_CATEGORIZE, RC_EXTERNAL, and wfTimestamp().
Member Data Documentation
◆ $blockStatusByUid
|
private |
Definition at line 46 of file ActiveUsersPager.php.
◆ $groups
|
protected |
Definition at line 41 of file ActiveUsersPager.php.
Referenced by formatRow(), and getQueryInfo().
◆ $opts
|
protected |
Definition at line 36 of file ActiveUsersPager.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- includes/specials/pagers/ActiveUsersPager.php
