ContribsPager Class Reference
[SpecialPagePager]

Pager for Special:Contributions. More...

Inherits ReverseChronologicalPager.

List of all members.

Public Member Functions

 __construct ($target, $namespace=false, $year=false, $month=false, $tagFilter=false)
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links.
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query.
 getUserCond ()
 getNamespaceCond ()
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld.
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start.
 getEndBody ()
 Hook into getBody() for the end of the list.
 formatRow ($row)
 Generates each row in the contributions list.
 getDatabase ()
 Get the Database object in use.
 getPreventClickjacking ()

Public Attributes

 $mDefaultDirection = true
 $mDefaultDirection gives the direction to use when sorting results: false for ascending, true for descending.
 $messages
 $target
 $namespace = ''
 $mDb
 $preventClickjacking = false

Protected Member Functions

 preventClickjacking ()


Detailed Description

Pager for Special:Contributions.

Definition at line 428 of file SpecialContributions.php.


Constructor & Destructor Documentation

ContribsPager::__construct ( target,
namespace = false,
year = false,
month = false,
tagFilter = false 
)


Member Function Documentation

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.

Reimplemented from IndexPager.

Definition at line 546 of file SpecialContributions.php.

References $classes, $page, $wgContLang, Revision::DELETED_RESTRICTED, Revision::DELETED_TEXT, Revision::DELETED_USER, ChangesList::flag(), ChangeTags::formatSummaryRow(), Title::newFromRow(), wfMsg(), wfMsgHtml(), wfProfileIn(), wfProfileOut(), wfRunHooks(), and wfTimestamp().

ContribsPager::getDatabase (  ) 

Get the Database object in use.

Returns:
Database

Definition at line 673 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.

Reimplemented from IndexPager.

Definition at line 452 of file SpecialContributions.php.

ContribsPager::getEndBody (  ) 

Hook into getBody() for the end of the list.

Reimplemented from IndexPager.

Definition at line 532 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.

Reimplemented from IndexPager.

Definition at line 524 of file SpecialContributions.php.

ContribsPager::getNamespaceCond (  ) 

Definition at line 516 of file SpecialContributions.php.

ContribsPager::getPreventClickjacking (  ) 

Definition at line 681 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

Reimplemented from IndexPager.

Definition at line 458 of file SpecialContributions.php.

References Revision::DELETED_USER, ChangeTags::modifyDisplayQuery(), Revision::SUPPRESSED_USER, and wfRunHooks().

ContribsPager::getStartBody (  ) 

Hook into getBody(), allows text to be inserted at the start.

This will be called even if there are no rows in the result set.

Reimplemented from IndexPager.

Definition at line 528 of file SpecialContributions.php.

ContribsPager::getUserCond (  ) 

Definition at line 497 of file SpecialContributions.php.

ContribsPager::preventClickjacking (  )  [protected]

Definition at line 677 of file SpecialContributions.php.


Member Data Documentation

ContribsPager::$mDb

Reimplemented from IndexPager.

Definition at line 431 of file SpecialContributions.php.

ContribsPager::$mDefaultDirection = true

$mDefaultDirection gives the direction to use when sorting results: false for ascending, true for 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 429 of file SpecialContributions.php.

ContribsPager::$messages

Definition at line 430 of file SpecialContributions.php.

ContribsPager::$namespace = ''

Definition at line 431 of file SpecialContributions.php.

ContribsPager::$preventClickjacking = false

Definition at line 432 of file SpecialContributions.php.

ContribsPager::$target

Definition at line 430 of file SpecialContributions.php.


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

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