MediaWiki REL1_37
|
Public Member Functions | |
__construct ( $list, $types=[], $performer='', $page='', $pattern=false, $conds=[], $year=false, $month=false, $day=false, $tagFilter='', $action='', $logId=0, LinkBatchFactory $linkBatchFactory=null, ILoadBalancer $loadBalancer=null, ActorNormalization $actorNormalization=null) | |
doQuery () | |
Do the query, using information from the object context. | |
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 () | |
getType () | |
getYear () | |
![]() | |
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. | |
getNavigationBar () | |
![]() | |
__construct (IContextSource $context=null, LinkRenderer $linkRenderer=null) | |
getBody () | |
Get the formatted result list. | |
getDatabase () | |
Get the Database object in use. | |
getLimit () | |
Get the current limit. | |
getNumRows () | |
Get the number of rows in the result set. | |
getPagingQueries () | |
Get a URL query array for the prev, next, first and last links. | |
getResult () | |
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. | |
![]() | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. | |
getCsrfTokenSet () | |
Get a repository to obtain and match CSRF tokens. | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
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 |
![]() | |
int | $mDay |
bool | $mDefaultDirection = IndexPager::DIR_DESCENDING |
int | $mMonth |
int | $mYear |
![]() | |
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 | |
getStartBody () | |
Hook into getBody(), allows text to be inserted at the start. | |
hasEqualsClause ( $field) | |
Checks if $this->mConds has $field matched to a single value. | |
limitLogId ( $logId) | |
Limit to the (single) specified log ID. | |
![]() | |
buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false) | |
Generate (prev x| next x) (20|50|100...) type links for paging. | |
buildQueryInfo ( $offset, $limit, $order) | |
Build variables to use by the database wrapper. | |
doBatchLookups () | |
Called from getBody(), before getStartBody() is called and after doQuery() was called. | |
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(). | |
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. | |
Private Member Functions | |
enforceActionRestrictions () | |
Paranoia: avoid brute force searches (T19342) | |
enforcePerformerRestrictions () | |
Paranoia: avoid brute force searches (T19342) | |
limitAction ( $action) | |
Set the log_action field to a specified value (or values) | |
limitFilterTypes () | |
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 = '' |
bool | $actionRestrictionsEnforced = false |
ActorNormalization | $actorNormalization |
LinkBatchFactory | $linkBatchFactory |
array | $mConds |
string | $mTagFilter |
string | $page = '' |
Events limited to those about this page when set. | |
bool | $pattern = false |
string | $performer = '' |
Events limited to those by performer when set. | |
bool | $performerRestrictionsEnforced = false |
string | $typeCGI = '' |
array | $types = [] |
Log types. | |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
static | oppositeOrder ( $order) |
![]() | |
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 |
Definition at line 35 of file LogPager.php.
LogPager::__construct | ( | $list, | |
$types = [] , |
|||
$performer = '' , |
|||
$page = '' , |
|||
$pattern = false , |
|||
$conds = [] , |
|||
$year = false , |
|||
$month = false , |
|||
$day = false , |
|||
$tagFilter = '' , |
|||
$action = '' , |
|||
$logId = 0 , |
|||
LinkBatchFactory | $linkBatchFactory = null , |
||
ILoadBalancer | $loadBalancer = null , |
||
ActorNormalization | $actorNormalization = null |
||
) |
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 | |
ILoadBalancer | null | $loadBalancer | |
ActorNormalization | null | $actorNormalization |
Definition at line 92 of file LogPager.php.
References $actorNormalization, $linkBatchFactory, $pattern, ReverseChronologicalPager\getDateCond(), limitAction(), limitFilterTypes(), limitLogId(), limitPerformer(), limitTitle(), and limitType().
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 486 of file LogPager.php.
|
private |
Paranoia: avoid brute force searches (T19342)
Definition at line 496 of file LogPager.php.
References LogPage\DELETED_ACTION, ContextSource\getAuthority(), LogPage\SUPPRESSED_ACTION, and LogPage\SUPPRESSED_USER.
Referenced by limitTitle().
|
private |
Paranoia: avoid brute force searches (T19342)
Definition at line 512 of file LogPager.php.
References LogPage\DELETED_USER, ContextSource\getAuthority(), LogPage\SUPPRESSED_ACTION, and LogPage\SUPPRESSED_USER.
Referenced by limitPerformer().
LogPager::formatRow | ( | $row | ) |
Returns an HTML string representing the result row $row.
Rows will be concatenated and returned by getBody()
array | stdClass | $row | Database row |
Reimplemented from IndexPager.
Definition at line 435 of file LogPager.php.
LogPager::getAction | ( | ) |
Definition at line 482 of file LogPager.php.
References $action.
LogPager::getDay | ( | ) |
Definition at line 474 of file LogPager.php.
References ReverseChronologicalPager\$mDay.
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.
Reimplemented from IndexPager.
Definition at line 122 of file LogPager.php.
References ReverseChronologicalPager\$mDay, ReverseChronologicalPager\$mMonth, ReverseChronologicalPager\$mYear, $performer, and $typeCGI.
LogPager::getFilterParams | ( | ) |
Definition at line 145 of file LogPager.php.
References $type, ContextSource\getConfig(), and ContextSource\getRequest().
Referenced by limitFilterTypes().
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:
Reimplemented from IndexPager.
Definition at line 411 of file LogPager.php.
LogPager::getMonth | ( | ) |
Definition at line 470 of file LogPager.php.
References ReverseChronologicalPager\$mMonth.
LogPager::getPage | ( | ) |
LogPager::getPattern | ( | ) |
LogPager::getPerformer | ( | ) |
Guaranteed to either return a valid title string or a Zero-Length String.
Definition at line 448 of file LogPager.php.
References $performer.
LogPager::getQueryInfo | ( | ) |
Constructs the most part of the query.
Extra conditions are sprinkled in all over this class.
Reimplemented from IndexPager.
Definition at line 347 of file LogPager.php.
References ContextSource\getConfig(), hasEqualsClause(), and ChangeTags\modifyDisplayQuery().
|
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.
Reimplemented from IndexPager.
Definition at line 415 of file LogPager.php.
References $title, IndexPager\getNumRows(), LogFormatter\newFromRow(), NS_USER, and NS_USER_TALK.
LogPager::getTagFilter | ( | ) |
Definition at line 478 of file LogPager.php.
References $mTagFilter.
LogPager::getType | ( | ) |
Definition at line 439 of file LogPager.php.
References $types.
LogPager::getYear | ( | ) |
Definition at line 466 of file LogPager.php.
References ReverseChronologicalPager\$mYear.
|
protected |
Checks if $this->mConds has $field matched to a single value.
string | $field |
Definition at line 404 of file LogPager.php.
Referenced by getQueryInfo(), limitFilterTypes(), and limitType().
|
private |
Set the log_action field to a specified value (or values)
string | $action |
Definition at line 312 of file LogPager.php.
References $action, $type, $typeCGI, and ContextSource\getConfig().
Referenced by __construct().
|
private |
Definition at line 133 of file LogPager.php.
References $type, getFilterParams(), and hasEqualsClause().
Referenced by __construct().
|
protected |
Limit to the (single) specified log ID.
int | $logId | The log entry ID. |
Definition at line 335 of file LogPager.php.
Referenced by __construct().
|
private |
Set the log reader to return only entries by the given user.
string | $name | (In)valid user name |
Definition at line 221 of file LogPager.php.
References enforcePerformerRestrictions().
Referenced by __construct().
|
private |
Set the log reader to return only entries affecting the given page.
(For the block and rights logs, this is a user page.)
string | PageReference | $page | |
bool | $pattern |
Definition at line 249 of file LogPager.php.
References IndexPager\$mDb, $page, $pattern, enforceActionRestrictions(), and ContextSource\getConfig().
Referenced by __construct().
|
private |
Set the log reader to return only entries of the given type.
Type restrictions enforced here
string | array | $types | Log types ('upload', 'delete', etc); empty string means no restriction |
Definition at line 175 of file LogPager.php.
References $type, $types, ContextSource\getAuthority(), ContextSource\getConfig(), ContextSource\getUser(), and hasEqualsClause().
Referenced by __construct().
|
private |
Definition at line 52 of file LogPager.php.
Referenced by getAction(), and limitAction().
|
private |
Definition at line 58 of file LogPager.php.
|
private |
Definition at line 73 of file LogPager.php.
Referenced by __construct().
|
private |
Definition at line 70 of file LogPager.php.
Referenced by __construct().
|
private |
Definition at line 61 of file LogPager.php.
LogEventsList LogPager::$mLogEventsList |
Definition at line 67 of file LogPager.php.
|
private |
Definition at line 64 of file LogPager.php.
Referenced by getTagFilter().
|
private |
Events limited to those about this page when set.
Definition at line 43 of file LogPager.php.
Referenced by getPage(), and limitTitle().
|
private |
Definition at line 46 of file LogPager.php.
Referenced by __construct(), getPattern(), and limitTitle().
|
private |
Events limited to those by performer when set.
Definition at line 40 of file LogPager.php.
Referenced by getDefaultQuery(), and getPerformer().
|
private |
Definition at line 55 of file LogPager.php.
|
private |
Definition at line 49 of file LogPager.php.
Referenced by getDefaultQuery(), and limitAction().
|
private |