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.
	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.
	getDefaultQuery ()
	Preserve group and username offset parameters when paging.
	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.
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 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.
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

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.
	$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
Protected Member Functions inherited from UsersPager
	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 inherited from UsersPager
static	getGroupMemberships ( $uid, $cache=null)
	Get an associative array containing groups the specified user belongs to, and the relevant UserGroupMembership objects.

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 29 of file ActiveUsersPager.php.

Constructor & Destructor Documentation

__construct()

ActiveUsersPager::__construct	(	IContextSource	$context = null,
		FormOptions	$opts )

Parameters

IContextSource	$context
FormOptions	$opts

Definition at line 50 of file ActiveUsersPager.php.

References $context, $opts, $username, ContextSource\getConfig(), FormOptions\getValue(), and groups().

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 139 of file ActiveUsersPager.php.

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

formatRow()

ActiveUsersPager::formatRow

(

$row

)

Parameters

stdClass

$row

Returns

string

Reimplemented from UsersPager.

Definition at line 164 of file ActiveUsersPager.php.

References $groups, $lang, UsersPager\buildGroupLink(), UsersPager\getGroupMemberships(), ContextSource\getLanguage(), ContextSource\msg(), User\newFromId(), Linker\userLink(), and Linker\userToolLinks().

getIndexField()

ActiveUsersPager::getIndexField

(

)

Returns

string

Reimplemented from UsersPager.

Definition at line 75 of file ActiveUsersPager.php.

getQueryInfo()

ActiveUsersPager::getQueryInfo

(

)

Returns

array

Reimplemented from UsersPager.

Definition at line 79 of file ActiveUsersPager.php.

References $dbr, $groups, $tables, ContextSource\getConfig(), IndexPager\getDatabase(), ContextSource\getUser(), groups(), NS_USER, RC_CATEGORIZE, RC_EXTERNAL, and wfTimestamp().

Member Data Documentation

$blockStatusByUid

array ActiveUsersPager::$blockStatusByUid

private

Definition at line 44 of file ActiveUsersPager.php.

$groups

string [] ActiveUsersPager::$groups

protected

Definition at line 39 of file ActiveUsersPager.php.

Referenced by formatRow(), and getQueryInfo().

$opts

FormOptions ActiveUsersPager::$opts

protected

Definition at line 34 of file ActiveUsersPager.php.

Referenced by __construct().

---

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

• includes/specials/pagers/ActiveUsersPager.php