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

Public Member Functions

 __construct ( $list, $types=[], $performer='', $title='', $pattern='', $conds=[], $year=false, $month=false, $tagFilter='', $action='', $logId=false)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 formatRow ( $row)
 Abstract formatting function. More...
 
 getAction ()
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getFilterParams ()
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. More...
 
 getMonth ()
 
 getPage ()
 
 getPattern ()
 
 getPerformer ()
 Guaranteed to either return a valid title string or a Zero-Length String. More...
 
 getQueryInfo ()
 Constructs the most part of the query. More...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 getTagFilter ()
 
 getType ()
 
 getYear ()
 
- Public Member Functions inherited from ReverseChronologicalPager
 getDateCond ( $year, $month, $day=-1)
 Set and return the mOffset timestamp such that we can get all revisions with a timestamp up to the specified parameters. More...
 
 getNavigationBar ()
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null)
 
 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...
 
 getDatabase ()
 Get the Database object in use. 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...
 
 reallyDoQuery ( $offset, $limit, $descending)
 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

LogEventsList $mLogEventsList
 
- Public Attributes inherited from ReverseChronologicalPager
 $mDay
 
 $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. 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 Member Functions

 hasEqualsClause ( $field)
 Checks if $this->mConds has $field matched to a single value. More...
 
 limitLogId ( $logId)
 Limit to the (single) specified log ID. More...
 
- 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...
 
 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...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Private Member Functions

 enforceActionRestrictions ()
 Paranoia: avoid brute force searches (T19342) More...
 
 enforcePerformerRestrictions ()
 Paranoia: avoid brute force searches (T19342) More...
 
 limitAction ( $action)
 Set the log_action field to a specified value (or values) More...
 
 limitPerformer ( $name)
 Set the log reader to return only entries by the given user. More...
 
 limitTitle ( $page, $pattern)
 Set the log reader to return only entries affecting the given page. More...
 
 limitType ( $types)
 Set the log reader to return only entries of the given type. More...
 

Private Attributes

string $action = ''
 
bool $actionRestrictionsEnforced = false
 
string $pattern = ''
 
string $performer = ''
 Events limited to those by performer when set. More...
 
bool $performerRestrictionsEnforced = false
 
string Title $title = ''
 Events limited to those about Title when set. More...
 
string $typeCGI = ''
 
array $types = []
 Log types. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ReverseChronologicalPager
static getOffsetDate ( $year, $month, $day=-1)
 Core logic of determining the mOffset timestamp such that we can get all items with a timestamp up to the specified parameters. 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...
 

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 
)
Parameters
LogEventsList$list
string | array$typesLog types to show
string$performerThe user who made the log entries
string | Title$titleThe page title the log entries are for
string$patternDo a prefix search rather than an exact title match
array$condsExtra conditions for the query
int | bool$yearThe year to start from. Default: false
int | bool$monthThe month to start from. Default: false
string$tagFilterTag
string$actionSpecific action (subtype) requested
int$logIdLog entry ID, to limit to a single log entry.

Definition at line 70 of file LogPager.php.

References $pattern, DB_REPLICA, 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 421 of file LogPager.php.

◆ enforceActionRestrictions()

LogPager::enforceActionRestrictions ( )
private

Paranoia: avoid brute force searches (T19342)

Definition at line 431 of file LogPager.php.

References $user, LogPage\DELETED_ACTION, ContextSource\getUser(), LogPage\SUPPRESSED_ACTION, and LogPage\SUPPRESSED_USER.

Referenced by limitTitle().

◆ enforcePerformerRestrictions()

LogPager::enforcePerformerRestrictions ( )
private

Paranoia: avoid brute force searches (T19342)

Definition at line 448 of file LogPager.php.

References $user, LogPage\DELETED_USER, ContextSource\getUser(), LogPage\SUPPRESSED_ACTION, and LogPage\SUPPRESSED_USER.

Referenced by limitPerformer().

◆ 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$rowDatabase row
Returns
string

Reimplemented from IndexPager.

Definition at line 377 of file LogPager.php.

◆ getAction()

LogPager::getAction ( )

Definition at line 417 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 90 of file LogPager.php.

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

◆ getFilterParams()

LogPager::getFilterParams ( )

Definition at line 101 of file LogPager.php.

References $type, $wgFilterLogTypes, as, ContextSource\getRequest(), 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 353 of file LogPager.php.

◆ getMonth()

LogPager::getMonth ( )

Definition at line 409 of file LogPager.php.

References ReverseChronologicalPager\$mMonth.

◆ getPage()

LogPager::getPage ( )
Returns
string

Definition at line 397 of file LogPager.php.

References $title.

◆ getPattern()

LogPager::getPattern ( )

Definition at line 401 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 390 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 299 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 357 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 413 of file LogPager.php.

◆ getType()

LogPager::getType ( )

Definition at line 381 of file LogPager.php.

References $types.

◆ getYear()

LogPager::getYear ( )

Definition at line 405 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 346 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 263 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$logIdThe log entry ID.

Definition at line 287 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 170 of file LogPager.php.

References $name, DB_REPLICA, enforcePerformerRestrictions(), Title\makeTitleSafe(), User\newFromName(), ActorMigration\newMigration(), NS_USER, and wfGetDB().

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$pageTitle name
string$pattern
Returns
void

Definition at line 200 of file LogPager.php.

References IndexPager\$mDb, $name, $params, $pattern, $title, $wgMiserMode, $wgUserrightsInterwikiDelimiter, as, enforceActionRestrictions(), Title\getDBkey(), Title\getNamespace(), Title\getPrefixedText(), global, list, Title\newFromText(), 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$typesLog types ('upload', 'delete', etc); empty string means no restriction

Definition at line 126 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().

◆ $actionRestrictionsEnforced

bool LogPager::$actionRestrictionsEnforced = false
private

Definition at line 52 of file LogPager.php.

◆ $mLogEventsList

LogEventsList LogPager::$mLogEventsList

Definition at line 55 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().

◆ $performerRestrictionsEnforced

bool LogPager::$performerRestrictionsEnforced = false
private

Definition at line 49 of file LogPager.php.

◆ $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: