MediaWiki  master
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 ()
 
 getIndexField ()
 
 getNamespace ()
 
 getNamespaceCond ()
 
 getNavigationBar ()
 
 getQueryInfo ()
 
 getTarget ()
 
 reallyDoQuery ( $offset, $limit, $order)
 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...
 
 formatRow ( $row)
 Abstract formatting function. More...
 
 getBody ()
 Get the formatted result 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...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. 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...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. 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...
 
 reallyDoQuery ( $offset, $limit, $order)
 Do a query with specified parameters, rather than using the object context. 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

IDatabase $mDb
 
bool $mDefaultDirection = IndexPager::DIR_DESCENDING
 Default direction for pager. More...
 
string [] $messages
 Local cache for escaped messages. More...
 
string int $namespace = ''
 A single namespace number, or an empty string for all namespaces. More...
 
string $target
 User name, or a string describing an IP address range. More...
 
- Public Attributes inherited from IndexPager
IDatabase $mDb
 
bool $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
int $mDefaultLimit = 50
 The default entry limit choosen for clients. More...
 
bool $mIsBackwards
 
bool $mIsFirst
 True if the current result set is the first one. More...
 
bool $mIsLast
 
int $mLimit
 The maximum number of entries to show. More...
 
int [] $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 List of default entry limit options to be presented to clients. More...
 
mixed $mOffset
 The starting point to enumerate entries. More...
 
stdClass bool null $mPastTheEndRow
 Extra row fetched at the end to see if the end was reached. More...
 
bool $mQueryDone = false
 Whether the listing query completed. More...
 
WebRequest $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const DIR_DESCENDING = true
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const QUERY_ASCENDING = true
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 
const QUERY_DESCENDING = false
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 

Protected Member Functions

 getEndBody ()
 
 getStartBody ()
 
- Protected Member Functions inherited from IndexPager
 buildPrevNextNavigation (LinkTarget $title, $offset, $limit, array $query=[], $atend=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 buildQueryInfo ( $offset, $limit, $order)
 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...
 
 getEndBody ()
 Hook into getBody() for the end of the list. 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...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Protected Attributes

string $mNavigationBar
 Navigation bar with paging links. More...
 
- Protected Attributes inherited from IndexPager
array $mDefaultQuery
 
string [] $mExtraSortFields
 An array of secondary columns to order by. More...
 
mixed $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string $mIndexField
 The index to actually be used for ordering. More...
 
mixed $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
mixed $mPastTheEndIndex
 

Additional Inherited Members

- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 

Detailed Description

Definition at line 31 of file DeletedContribsPager.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 63 of file DeletedContribsPager.php.

References $target, as, DB_REPLICA, messages, ContextSource\msg(), and wfGetDB().

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

References $last, $link, $linkRenderer, $ret, $rev, $user, ChangesList\flag(), ContextSource\getLanguage(), Linker\getRevDeleteLink(), CommentStore\getStore(), SpecialPage\getTitleFor(), ContextSource\getUser(), Title\makeTitle(), messages, ContextSource\msg(), null, Html\rawElement(), and Linker\revComment().

Referenced by formatRow().

◆ 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

Definition at line 230 of file DeletedContribsPager.php.

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

◆ getDatabase()

DeletedContribsPager::getDatabase ( )

Get the Database object in use.

Returns
IDatabase

Definition at line 400 of file DeletedContribsPager.php.

References $mDb.

◆ getDefaultQuery()

DeletedContribsPager::getDefaultQuery ( )

Definition at line 74 of file DeletedContribsPager.php.

References $query, and $target.

◆ getEndBody()

DeletedContribsPager::getEndBody ( )
protected

Definition at line 180 of file DeletedContribsPager.php.

◆ getIndexField()

DeletedContribsPager::getIndexField ( )

Definition at line 158 of file DeletedContribsPager.php.

Referenced by reallyDoQuery().

◆ getNamespace()

DeletedContribsPager::getNamespace ( )
Returns
int|string

Definition at line 172 of file DeletedContribsPager.php.

References $namespace.

◆ getNamespaceCond()

DeletedContribsPager::getNamespaceCond ( )

Definition at line 215 of file DeletedContribsPager.php.

Referenced by getQueryInfo().

◆ getNavigationBar()

DeletedContribsPager::getNavigationBar ( )

◆ getQueryInfo()

◆ getStartBody()

DeletedContribsPager::getStartBody ( )
protected

Definition at line 176 of file DeletedContribsPager.php.

◆ getTarget()

DeletedContribsPager::getTarget ( )
Returns
string

Definition at line 165 of file DeletedContribsPager.php.

References $target.

◆ reallyDoQuery()

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

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$orderIndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING
Returns
IResultWrapper

Definition at line 122 of file DeletedContribsPager.php.

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

Member Data Documentation

◆ $mDb

IDatabase DeletedContribsPager::$mDb

Definition at line 56 of file DeletedContribsPager.php.

Referenced by getDatabase().

◆ $mDefaultDirection

bool DeletedContribsPager::$mDefaultDirection = IndexPager::DIR_DESCENDING

Default direction for pager.

Definition at line 36 of file DeletedContribsPager.php.

◆ $messages

string [] DeletedContribsPager::$messages

Local cache for escaped messages.

Definition at line 41 of file DeletedContribsPager.php.

◆ $mNavigationBar

string DeletedContribsPager::$mNavigationBar
protected

Navigation bar with paging links.

Definition at line 61 of file DeletedContribsPager.php.

Referenced by getNavigationBar().

◆ $namespace

string int DeletedContribsPager::$namespace = ''

A single namespace number, or an empty string for all namespaces.

Definition at line 51 of file DeletedContribsPager.php.

Referenced by getNamespace().

◆ $target

string DeletedContribsPager::$target

User name, or a string describing an IP address range.

Definition at line 46 of file DeletedContribsPager.php.

Referenced by __construct(), getDefaultQuery(), and getTarget().


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