Pager for Special:Contributions. More...

Inheritance diagram for ContribsPager:

Collaboration diagram for ContribsPager:

Public Member Functions
	__construct (IContextSource $context, array $options)
	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.
	formatRow ($row)
	Generates each row in the contributions list.
	getDefaultQuery ()
	Get an array of query parameters that should be put into self-links.
	getEndBody ()
	getIndexField ()
	This function should be overridden to return the name of the index fi- eld.
	getNamespaceCond ()
	getPreventClickjacking ()
	getQueryInfo ()
	This function should be overridden to provide all parameters needed for the main paged query.
	getSqlComment ()
	Overwrite Pager function and return a helpful comment.
	getStartBody ()
	getUserCond ()
	reallyDoQuery ($offset, $limit, $descending)
	This method basically executes the exact same code as the parent class, though with a hook added, to allow extentions to add additional queries.
Public Attributes
	$mDb
DatabaseBase	$mDbSecondary
	*
	$mDefaultDirection = IndexPager::DIR_DESCENDING
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.
	$messages
	$namespace = ''
	$preventClickjacking = false
	$target
Protected Member Functions
	preventClickjacking ()
Protected Attributes
array	$mParentLens

Detailed Description

Pager for Special:Contributions.

Definition at line 654 of file SpecialContributions.php.

Constructor & Destructor Documentation

ContribsPager::__construct	(	IContextSource $	context,
		array $	options
	)

Definition at line 668 of file SpecialContributions.php.

Member Function Documentation

ContribsPager::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 IndexPager.

Definition at line 909 of file SpecialContributions.php.

ContribsPager::formatRow ( $ row )

Generates each row in the contributions list.

Contributions which are marked "top" are currently on top of the history. For these contributions, a [rollback] link is shown for users with roll- back privileges. The rollback link restores the most recent version that was not written by the target user.

Todo:: This would probably look a lot nicer in a table.

Parameters:

object $row

Returns:: string

Reimplemented from IndexPager.

Definition at line 958 of file SpecialContributions.php.

ContribsPager::getDefaultQuery ( )

Get an array of query parameters that should be put into self-links.

By default, all parameters passed in the URL are used, except for a short blacklist.

Returns:: array Associative array

Reimplemented from IndexPager.

Definition at line 707 of file SpecialContributions.php.

ContribsPager::getEndBody ( )

Returns:: string

Reimplemented from IndexPager.

Definition at line 942 of file SpecialContributions.php.

ContribsPager::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.

Definition at line 905 of file SpecialContributions.php.

ContribsPager::getNamespaceCond ( )

Definition at line 881 of file SpecialContributions.php.

ContribsPager::getPreventClickjacking ( )

Returns:: bool

Definition at line 1148 of file SpecialContributions.php.

ContribsPager::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.

Definition at line 783 of file SpecialContributions.php.

ContribsPager::getSqlComment ( )

Overwrite Pager function and return a helpful comment.

Returns:: string

Reimplemented from IndexPager.

Definition at line 1132 of file SpecialContributions.php.

ContribsPager::getStartBody ( )

Returns:: string

Reimplemented from IndexPager.

Definition at line 935 of file SpecialContributions.php.

ContribsPager::getUserCond ( )

Definition at line 834 of file SpecialContributions.php.

ContribsPager::preventClickjacking ( ) [protected]

Definition at line 1141 of file SpecialContributions.php.

ContribsPager::reallyDoQuery	(	$	offset,
		$	limit,
		$	descending
	)

This method basically executes the exact same code as the parent class, though with a hook added, to allow extentions to add additional queries.

Parameters:

string	$offset	Index offset, inclusive
int	$limit	Exact query limit
bool	$descending	Query direction, false for ascending, true for descending

Returns:: ResultWrapper

Reimplemented from IndexPager.

Definition at line 723 of file SpecialContributions.php.

Member Data Documentation

ContribsPager::$mDb

Reimplemented from IndexPager.

Definition at line 659 of file SpecialContributions.php.

DatabaseBase ContribsPager::$mDbSecondary

*

Definition at line 662 of file SpecialContributions.php.

ContribsPager::$mDefaultDirection = IndexPager::DIR_DESCENDING

$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.

If $mIsBackwards is set, we start from the opposite end, but we still sort the page itself according to $mDefaultDirection. E.g., if $mDefaultDirection is false but we're going backwards, we'll display the last page of results, but the last result will be at the bottom, not the top.

Like $mIndexField, $mDefaultDirection will be a single value even if the class supports multiple default directions for different order types.

Reimplemented from ReverseChronologicalPager.

Definition at line 655 of file SpecialContributions.php.

ContribsPager::$messages

Definition at line 656 of file SpecialContributions.php.

array ContribsPager::$mParentLens [protected]

Definition at line 666 of file SpecialContributions.php.

ContribsPager::$namespace = ''

Definition at line 658 of file SpecialContributions.php.

ContribsPager::$preventClickjacking = false

Definition at line 660 of file SpecialContributions.php.

ContribsPager::$target

Definition at line 657 of file SpecialContributions.php.

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

includes/specials/SpecialContributions.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation