Inherits MediaWiki\Pager\ReverseChronologicalPager.

Collaboration diagram for MediaWiki\Pager\LogPager:

[legend]

Public Member Functions
	__construct ( $list, $types=[], $performer='', $page='', $pattern=false, $conds=[], $year=false, $month=false, $day=false, $tagFilter='', $action='', $logId=0, LinkBatchFactory $linkBatchFactory=null, ActorNormalization $actorNormalization=null, $tagInvert=false)

	formatRow ( $row)
	Returns an HTML string representing the result row $row.

	getAction ()

	getDay ()

	getDefaultQuery ()
	Get an array of query parameters that should be put into self-links.

	getFilterParams ()

	getIndexField ()
	Returns the name of the index field.

	getMonth ()

	getPage ()

	getPattern ()

	getPerformer ()
	Guaranteed to either return a valid title string or a Zero-Length String.

	getQueryInfo ()
	Constructs the most part of the query.

	getTagFilter ()

	getTagInvert ()

	getType ()

	getYear ()

Public Member Functions inherited from MediaWiki\Pager\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 MediaWiki\Pager\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.

	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 MediaWiki\Context\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 ()

	getLanguageCode ()

	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
LogEventsList	$mLogEventsList

Public Attributes inherited from MediaWiki\Pager\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 MediaWiki\Pager\IndexPager
IReadableDatabase	$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.

hasEqualsClause ( $field)

Checks if $this->mConds has $field matched to a single value.

limitLogId ( $logId)

Limit to the (single) specified log ID.

Protected Member Functions inherited from MediaWiki\Pager\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 MediaWiki\Pager\IndexPager

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.

getEndBody ()

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

getExtraSortFields ()

Returns the names of secondary columns to order by in addition to the column in getIndexField().

getLinkRenderer ()

getSqlComment ()

Get some text to go in brackets in the "function name" part of the SQL comment.

getStartBody ()

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

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 MediaWiki\Pager\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 MediaWiki\Pager\IndexPager
static	oppositeOrder ( $order)

Protected Attributes inherited from MediaWiki\Pager\ReverseChronologicalPager
string	$endOffset

Protected Attributes inherited from MediaWiki\Pager\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 44 of file LogPager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Pager\LogPager::__construct	(		$list,
			$types = [],
			$performer = '',
			$page = '',
			$pattern = false,
			$conds = [],
			$year = false,
			$month = false,
			$day = false,
			$tagFilter = '',
			$action = '',
			$logId = 0,
		LinkBatchFactory	$linkBatchFactory = null,
		ActorNormalization	$actorNormalization = null,
			$tagInvert = false )

Parameters

LogEventsList	$list
string \| array	$types	Log types to show
string	$performer	The user who made the log entries
string \| PageReference	$page	The page the log entries are for
bool	$pattern	Do a prefix search rather than an exact title match
array	$conds	Extra conditions for the query
int \| bool	$year	The year to start from. Default: false
int \| bool	$month	The month to start from. Default: false
int \| bool	$day	The day to start from. Default: false
string	$tagFilter	Tag
string	$action	Specific action (subtype) requested
int	$logId	Log entry ID, to limit to a single log entry.
LinkBatchFactory \| null	$linkBatchFactory
ActorNormalization \| null	$actorNormalization
bool	$tagInvert	whether tags are filtered for (false) or out (true)

Definition at line 104 of file LogPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\getDateCond(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Pager\LogPager\limitLogId().

Member Function Documentation

◆ doBatchLookups()

MediaWiki\Pager\LogPager::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 MediaWiki\Pager\IndexPager.

Definition at line 437 of file LogPager.php.

References NS_USER, and NS_USER_TALK.

◆ formatRow()

MediaWiki\Pager\LogPager::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 MediaWiki\Pager\IndexPager.

Definition at line 451 of file LogPager.php.

◆ getAction()

MediaWiki\Pager\LogPager::getAction ( )

Definition at line 502 of file LogPager.php.

◆ getDay()

MediaWiki\Pager\LogPager::getDay ( )

Definition at line 490 of file LogPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\$mDay.

◆ getDefaultQuery()

MediaWiki\Pager\LogPager::getDefaultQuery ( )

Get an array of query parameters that should be put into self-links.

By default, all parameters passed in the URL are used, apart from a few exceptions.

Stability: stable: to override

Returns: array Associative array

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 132 of file LogPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\$mDay, MediaWiki\Pager\ReverseChronologicalPager\$mMonth, and MediaWiki\Pager\ReverseChronologicalPager\$mYear.

◆ getFilterParams()

MediaWiki\Pager\LogPager::getFilterParams ( )

Definition at line 155 of file LogPager.php.

References MediaWiki\MainConfigNames\FilterLogTypes, MediaWiki\Context\ContextSource\getConfig(), and MediaWiki\Context\ContextSource\getRequest().

Referenced by MediaWiki\Pager\LogPager\getQueryInfo().

◆ getIndexField()

MediaWiki\Pager\LogPager::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 MediaWiki\Pager\IndexPager.

Definition at line 433 of file LogPager.php.

◆ getMonth()

MediaWiki\Pager\LogPager::getMonth ( )

Definition at line 486 of file LogPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\$mMonth.

◆ getPage()

MediaWiki\Pager\LogPager::getPage ( )

Returns: string

Definition at line 471 of file LogPager.php.

◆ getPattern()

MediaWiki\Pager\LogPager::getPattern ( )

Returns: bool

Definition at line 478 of file LogPager.php.

◆ getPerformer()

MediaWiki\Pager\LogPager::getPerformer ( )

Guaranteed to either return a valid title string or a Zero-Length String.

Returns: string

Definition at line 464 of file LogPager.php.

◆ getQueryInfo()

MediaWiki\Pager\LogPager::getQueryInfo ( )

Constructs the most part of the query.

Extra conditions are sprinkled in all over this class.

Returns: array

Reimplemented from MediaWiki\Pager\IndexPager.

Definition at line 366 of file LogPager.php.

References MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Pager\LogPager\getFilterParams(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Pager\LogPager\hasEqualsClause(), and MediaWiki\MainConfigNames\MaxExecutionTimeForExpensiveQueries.

◆ getTagFilter()

MediaWiki\Pager\LogPager::getTagFilter ( )

Definition at line 494 of file LogPager.php.

◆ getTagInvert()

MediaWiki\Pager\LogPager::getTagInvert ( )

Definition at line 498 of file LogPager.php.

◆ getType()

MediaWiki\Pager\LogPager::getType ( )

Definition at line 455 of file LogPager.php.

◆ getYear()

MediaWiki\Pager\LogPager::getYear ( )

Definition at line 482 of file LogPager.php.

References MediaWiki\Pager\ReverseChronologicalPager\$mYear.

◆ hasEqualsClause()

MediaWiki\Pager\LogPager::hasEqualsClause ( $field )

protected

Checks if $this->mConds has $field matched to a single value.

Parameters

string $field

Returns: bool

Definition at line 426 of file LogPager.php.

Referenced by MediaWiki\Pager\LogPager\getQueryInfo().

◆ limitLogId()

MediaWiki\Pager\LogPager::limitLogId ( $logId )

protected

Limit to the (single) specified log ID.

Parameters

int $logId The log entry ID.

Definition at line 354 of file LogPager.php.

Referenced by MediaWiki\Pager\LogPager\__construct().

Member Data Documentation

◆ $mLogEventsList

LogEventsList MediaWiki\Pager\LogPager::$mLogEventsList

Definition at line 79 of file LogPager.php.

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

includes/logging/LogPager.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doBatchLookups()

◆ formatRow()

◆ getAction()

◆ getDay()

◆ getDefaultQuery()

◆ getFilterParams()

◆ getIndexField()

◆ getMonth()

◆ getPage()

◆ getPattern()

◆ getPerformer()

◆ getQueryInfo()

◆ getTagFilter()

◆ getTagInvert()

◆ getType()

◆ getYear()

◆ hasEqualsClause()

◆ limitLogId()

Member Data Documentation

◆ $mLogEventsList