MediaWiki  REL1_31
DeletedContribsPager Class Reference
Inheritance diagram for DeletedContribsPager:
Collaboration diagram for DeletedContribsPager:

Public Member Functions

 __construct (IContextSource $context, $target, $namespace=false)
 
 formatRevisionRow ( $row)
 Generates each row in the contributions list for archive entries. More...
 
 formatRow ( $row)
 Generates each row in the contributions list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getEndBody ()
 Hook into getBody() for the end of the list. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getNamespaceCond ()
 
 getNavigationBar ()
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 reallyDoQuery ( $offset, $limit, $descending)
 This method basically executes the exact same code as the parent class, though with a hook added, to allow extensions to add additional queries. More...
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 extractResultInfo ( $isFirst, $limit, IResultWrapper $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...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment. More...
 
 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 ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Public Attributes

 $mDb
 
 $mDefaultDirection = IndexPager::DIR_DESCENDING
 
 $messages
 
 $namespace = ''
 
 $target
 
- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Constants for the $mDefaultDirection field. More...
 
const DIR_DESCENDING = true
 

Protected Attributes

string $mNavigationBar
 Navigation bar with paging links. More...
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from IndexPager
 buildQueryInfo ( $offset, $limit, $descending)
 Build variables to use by the database wrapper. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_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...
 

Detailed Description

Definition at line 29 of file DeletedContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

DeletedContribsPager::__construct ( IContextSource  $context,
  $target,
  $namespace = false 
)

Member Function Documentation

◆ formatRevisionRow()

DeletedContribsPager::formatRevisionRow (   $row)

Generates each row in the contributions list for archive entries.

Contributions which are marked "top" are currently on top of the history. For these contributions, a [rollback] link is shown for users with sysop 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
stdClass$row
Returns
string

Definition at line 248 of file DeletedContribsPager.php.

References $last, $link, $linkRenderer, $ret, $rev, $user, Revision\DELETED_TEXT, Revision\DELETED_USER, ChangesList\flag(), Linker\getRevDeleteLink(), CommentStore\getStore(), SpecialPage\getTitleFor(), Title\makeTitle(), messages, Html\rawElement(), and Linker\revComment().

◆ formatRow()

DeletedContribsPager::formatRow (   $row)

Generates each row in the contributions list.

Todo:
This would probably look a lot nicer in a table.
Parameters
stdClass$row
Returns
string

Reimplemented from IndexPager.

Definition at line 195 of file DeletedContribsPager.php.

References $attribs, $e, $ret, $rev, class, Revision\newFromArchiveRow(), Html\rawElement(), Hooks\run(), wfArrayFilterByKey(), and wfDebug().

◆ getDatabase()

DeletedContribsPager::getDatabase ( )

Get the Database object in use.

Returns
IDatabase

Reimplemented from IndexPager.

Definition at line 362 of file DeletedContribsPager.php.

◆ getDefaultQuery()

DeletedContribsPager::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 53 of file DeletedContribsPager.php.

References $query, and $target.

◆ getEndBody()

DeletedContribsPager::getEndBody ( )

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

Returns
string

Reimplemented from IndexPager.

Definition at line 145 of file DeletedContribsPager.php.

◆ getIndexField()

DeletedContribsPager::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 137 of file DeletedContribsPager.php.

Referenced by reallyDoQuery().

◆ getNamespaceCond()

DeletedContribsPager::getNamespaceCond ( )

Definition at line 180 of file DeletedContribsPager.php.

Referenced by getQueryInfo().

◆ getNavigationBar()

DeletedContribsPager::getNavigationBar ( )

Implements Pager.

Definition at line 149 of file DeletedContribsPager.php.

References $lang.

◆ getQueryInfo()

DeletedContribsPager::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 60 of file DeletedContribsPager.php.

References $user, DB_REPLICA, Revision\DELETED_USER, getNamespaceCond(), CommentStore\getStore(), ContextSource\getUser(), User\newFromName(), ActorMigration\newMigration(), Revision\SUPPRESSED_USER, and wfGetDB().

◆ getStartBody()

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

Returns
string

Reimplemented from IndexPager.

Definition at line 141 of file DeletedContribsPager.php.

◆ reallyDoQuery()

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

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

Parameters
string$offsetIndex offset, inclusive
int$limitExact query limit
bool$descendingQuery direction, false for ascending, true for descending
Returns
IResultWrapper

Reimplemented from IndexPager.

Definition at line 101 of file DeletedContribsPager.php.

References $query, as, getIndexField(), and Hooks\run().

Member Data Documentation

◆ $mDb

DeletedContribsPager::$mDb

Definition at line 35 of file DeletedContribsPager.php.

◆ $mDefaultDirection

DeletedContribsPager::$mDefaultDirection = IndexPager::DIR_DESCENDING

Definition at line 31 of file DeletedContribsPager.php.

◆ $messages

DeletedContribsPager::$messages

Definition at line 32 of file DeletedContribsPager.php.

◆ $mNavigationBar

string DeletedContribsPager::$mNavigationBar
protected

Navigation bar with paging links.

Definition at line 40 of file DeletedContribsPager.php.

◆ $namespace

DeletedContribsPager::$namespace = ''

Definition at line 34 of file DeletedContribsPager.php.

Referenced by __construct().

◆ $target

DeletedContribsPager::$target

Definition at line 33 of file DeletedContribsPager.php.

Referenced by __construct(), and getDefaultQuery().


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