MergeHistoryPager Class Reference

Inherits ReverseChronologicalPager.

Collaboration diagram for MergeHistoryPager:

Public Member Functions
	__construct (SpecialMergeHistory $form, LinkBatchFactory $linkBatchFactory, ILoadBalancer $loadBalancer, RevisionStore $revisionStore, $conds, PageIdentity $source, PageIdentity $dest)
	formatRow ( $row)
	Returns an HTML string representing the result row $row.
	getIndexField ()
	Returns the name of the index field.
	getQueryInfo ()
	Provides all parameters needed for the main paged query.
Public Member Functions inherited from ReverseChronologicalPager
	getDateCond ( $year, $month, $day=-1)
	Set and return the offset timestamp such that we can get all revisions with a timestamp up to the specified parameters.
	getEndOffset ()
	Return the end offset, extensions can use this if they are not in the context of subclass.
	getNavigationBar ()
	getTimestampField ()
	Returns the name of the timestamp field.
Public Member Functions inherited from IndexPager
	__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
	doQuery ()
	Do the query, using information from the object context.
	getBody ()
	Get the formatted result list.
	getDatabase ()
	Get the Database object in use.
	getDefaultQuery ()
	Get an array of query parameters that should be put into self-links.
	getLimit ()
	Get the current limit.
	getModuleStyles ()
	ResourceLoader modules that must be loaded to provide correct styling for this pager.
	getNavigationBuilder ()
	getNumRows ()
	Get the number of rows in the result set.
	getOffsetQuery ()
	Get the current offset for the URL query parameter.
	getPagingQueries ()
	Get a URL query array for the prev, next, first and last links.
	getResult ()
	getResultOffset ()
	reallyDoQuery ( $offset, $limit, $order)
	Do a query with specified parameters, rather than using the object context.
	setIncludeOffset ( $include)
	Set whether a row matching exactly the offset should be also included in the result or not.
	setLimit ( $limit)
	Set the limit from an other source than the request.
	setOffset ( $offset)
	Set the offset from an other source than the request.
Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().
	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.
	getActionName ()
	Get the action name for the current web request.
	getAuthority ()
	getConfig ()
	getContext ()
	Get the base IContextSource object.
	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.
	getLanguage ()
	getOutput ()
	getRequest ()
	getSkin ()
	getTiming ()
	getTitle ()
	getUser ()
	getWikiPage ()
	Get the WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)

Public Attributes
array	$mConds
SpecialMergeHistory	$mForm
	$mGroupByDate = true
Public Attributes inherited from ReverseChronologicalPager
int	$mDay
bool	$mDefaultDirection = IndexPager::DIR_DESCENDING
bool	$mGroupByDate = false
	Whether to group items by date.
int	$mMonth
int	$mYear
Public Attributes inherited from IndexPager
IDatabase	$mDb
bool	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.
int	$mDefaultLimit = 50
	The default entry limit choosen for clients.
bool	$mIsBackwards
bool	$mIsFirst
	True if the current result set is the first one.
bool	$mIsLast
int	$mLimit
	The maximum number of entries to show.
int[]	$mLimitsShown = [ 20, 50, 100, 250, 500 ]
	List of default entry limit options to be presented to clients.
mixed	$mOffset
	The starting point to enumerate entries.
stdClass bool null	$mPastTheEndRow
	Extra row fetched at the end to see if the end was reached.
bool	$mQueryDone = false
	Whether the listing query completed.
WebRequest	$mRequest
IResultWrapper	$mResult
	Result object for the query.
const	DIR_ASCENDING = false
	Backwards-compatible constant for $mDefaultDirection field (do not change)
const	DIR_DESCENDING = true
	Backwards-compatible constant for $mDefaultDirection field (do not change)
const	QUERY_ASCENDING = true
	Backwards-compatible constant for reallyDoQuery() (do not change)
const	QUERY_DESCENDING = false
	Backwards-compatible constant for reallyDoQuery() (do not change)

Protected Member Functions
	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.
	getEndBody ()
	Hook into getBody() for the end of the list. Stability: stable to override Returns string
	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
Protected Member Functions inherited from ReverseChronologicalPager
	buildQueryInfo ( $offset, $limit, $order)
	Build variables to use by the database wrapper. Note For b/c, query direction is true for ascending and false for descending Stability: stable to override Parameters int | string | null $offset Index offset, inclusive int $limit Exact query limit bool $order IndexPager::QUERY_ASCENDING or IndexPager::QUERY_DESCENDING Returns array
	getDateFromTimestamp (string $timestamp)
	Get date from the timestamp.
	getEndGroup ()
	End an existing group of page rows.
	getFooter ()
	Classes can extend to output a footer at the bottom of the pager list. Since 1.38 Returns string
	getHeaderRow (string $date)
	getRow ( $row)
	Get the HTML of a pager row. Stability: stable to override Since 1.38 Parameters stdClass $row Returns string
	getStartGroup ()
	Start a new group of page rows.
	isFirstHeaderRow ()
	Determines whether the header row is the first that will be outputted to the page.
	isHeaderRowNeeded (string $date)
	Determines if a header row is needed based on the current state of the IndexPager.
Protected Member Functions inherited from IndexPager
	buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false)
	Generate (prev x| next x) (20|50|100...) type links for paging.
	extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
	Extract some useful data from the result object for use by the navigation bar, put it into $this.
	getDefaultDirections ()
	Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING.
	getEmptyBody ()
	Hook into getBody(), for the bit between the start and the end when there are no rows.
	getExtraSortFields ()
	Returns the names of secondary columns to order by in addition to the column in getIndexField().
	getHookContainer ()
	getLimitLinks ()
	getLinkRenderer ()
	getPagingLinks ( $linkTexts, $disabledTexts=[])
	Get paging links.
	getSqlComment ()
	Get some text to go in brackets in the "function name" part of the SQL comment.
	isNavigationBarShown ()
	Returns whether to show the "navigation bar".
	makeLink ( $text, array $query=null, $type=null)
	Make a self-link.
	preprocessResults ( $result)
	Pre-process results; useful for performing batch existence checks, etc.

Additional Inherited Members
Static Public Member Functions inherited from ReverseChronologicalPager
static	getOffsetDate ( $year, $month, $day=-1)
	Core logic of determining the offset timestamp such that we can get all items with a timestamp up to the specified parameters.
Static Protected Member Functions inherited from IndexPager
static	oppositeOrder ( $order)
Protected Attributes inherited from ReverseChronologicalPager
string	$endOffset
Protected Attributes inherited from IndexPager
array	$mDefaultQuery
string[]	$mExtraSortFields
	An array of secondary columns to order by.
array	$mFirstShown
bool	$mIncludeOffset = false
	Whether to include the offset in the query.
string string[]	$mIndexField
	The index to actually be used for ordering.
array	$mLastShown
string	$mNavigationBar
string null	$mOrderType
	For pages that support multiple types of ordering, which one to use.
array	$mPastTheEndIndex

Detailed Description

Definition at line 30 of file MergeHistoryPager.php.

Constructor & Destructor Documentation

__construct()

MergeHistoryPager::__construct	(	SpecialMergeHistory	$form,
		LinkBatchFactory	$linkBatchFactory,
		ILoadBalancer	$loadBalancer,
		RevisionStore	$revisionStore,
			$conds,
		PageIdentity	$source,
		PageIdentity	$dest )

Parameters

SpecialMergeHistory	$form
LinkBatchFactory	$linkBatchFactory
ILoadBalancer	$loadBalancer
RevisionStore	$revisionStore
array	$conds
PageIdentity	$source
PageIdentity	$dest

Definition at line 61 of file MergeHistoryPager.php.

References $dbr, $source, Wikimedia\Rdbms\ILoadBalancer\getConnectionRef(), SpecialPage\getContext(), and MediaWiki\Page\PageIdentity\getId().

Member Function Documentation

doBatchLookups()

MergeHistoryPager::doBatchLookups ( )

protected

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.

Stability: stable

to override

Returns

void

Reimplemented from IndexPager.

Definition at line 90 of file MergeHistoryPager.php.

References NS_USER, and NS_USER_TALK.

formatRow()

MergeHistoryPager::formatRow

(

$row

)

Returns an HTML string representing the result row $row.

Rows will be concatenated and returned by getBody()

Parameters

array | stdClass

$row

Database row

Returns

string

Reimplemented from IndexPager.

Definition at line 130 of file MergeHistoryPager.php.

getEndBody()

MergeHistoryPager::getEndBody ( )

protected

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

Stability: stable

to override

Returns

string

Reimplemented from IndexPager.

Definition at line 126 of file MergeHistoryPager.php.

getIndexField()

MergeHistoryPager::getIndexField

(

)

Returns the name of the index field.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=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.

The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).

Examples:

• Always paginate on the user field: 'user'
• Paginate on either the user or the timestamp field (default to user): [ 'name' => 'user', 'time' => 'timestamp', ]
• Always paginate on the combination of user and timestamp: [ [ 'user', 'timestamp' ] ]
• Paginate on the user then timestamp, or the timestamp then user: [ 'nametime' => [ 'user', 'timestamp' ], 'timename' => [ 'timestamp', 'user' ], ]

Returns

string|string[]|array[]

Reimplemented from IndexPager.

Definition at line 160 of file MergeHistoryPager.php.

getQueryInfo()

MergeHistoryPager::getQueryInfo

(

)

Provides 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 134 of file MergeHistoryPager.php.

References $dbr, $mConds, IndexPager\getDatabase(), and ChangeTags\modifyDisplayQuery().

getStartBody()

MergeHistoryPager::getStartBody ( )

protected

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 119 of file MergeHistoryPager.php.

Member Data Documentation

$mConds

array MergeHistoryPager::$mConds

Definition at line 38 of file MergeHistoryPager.php.

Referenced by getQueryInfo().

$mForm

SpecialMergeHistory MergeHistoryPager::$mForm

Definition at line 35 of file MergeHistoryPager.php.

$mGroupByDate

MergeHistoryPager::$mGroupByDate = true

Definition at line 32 of file MergeHistoryPager.php.

---

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

• includes/specials/pagers/MergeHistoryPager.php