UsersPager Class Reference
[SpecialPage]

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

Inherits AlphabeticPager.

Inherited by ActiveUsersPager.

List of all members.

Public Member Functions

 __construct ($par=null)
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld.
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query.
 formatRow ($row)
 Abstract formatting function.
 getBody ()
 Get the formatted result list.
 getPageHeader ()
 getAllGroups ()
 Get a list of all explicit groups.
 getDefaultQuery ()
 Preserve group and username offset parameters when paging.

Static Protected Member Functions

static getGroups ($uid)
 Get a list of groups the specified user belongs to.
static buildGroupLink ($group)
 Format a link to a group description page.


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 36 of file SpecialListusers.php.


Constructor & Destructor Documentation

UsersPager::__construct ( par = null  ) 


Member Function Documentation

static UsersPager::buildGroupLink ( group  )  [static, protected]

Format a link to a group description page.

Parameters:
$group String: group name
Returns:
string

Definition at line 259 of file SpecialListusers.php.

References User::getGroupMember().

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

UsersPager::formatRow ( row  ) 

Abstract formatting function.

This should return an HTML string representing the result row $row. Rows will be concatenated and returned by getBody()

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 120 of file SpecialListusers.php.

References $name, $t, $wgEdititis, $wgLang, buildGroupLink(), IndexPager::getSkin(), Title::makeTitle(), wfMsg(), wfMsgExt(), wfRunHooks(), wfSpecialList(), and wfTimestamp().

UsersPager::getAllGroups (  ) 

Get a list of all explicit groups.

Returns:
array

Definition at line 218 of file SpecialListusers.php.

References $result, User::getAllGroups(), and User::getGroupName().

Referenced by getPageHeader().

UsersPager::getBody (  ) 

Get the formatted result list.

Calls getStartBody(), formatRow() and getEndBody(), concatenates the results and returns them.

Reimplemented from IndexPager.

Definition at line 163 of file SpecialListusers.php.

References IndexPager::doQuery(), and Title::makeTitleSafe().

UsersPager::getDefaultQuery (  ) 

Preserve group and username offset parameters when paging.

Returns:
array

Reimplemented from IndexPager.

Definition at line 231 of file SpecialListusers.php.

References wfRunHooks().

static UsersPager::getGroups ( uid  )  [static, protected]

Get a list of groups the specified user belongs to.

Parameters:
$uid Integer: user id
Returns:
array

Definition at line 247 of file SpecialListusers.php.

References User::newFromId().

UsersPager::getIndexField (  ) 

This function should be overridden to return the name of the index fi- eld.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &count=querykey will use indexfield to sort. In this case, the first returned key is the default.

Needless to say, it's really not a good idea to use a non-unique index for this! That won't page right.

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 69 of file SpecialListusers.php.

UsersPager::getPageHeader (  ) 

UsersPager::getQueryInfo (  ) 

This function should be overridden to provide all parameters needed for the main paged query.

It returns an associative array with the following elements: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => option array join_conds => JOIN conditions

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 73 of file SpecialListusers.php.

References $dbr, $wgUser, User::idFromName(), wfGetDB(), and wfRunHooks().


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

Generated on Sat Apr 30 22:57:52 2011 for MediaWiki by  doxygen 1.5.9