Inheritance diagram for LogPager:

[legend]

Collaboration diagram for LogPager:

[legend]

Public Member Functions
	__construct ( $list, $types=[], $performer='', $title='', $pattern='', $conds=[], $year=false, $month=false, $tagFilter='', $action='', $logId=false)
	Constructor.

	doQuery ()
	Do the query, using information from the object context.

	formatRow ( $row)
	Abstract formatting function.

	getAction ()

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

	getFilterParams ()

	getIndexField ()
	This function should be overridden to return the name of the index fi- eld.

	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.

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

	getTagFilter ()

	getType ()

	getYear ()

Public Member Functions inherited from ReverseChronologicalPager
	getDateCond ( $year, $month)

	getNavigationBar ()

Public Member Functions inherited from IndexPager
	__construct (IContextSource $context=null)

	extractResultInfo ( $isFirst, $limit, ResultWrapper $res)
	Extract some useful data from the result object for use by the navigation bar, put it into $this.

	getBody ()
	Get the formatted result list.

	getDatabase ()
	Get the Database object in use.

	getLimit ()
	Get the current limit.

	getLimitLinks ()

	getNumRows ()
	Get the number of rows in the result set.

	getPagingLinks ( $linkTexts, $disabledTexts=[])
	Get paging links.

	getPagingQueries ()
	Get a URL query array for the prev, next, first and last links.

	getResult ()

	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.

	reallyDoQuery ( $offset, $limit, $descending)
	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.

	getConfig ()
	Get the Config object.

	getContext ()
	Get the base IContextSource object.

	getLanguage ()
	Get the Language object.

	getOutput ()
	Get the OutputPage object.

	getRequest ()
	Get the WebRequest object.

	getSkin ()
	Get the Skin object.

	getStats ()
	Get the Stats object.

	getTiming ()
	Get the Timing object.

	getTitle ()
	Get the Title object.

	getUser ()
	Get the User object.

	getWikiPage ()
	Get the WikiPage object.

	msg ()
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)
	Set the IContextSource object.

Public Attributes
LogEventsList	$mLogEventsList

Public Attributes inherited from ReverseChronologicalPager
	$mDefaultDirection = IndexPager::DIR_DESCENDING

	$mMonth

	$mYear

Public Attributes inherited from IndexPager
	$mDb

	$mDefaultDirection
	$mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING.

	$mDefaultLimit = 50

	$mIsBackwards

	$mIsFirst
	True if the current result set is the first one.

	$mIsLast

	$mLimit

	$mLimitsShown = [ 20, 50, 100, 250, 500 ]

	$mOffset

	$mPastTheEndRow

	$mQueryDone = false

	$mRequest

ResultWrapper	$mResult
	Result object for the query.

const	DIR_ASCENDING = false
	Constants for the $mDefaultDirection field.

const	DIR_DESCENDING = true

Protected Member Functions
	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 IndexPager
	buildQueryInfo ( $offset, $limit, $descending)
	Build variables to use by the database wrapper.

	doBatchLookups ()
	Called from getBody(), before getStartBody() is called and after doQuery() was called.

	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 ()
	This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField().

	preprocessResults ( $result)
	Pre-process results; useful for performing batch existence checks, etc.

Private Member Functions
	limitAction ( $action)
	Set the log_action field to a specified value (or values)

	limitPerformer ( $name)
	Set the log reader to return only entries by the given user.

	limitTitle ( $page, $pattern)
	Set the log reader to return only entries affecting the given page.

	limitType ( $types)
	Set the log reader to return only entries of the given type.

Private Attributes
string	$action = ''

string	$pattern = ''

string	$performer = ''
	Events limited to those by performer when set.

string Title	$title = ''
	Events limited to those about Title when set.

string	$typeCGI = ''

array	$types = []
	Log types.

Additional Inherited Members
Protected Attributes inherited from IndexPager
	$mDefaultQuery

	$mExtraSortFields
	An array of secondary columns to order by.

	$mFirstShown

	$mIncludeOffset = false
	Whether to include the offset in the query.

	$mIndexField
	The index to actually be used for ordering.

	$mLastShown

	$mNavigationBar

	$mOrderType
	For pages that support multiple types of ordering, which one to use.

	$mPastTheEndIndex

Detailed Description

Definition at line 29 of file LogPager.php.

Constructor & Destructor Documentation

◆ __construct()

LogPager::__construct	(	$list,
		$types = `[]`,
		$performer = `''`,
		$title = `''`,
		$pattern = `''`,
		$conds = `[]`,
		$year = `false`,
		$month = `false`,
		$tagFilter = `''`,
		$action = `''`,
		$logId = `false`
	)

Constructor.

Parameters

LogEventsList	$list
string \| array	$types	Log types to show
string	$performer	The user who made the log entries
string \| Title	$title	The page title the log entries are for
string	$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
string	$tagFilter	Tag
string	$action	Specific action (subtype) requested
int	$logId	Log entry ID, to limit to a single log entry.

Definition at line 66 of file LogPager.php.

References $pattern, DB_SLAVE, ReverseChronologicalPager\getDateCond(), limitAction(), limitLogId(), limitPerformer(), limitTitle(), limitType(), and wfGetDB().

Member Function Documentation

◆ doQuery()

LogPager::doQuery ( )

Do the query, using information from the object context.

This function has been kept minimal to make it overridable if necessary, to allow for result sets formed from multiple DB queries.

Reimplemented from IndexPager.

Definition at line 435 of file LogPager.php.

◆ formatRow()

LogPager::formatRow ( $row )

Abstract formatting function.

This should return 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 391 of file LogPager.php.

◆ getAction()

LogPager::getAction ( )

Definition at line 431 of file LogPager.php.

References $action.

◆ getDefaultQuery()

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, except for a short blacklist.

Returns: array Associative array

Reimplemented from IndexPager.

Definition at line 86 of file LogPager.php.

References ReverseChronologicalPager\$mMonth, ReverseChronologicalPager\$mYear, $performer, $query, and $typeCGI.

◆ getFilterParams()

LogPager::getFilterParams ( )

Definition at line 97 of file LogPager.php.

References $type, $wgFilterLogTypes, as, ContextSource\getRequest(), ContextSource\getUser(), and global.

◆ getIndexField()

LogPager::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 367 of file LogPager.php.

◆ getMonth()

LogPager::getMonth ( )

Definition at line 423 of file LogPager.php.

References ReverseChronologicalPager\$mMonth.

◆ getPage()

LogPager::getPage ( )

Returns: string

Definition at line 411 of file LogPager.php.

References $title.

◆ getPattern()

LogPager::getPattern ( )

Definition at line 415 of file LogPager.php.

References $pattern.

◆ getPerformer()

LogPager::getPerformer ( )

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

Returns: string

Definition at line 404 of file LogPager.php.

References $performer.

◆ getQueryInfo()

LogPager::getQueryInfo ( )

Constructs the most part of the query.

Extra conditions are sprinkled in all over this class.

Returns: array

Reimplemented from IndexPager.

Definition at line 309 of file LogPager.php.

References $options, $tables, DatabaseLogEntry\getSelectQueryData(), hasEqualsClause(), and ChangeTags\modifyDisplayQuery().

◆ getStartBody()

LogPager::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 371 of file LogPager.php.

References $title, LinkBatch\add(), as, IndexPager\getNumRows(), Title\makeTitleSafe(), LogFormatter\newFromRow(), NS_USER, and NS_USER_TALK.

◆ getTagFilter()

LogPager::getTagFilter ( )

Definition at line 427 of file LogPager.php.

◆ getType()

LogPager::getType ( )

Definition at line 395 of file LogPager.php.

References $types.

◆ getYear()

LogPager::getYear ( )

Definition at line 419 of file LogPager.php.

References ReverseChronologicalPager\$mYear.

◆ hasEqualsClause()

LogPager::hasEqualsClause ( $field )

protected

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

Parameters

string $field

Returns: bool

Definition at line 360 of file LogPager.php.

Referenced by getQueryInfo().

◆ limitAction()

LogPager::limitAction ( $action )

private

Set the log_action field to a specified value (or values)

Parameters

string $action

Definition at line 273 of file LogPager.php.

References $action, $type, $typeCGI, $wgActionFilteredLogs, and global.

Referenced by __construct().

◆ limitLogId()

LogPager::limitLogId ( $logId )

protected

Limit to the (single) specified log ID.

Parameters

int $logId The log entry ID.

Definition at line 297 of file LogPager.php.

Referenced by __construct().

◆ limitPerformer()

LogPager::limitPerformer ( $name )

private

Set the log reader to return only entries by the given user.

Parameters

string $name (In)valid user name

Returns: void

Definition at line 168 of file LogPager.php.

References $name, $user, LogPage\DELETED_USER, ContextSource\getUser(), Title\makeTitleSafe(), NS_USER, IP\sanitizeIP(), and LogPage\SUPPRESSED_USER.

Referenced by __construct().

◆ limitTitle()

LogPager::limitTitle	(	$page,
		$pattern
	)

private

Set the log reader to return only entries affecting the given page.

(For the block and rights logs, this is a user page.)

Parameters

string \| Title	$page	Title name
string	$pattern

Returns: void

Definition at line 203 of file LogPager.php.

References IndexPager\$mDb, $name, $page, $params, $pattern, $title, $user, $wgMiserMode, $wgUserrightsInterwikiDelimiter, as, LogPage\DELETED_ACTION, Title\getDBkey(), Title\getNamespace(), Title\getPrefixedText(), ContextSource\getUser(), global, list, Title\newFromText(), LogPage\SUPPRESSED_ACTION, and title.

Referenced by __construct().

◆ limitType()

LogPager::limitType ( $types )

private

Set the log reader to return only entries of the given type.

Type restrictions enforced here

Parameters

string | array $types Log types ('upload', 'delete', etc); empty string means no restriction

Definition at line 124 of file LogPager.php.

References $type, $types, $user, $wgLogRestrictions, array(), as, LogEventsList\getExcludeClause(), ContextSource\getUser(), and global.

Referenced by __construct().

Member Data Documentation

◆ $action

string LogPager::$action = ''

private

Definition at line 46 of file LogPager.php.

Referenced by getAction(), and limitAction().

◆ $mLogEventsList

LogEventsList LogPager::$mLogEventsList

Definition at line 49 of file LogPager.php.

◆ $pattern

string LogPager::$pattern = ''

private

Definition at line 40 of file LogPager.php.

Referenced by __construct(), getPattern(), and limitTitle().

◆ $performer

string LogPager::$performer = ''

private

Events limited to those by performer when set.

Definition at line 34 of file LogPager.php.

Referenced by getDefaultQuery(), and getPerformer().

◆ $title

string Title LogPager::$title = ''

private

Events limited to those about Title when set.

Definition at line 37 of file LogPager.php.

Referenced by getPage(), getStartBody(), and limitTitle().

◆ $typeCGI

string LogPager::$typeCGI = ''

private

Definition at line 43 of file LogPager.php.

Referenced by getDefaultQuery(), and limitAction().

◆ $types

array LogPager::$types = []

private

Log types.

Definition at line 31 of file LogPager.php.

Referenced by getType(), and limitType().

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

includes/logging/LogPager.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doQuery()

◆ formatRow()

◆ getAction()

◆ getDefaultQuery()

◆ getFilterParams()

◆ getIndexField()

◆ getMonth()

◆ getPage()

◆ getPattern()

◆ getPerformer()

◆ getQueryInfo()

◆ getStartBody()

◆ getTagFilter()

◆ getType()

◆ getYear()

◆ hasEqualsClause()

◆ limitAction()

◆ limitLogId()

◆ limitPerformer()

◆ limitTitle()

◆ limitType()

Member Data Documentation

◆ $action

◆ $mLogEventsList

◆ $pattern

◆ $performer

◆ $title

◆ $typeCGI

◆ $types