MediaWiki  1.23.2
ContribsPager Class Reference

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. More...
 
 formatRow ( $row)
 Generates each row in the contributions list. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getEndBody ()
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getNamespaceCond ()
 
 getPreventClickjacking ()
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getSqlComment ()
 Overwrite Pager function and return a helpful comment. More...
 
 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. More...
 
- Public Member Functions inherited from ReverseChronologicalPager
 getDateCond ( $year, $month)
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 extractResultInfo ( $isFirst, $limit, ResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=array())
 Get paging links. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar". More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 setIncludeOffset ( $include)
 Set whether a row matching exactly the offset should be also included in the result or not. More...
 
 setLimit ( $limit)
 Set the limit from an other source than the request. More...
 
 setOffset ( $offset)
 Set the offset from an other source than the request. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 Get the Config object. More...
 
 getContext ()
 Get the RequestContext object. More...
 
 getLang ()
 Get the Language object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Public Attributes

 $mDb
 
DatabaseBase $mDbSecondary
 
 $mDefaultDirection = true
 
 $messages
 
 $namespace = ''
 
 $preventClickjacking = false
 
 $target
 
- Public Attributes inherited from ReverseChronologicalPager
 $mDefaultDirection = true
 
 $mMonth
 
 $mYear
 
- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: false for ascending, true for descending. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = array( 20, 50, 100, 250, 500 )
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
ResultWrapper $mResult
 Result object for the query. More...
 

Protected Member Functions

 preventClickjacking ()
 
- Protected Member Functions inherited from IndexPager
 buildQueryInfo ( $offset, $limit, $descending)
 Build variables to use by the database wrapper. More...
 
 getDefaultDirections ()
 Return the default sorting direction: false for ascending, true for descending. More...
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows. More...
 
 getExtraSortFields ()
 This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Protected Attributes

array $mParentLens
 
- Protected Attributes inherited from IndexPager
 $mExtraSortFields
 An array of secondary columns to order by. More...
 
 $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
 $mIndexField
 The index to actually be used for ordering. More...
 
 $mLastShown
 
 $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 

Detailed Description

Pager for Special:Contributions.

Definition at line 644 of file SpecialContributions.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 658 of file SpecialContributions.php.

Member Function Documentation

◆ doBatchLookups()

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 899 of file SpecialContributions.php.

References $batch, array(), as, Revision\getParentLengths(), NS_USER, and NS_USER_TALK.

◆ formatRow()

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
$row
Returns
string

Reimplemented from IndexPager.

Definition at line 948 of file SpecialContributions.php.

References $comment, $e, $link, $ret, $rev, $user, array(), Revision\DELETED_TEXT, Revision\DELETED_USER, ChangesList\flag(), Linker\formatRevisionSize(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), SpecialPage\getContext(), SpecialPage\getLanguage(), Linker\getRevDeleteLink(), SpecialPage\getUser(), Linker\link(), Linker\linkKnown(), list, messages, SpecialPage\msg(), Title\newFromRow(), Html\rawElement(), Linker\revComment(), ChangesList\showCharacterDifference(), Linker\userLink(), Linker\userTalkLink(), wfDebug(), wfProfileIn(), wfProfileOut(), wfRestoreWarnings(), wfRunHooks(), and wfSuppressWarnings().

◆ getDefaultQuery()

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 697 of file SpecialContributions.php.

◆ getEndBody()

ContribsPager::getEndBody ( )
Returns
string

Reimplemented from IndexPager.

Definition at line 932 of file SpecialContributions.php.

◆ getIndexField()

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 895 of file SpecialContributions.php.

◆ getNamespaceCond()

ContribsPager::getNamespaceCond ( )

Definition at line 871 of file SpecialContributions.php.

References array(), and MWNamespace\getAssociated().

◆ getPreventClickjacking()

ContribsPager::getPreventClickjacking ( )
Returns
bool

Definition at line 1137 of file SpecialContributions.php.

◆ getQueryInfo()

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 773 of file SpecialContributions.php.

◆ getSqlComment()

ContribsPager::getSqlComment ( )

Overwrite Pager function and return a helpful comment.

Returns
string

Reimplemented from IndexPager.

Definition at line 1121 of file SpecialContributions.php.

◆ getStartBody()

ContribsPager::getStartBody ( )
Returns
string

Reimplemented from IndexPager.

Definition at line 925 of file SpecialContributions.php.

◆ getUserCond()

ContribsPager::getUserCond ( )

◆ preventClickjacking()

ContribsPager::preventClickjacking ( )
protected

Definition at line 1130 of file SpecialContributions.php.

◆ reallyDoQuery()

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$offsetindex offset, inclusive
$limitInteger: exact query limit
$descendingBoolean: query direction, false for ascending, true for descending
Returns
ResultWrapper

Reimplemented from IndexPager.

Definition at line 713 of file SpecialContributions.php.

Member Data Documentation

◆ $mDb

ContribsPager::$mDb

Definition at line 649 of file SpecialContributions.php.

◆ $mDbSecondary

DatabaseBase ContribsPager::$mDbSecondary

Definition at line 652 of file SpecialContributions.php.

◆ $mDefaultDirection

ContribsPager::$mDefaultDirection = true

Definition at line 645 of file SpecialContributions.php.

◆ $messages

ContribsPager::$messages

Definition at line 646 of file SpecialContributions.php.

◆ $mParentLens

array ContribsPager::$mParentLens
protected

Definition at line 656 of file SpecialContributions.php.

◆ $namespace

ContribsPager::$namespace = ''

Definition at line 648 of file SpecialContributions.php.

◆ $preventClickjacking

ContribsPager::$preventClickjacking = false

Definition at line 650 of file SpecialContributions.php.

◆ $target

ContribsPager::$target

Definition at line 647 of file SpecialContributions.php.


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