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=null, $par=null)
	formatRow ($row)
	Abstract formatting function.
	getAllGroups ()
	Get a list of all explicit groups.
	getBody ()
	Get the formatted result list.
	getDefaultQuery ()
	Preserve group and username offset parameters when paging.
	getIndexField ()
	This function should be overridden to return the name of the index fi- eld.
	getPageHeader ()
	getQueryInfo ()
	This function should be overridden to provide all parameters needed for the main paged query.
Static Protected Member Functions
static	buildGroupLink ($group, $username)
	Format a link to a group description page.
static	getGroups ($uid)
	Get a list of groups the specified user belongs to.

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

Constructor & Destructor Documentation

UsersPager::__construct	(	IContextSource $	context = `null`,
		$	par = `null`
	)

Definition at line 37 of file SpecialListusers.php.

References ContextSource\$context, User\getAllGroups(), ContextSource\getRequest(), Title\makeTitleSafe(), and ContextSource\setContext().

Here is the call graph for this function:

Member Function Documentation

static UsersPager::buildGroupLink	(	$	group,
		$	username
	)		`[static, protected]`

Format a link to a group description page.

Parameters:

$group	String: group name
$username	String Username

Returns:: string

Definition at line 270 of file SpecialListusers.php.

References User\getGroupMember().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters:

$row	Object: database row

Returns:: String

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 128 of file SpecialListusers.php.

References $t, $wgEdititis, buildGroupLink(), getGroups(), ContextSource\getLanguage(), Linker\link(), Title\makeTitle(), wfMsgExt(), wfRunHooks(), and wfTimestamp().

Here is the call graph for this function:

UsersPager::getAllGroups ( )

Get a list of all explicit groups.

Returns:: array

Definition at line 228 of file SpecialListusers.php.

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

Referenced by getPageHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

UsersPager::getBody ( )

Get the formatted result list.

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

Returns:: String

Reimplemented from IndexPager.

Definition at line 172 of file SpecialListusers.php.

References LinkBatch\addObj(), IndexPager\doQuery(), and Title\makeTitleSafe().

Here is the call graph for this function:

UsersPager::getDefaultQuery ( )

Preserve group and username offset parameters when paging.

Returns:: array

Reimplemented from IndexPager.

Definition at line 241 of file SpecialListusers.php.

References wfRunHooks().

Here is the call graph for this function:

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

References $user, User\getImplicitGroups(), and User\newFromId().

Referenced by formatRow().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Returns:: string|Array

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 72 of file SpecialListusers.php.

UsersPager::getPageHeader ( )

Reimplemented in ActiveUsersPager.

Definition at line 186 of file SpecialListusers.php.

References $out, $self, $wgScript, Xml\checkLabel(), Xml\closeElement(), Xml\fieldset(), getAllGroups(), ContextSource\getTitle(), Html\hidden(), Xml\input(), Xml\label(), Xml\openElement(), Xml\option(), Xml\submitButton(), wfMsg(), and wfRunHooks().

Here is the call graph for this function:

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

Returns:: Array

Reimplemented from IndexPager.

Reimplemented in ActiveUsersPager.

Definition at line 76 of file SpecialListusers.php.

References $dbr, $options, ContextSource\getUser(), User\idFromName(), wfGetDB(), and wfRunHooks().

Here is the call graph for this function:

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

includes/specials/SpecialListusers.php

Public Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation