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

Public Member Functions

 __construct ( $list, $types=[], $performer='', $title='', $pattern=false, $conds=[], $year=false, $month=false, $day=false, $tagFilter='', $action='', $logId=0)
 
 doQuery ()
 Do the query, using information from the object context. More...
 
 formatRow ( $row)
 Returns an HTML string representing the result row $row. More...
 
 getAction ()
 
 getDay ()
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getFilterParams ()
 
 getIndexField ()
 Returns the name of the index field. 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...
 
 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 ()
 Stable to override. More...
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 Stable to call. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getLimit ()
 Get the current limit. More...
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 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 ()
 Stable to override. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 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
int $mDay
 
bool $mDefaultDirection = IndexPager::DIR_DESCENDING
 
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. 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

 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 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
 buildPrevNextNavigation (Title $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...
 
 extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. 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 ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 getLimitLinks ()
 
 getLinkRenderer ()
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 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" @stable to override. More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. 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...
 
 limitFilterTypes ()
 
 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
 
array $mConds
 
string $mTagFilter
 
bool $pattern = false
 
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...
 
- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 
- Protected Attributes inherited from IndexPager
array $mDefaultQuery
 
string[] $mExtraSortFields
 An array of secondary columns to order by. More...
 
array $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string string[] $mIndexField
 The index to actually be used for ordering. More...
 
array $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
array $mPastTheEndIndex
 

Detailed Description

Definition at line 31 of file LogPager.php.

Constructor & Destructor Documentation

◆ __construct()

LogPager::__construct (   $list,
  $types = [],
  $performer = '',
  $title = '',
  $pattern = false,
  $conds = [],
  $year = false,
  $month = false,
  $day = false,
  $tagFilter = '',
  $action = '',
  $logId = 0 
)
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
bool$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
int | bool$dayThe day 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 79 of file LogPager.php.

References $pattern, DB_REPLICA, ReverseChronologicalPager\getDateCond(), limitAction(), limitFilterTypes(), 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.

Stable to override

Reimplemented from IndexPager.

Definition at line 468 of file LogPager.php.

◆ enforceActionRestrictions()

LogPager::enforceActionRestrictions ( )
private

Paranoia: avoid brute force searches (T19342)

Definition at line 478 of file LogPager.php.

References 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 496 of file LogPager.php.

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

Referenced by limitPerformer().

◆ formatRow()

LogPager::formatRow (   $row)

Returns 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 417 of file LogPager.php.

◆ getAction()

LogPager::getAction ( )

Definition at line 464 of file LogPager.php.

References $action.

◆ getDay()

LogPager::getDay ( )

Definition at line 456 of file LogPager.php.

References ReverseChronologicalPager\$mDay.

◆ 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.

@stable to override

Returns
array Associative array

Reimplemented from IndexPager.

Definition at line 100 of file LogPager.php.

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

◆ getFilterParams()

LogPager::getFilterParams ( )

Definition at line 123 of file LogPager.php.

References $type, ContextSource\getConfig(), and ContextSource\getRequest().

Referenced by limitFilterTypes().

◆ getIndexField()

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 IndexPager.

Definition at line 393 of file LogPager.php.

◆ getMonth()

LogPager::getMonth ( )

Definition at line 452 of file LogPager.php.

References ReverseChronologicalPager\$mMonth.

◆ getPage()

LogPager::getPage ( )
Returns
string

Definition at line 437 of file LogPager.php.

References $title.

◆ getPattern()

LogPager::getPattern ( )
Returns
bool

Definition at line 444 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 430 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 326 of file LogPager.php.

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

◆ getStartBody()

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

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

◆ getTagFilter()

LogPager::getTagFilter ( )

Definition at line 460 of file LogPager.php.

References $mTagFilter.

◆ getType()

LogPager::getType ( )

Definition at line 421 of file LogPager.php.

References $types.

◆ getYear()

LogPager::getYear ( )

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

Referenced by getQueryInfo(), and limitFilterTypes().

◆ limitAction()

LogPager::limitAction (   $action)
private

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

Parameters
string$action

Definition at line 291 of file LogPager.php.

References $action, $type, $typeCGI, and ContextSource\getConfig().

Referenced by __construct().

◆ limitFilterTypes()

LogPager::limitFilterTypes ( )
private

Definition at line 111 of file LogPager.php.

References $type, getFilterParams(), and hasEqualsClause().

Referenced by __construct().

◆ limitLogId()

LogPager::limitLogId (   $logId)
protected

Limit to the (single) specified log ID.

Parameters
int$logIdThe log entry ID.

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

References 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
bool$pattern
Returns
void

Definition at line 228 of file LogPager.php.

References IndexPager\$mDb, $pattern, $title, enforceActionRestrictions(), ContextSource\getConfig(), Title\getDBkey(), Title\getNamespace(), Title\getPrefixedText(), and Title\newFromText().

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

References $type, $types, ContextSource\getConfig(), LogEventsList\getExcludeClause(), and ContextSource\getUser().

Referenced by __construct().

Member Data Documentation

◆ $action

string LogPager::$action = ''
private

Definition at line 48 of file LogPager.php.

Referenced by getAction(), and limitAction().

◆ $actionRestrictionsEnforced

bool LogPager::$actionRestrictionsEnforced = false
private

Definition at line 54 of file LogPager.php.

◆ $mConds

array LogPager::$mConds
private

Definition at line 57 of file LogPager.php.

◆ $mLogEventsList

LogEventsList LogPager::$mLogEventsList

Definition at line 63 of file LogPager.php.

◆ $mTagFilter

string LogPager::$mTagFilter
private

Definition at line 60 of file LogPager.php.

Referenced by getTagFilter().

◆ $pattern

bool LogPager::$pattern = false
private

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

Referenced by getDefaultQuery(), and getPerformer().

◆ $performerRestrictionsEnforced

bool LogPager::$performerRestrictionsEnforced = false
private

Definition at line 51 of file LogPager.php.

◆ $title

string Title LogPager::$title = ''
private

Events limited to those about Title when set.

Definition at line 39 of file LogPager.php.

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

◆ $typeCGI

string LogPager::$typeCGI = ''
private

Definition at line 45 of file LogPager.php.

Referenced by getDefaultQuery(), and limitAction().

◆ $types

array LogPager::$types = []
private

Log types.

Definition at line 33 of file LogPager.php.

Referenced by getType(), and limitType().


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