Inherits MediaWiki\Context\ContextSource.

Collaboration diagram for MediaWiki\Logging\LogEventsList:

[legend]

Public Member Functions
	__construct ( $context, $linkRenderer=null, $flags=0)

	beginLogEventsList ()

	endLogEventsList ()

	logLine ( $row)

	showOptions ( $type='', $year=0, $month=0, $day=0, $username='')
	Show options for the log list.

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)

Static Public Member Functions
static	getBlockLogWarningBox (DatabaseBlockStore $blockStore, NamespaceInfo $namespaceInfo, MessageLocalizer $localizer, LinkRenderer $linkRenderer, $user, ?Title $title, array\|callable $additionalParams=[])

static	getExcludeClause ( $db, $audience='public', ?Authority $performer=null)
	SQL clause to skip forbidden log types for this user.

static	isDeleted ( $row, $field)

static	showLogExtract (&$out, $types=[], $pages='', $user='', $param=[])
	Show log extract.

static	typeAction ( $row, $type, $action)

static	userCan ( $row, $field, Authority $performer)
	Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted and/or restricted log type.

static	userCanBitfield ( $bitfield, $field, Authority $performer)
	Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.

static	userCanViewLogType ( $type, Authority $performer)
	Determine if the current user is allowed to view a particular field of this log row, if it's marked as restricted log type.

Public Attributes
int	$flags

const	NO_ACTION_LINK = 1

const	NO_EXTRA_USER_LINKS = 2

const	USE_CHECKBOXES = 4

Protected Member Functions
	getLinkRenderer ()

Protected Attributes
bool	$showTagEditUI

Detailed Description

Definition at line 52 of file LogEventsList.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Logging\LogEventsList::__construct	(	$context,
		$linkRenderer = null,
		$flags = 0 )

Parameters

IContextSource	$context
LinkRenderer \| null	$linkRenderer
int	$flags	Can be a combination of self::NO_ACTION_LINK, self::NO_EXTRA_USER_LINKS or self::USE_CHECKBOXES.

Definition at line 86 of file LogEventsList.php.

References MediaWiki\Logging\LogEventsList\$flags, MediaWiki\Context\ContextSource\getAuthority(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Context\ContextSource\setContext().

Member Function Documentation

◆ beginLogEventsList()

MediaWiki\Logging\LogEventsList::beginLogEventsList ( )

Returns: string

Definition at line 344 of file LogEventsList.php.

◆ endLogEventsList()

MediaWiki\Logging\LogEventsList::endLogEventsList ( )

Returns: string

Definition at line 351 of file LogEventsList.php.

◆ getBlockLogWarningBox()

static MediaWiki\Logging\LogEventsList::getBlockLogWarningBox	(	DatabaseBlockStore	$blockStore,
		NamespaceInfo	$namespaceInfo,
		MessageLocalizer	$localizer,
		LinkRenderer	$linkRenderer,
			$user,
		?Title	$title,
		array\|callable	$additionalParams = [] )

static

Access: internal: – shared code for IntroMessageBuilder, Article::showMissingArticle, and ContributionsSpecialPage::contributionsSub

If the user associated with the current page is blocked, get a warning box with a block log extract in it. Otherwise, return null.

Parameters

DatabaseBlockStore	$blockStore
NamespaceInfo	$namespaceInfo
MessageLocalizer	$localizer
LinkRenderer	$linkRenderer
UserIdentity \| false \| null	$user	The user identity that may be blocked
Title \| null	$title	The title being viewed. Pass null if the box should be shown regardless of the title.
array \| callable	$additionalParams	Either: An array of extra parameters for LogEventsList::showLogExtract, or A callback returning such an array.

When a callback is used, it receives a $data array with the following keys:

blocks: DatabaseBlock[] - Active blocks matching the target
sitewide: bool - Whether any of the blocks is sitewide
logTargetPages: string[] - Pages used as log targets
Returns
string|null

Definition at line 859 of file LogEventsList.php.

References MediaWiki\Title\NamespaceInfo\getCanonicalName(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), LIST_OR, MediaWiki\Linker\LinkRenderer\makeKnownLink(), MessageLocalizer\msg(), MediaWiki\Block\DatabaseBlockStore\newListFromTarget(), NS_USER, and MediaWiki\Logging\LogEventsList\showLogExtract().

◆ getExcludeClause()

static MediaWiki\Logging\LogEventsList::getExcludeClause	(		$db,
			$audience = 'public',
		?Authority	$performer = null )

static

SQL clause to skip forbidden log types for this user.

Parameters

\\Wikimedia\\Rdbms\\IReadableDatabase	$db
string	$audience	Public/user
Authority \| null	$performer	User to check, required when audience isn't public

Returns: string|false String on success, false on failure.

Exceptions

InvalidArgumentException

Definition at line 808 of file LogEventsList.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\LogRestrictions.

◆ getLinkRenderer()

MediaWiki\Logging\LogEventsList::getLinkRenderer ( )

protected

Since: 1.30

Returns: LinkRenderer

Definition at line 104 of file LogEventsList.php.

References MediaWiki\MediaWikiServices\getInstance().

Referenced by MediaWiki\Logging\LogEventsList\logLine().

◆ isDeleted()

static MediaWiki\Logging\LogEventsList::isDeleted	(		$row,
			$field )

static

Parameters

stdClass	$row
int	$field	One of LogPage::DELETED_ACTION, ::DELETED_COMMENT, ::DELETED_USER, ::DELETED_RESTRICTED

Returns: bool

Definition at line 562 of file LogEventsList.php.

◆ logLine()

MediaWiki\Logging\LogEventsList::logLine ( $row )

Parameters

stdClass $row A single row from the result set

Returns: string Formatted HTML list item

Definition at line 359 of file LogEventsList.php.

References MediaWiki\Context\ContextSource\getContext(), MediaWiki\Context\ContextSource\getLanguage(), MediaWiki\Logging\LogEventsList\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getTitleValueFor(), and MediaWiki\Logging\DatabaseLogEntry\newFromRow().

◆ showLogExtract()

static MediaWiki\Logging\LogEventsList::showLogExtract	(	&	$out,
			$types = [],
			$pages = '',
			$user = '',
			$param = [] )

static

Show log extract.

Either with text and a box (set $msgKey) or without (don't set $msgKey)

Parameters

OutputPage \| string	&$out
string \| array	$types	Log types to show
	string\|PageReference\|(string\|PageReference)[]	$pages The page title(s) to show log entries for
string	$user	The user who made the log entries
array	$param	Associative Array with the following additional options: lim Integer Limit of items to show, default is 50 conds Array Extra conditions for the query (e.g. $dbr->expr( 'log_action', '!=', 'revision' )) showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wfMessage offset Set to overwrite offset parameter in WebRequest set to '' to unset offset wrap String Wrap the message in html (usually something like "<div ...>$1</div>"). flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS) useRequestParams boolean Set true to use Pager-related parameters in the WebRequest useMaster boolean Use primary DB extraUrlParams array\|bool Additional url parameters for "full log" link (if it is shown) footerHtmlItems: string[] Extra HTML to add as horizontal list items after the end of the log

Returns: int Number of total log items (not limited by $lim)

Definition at line 594 of file LogEventsList.php.

References MediaWiki\Logging\LogEventsList\$flags, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\HookContainer\HookRunner\onLogEventsListShowLogExtract().

Referenced by MediaWiki\Logging\LogEventsList\getBlockLogWarningBox().

◆ showOptions()

MediaWiki\Logging\LogEventsList::showOptions	(	$type = '',
		$year = 0,
		$month = 0,
		$day = 0,
		$username = '' )

Show options for the log list.

Parameters

string	$type	Log type
int \| string	$year	Use 0 to start with no year preselected.
int \| string	$month	A month in the 1..12 range. Use 0 to start with no month preselected.
int \| string	$day	A day in the 1..31 range. Use 0 to start with no month preselected.
string	$username	Name of the filter-by performer, as typed in the form

Returns: bool Whether the options are valid

Definition at line 124 of file LogEventsList.php.

References MediaWiki\MainConfigNames\ActionFilteredLogs, MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Context\ContextSource\getContext(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), StatusValue\isGood(), MediaWiki\MainConfigNames\MiserMode, and MediaWiki\Context\ContextSource\setContext().

◆ typeAction()

static MediaWiki\Logging\LogEventsList::typeAction	(	$row,
		$type,
		$action )

static

Parameters

stdClass	$row
string \| array	$type
string \| array	$action

Returns: bool

Definition at line 496 of file LogEventsList.php.

◆ userCan()

static MediaWiki\Logging\LogEventsList::userCan	(		$row,
			$field,
		Authority	$performer )

static

Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted and/or restricted log type.

Parameters

stdClass	$row
int	$field	One of LogPage::DELETED_ACTION, ::DELETED_COMMENT, ::DELETED_USER, ::DELETED_RESTRICTED
Authority	$performer	User to check

Returns: bool

Definition at line 516 of file LogEventsList.php.

References MediaWiki\Logging\LogEventsList\userCanBitfield(), and MediaWiki\Logging\LogEventsList\userCanViewLogType().

◆ userCanBitfield()

static MediaWiki\Logging\LogEventsList::userCanBitfield	(		$bitfield,
			$field,
		Authority	$performer )

static

Determine if the current user is allowed to view a particular field of this log row, if it's marked as deleted.

Parameters

int	$bitfield	Current field
int	$field	One of LogPage::DELETED_ACTION, ::DELETED_COMMENT, ::DELETED_USER, ::DELETED_RESTRICTED
Authority	$performer	User to check

Returns: bool

Definition at line 530 of file LogEventsList.php.

References MediaWiki\Logging\LogPage\DELETED_RESTRICTED, MediaWiki\Permissions\Authority\isAllowed(), and MediaWiki\Permissions\Authority\isAllowedAny().

Referenced by MediaWiki\Logging\LogEventsList\userCan().

◆ userCanViewLogType()

static MediaWiki\Logging\LogEventsList::userCanViewLogType	(		$type,
		Authority	$performer )

static

Determine if the current user is allowed to view a particular field of this log row, if it's marked as restricted log type.

Parameters

string	$type
Authority	$performer	User to check

Returns: bool

Definition at line 549 of file LogEventsList.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Permissions\Authority\isAllowed(), and MediaWiki\MainConfigNames\LogRestrictions.

Referenced by MediaWiki\Logging\LogEventsList\userCan().

Member Data Documentation

◆ $flags

int MediaWiki\Logging\LogEventsList::$flags

Definition at line 58 of file LogEventsList.php.

Referenced by MediaWiki\Logging\LogEventsList\__construct(), and MediaWiki\Logging\LogEventsList\showLogExtract().

◆ $showTagEditUI

bool MediaWiki\Logging\LogEventsList::$showTagEditUI

protected

Definition at line 63 of file LogEventsList.php.

◆ NO_ACTION_LINK

const MediaWiki\Logging\LogEventsList::NO_ACTION_LINK = 1

Definition at line 53 of file LogEventsList.php.

◆ NO_EXTRA_USER_LINKS

const MediaWiki\Logging\LogEventsList::NO_EXTRA_USER_LINKS = 2

Definition at line 54 of file LogEventsList.php.

◆ USE_CHECKBOXES

const MediaWiki\Logging\LogEventsList::USE_CHECKBOXES = 4

Definition at line 55 of file LogEventsList.php.

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

includes/Logging/LogEventsList.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beginLogEventsList()

◆ endLogEventsList()

◆ getBlockLogWarningBox()

◆ getExcludeClause()

◆ getLinkRenderer()

◆ isDeleted()

◆ logLine()

◆ showLogExtract()

◆ showOptions()

◆ typeAction()

◆ userCan()

◆ userCanBitfield()

◆ userCanViewLogType()

Member Data Documentation

◆ $flags

◆ $showTagEditUI

◆ NO_ACTION_LINK

◆ NO_EXTRA_USER_LINKS

◆ USE_CHECKBOXES