Inherits MediaWiki\Context\ContextSource.

Collaboration diagram for LogEventsList:

[legend]

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

	beginLogEventsList ()

	endLogEventsList ()

	logLine ( $row)

	showOptions ( $type='', $year=0, $month=0, $day=0)
	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	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=[], $page='', $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
	$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 50 of file LogEventsList.php.

Constructor & Destructor Documentation

◆ __construct()

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 79 of file LogEventsList.php.

References $flags, getAuthority(), MediaWiki\Context\ContextSource\setContext(), and ChangeTags\showTagEditingUI().

Member Function Documentation

◆ beginLogEventsList()

LogEventsList::beginLogEventsList ( )

Returns: string

Definition at line 304 of file LogEventsList.php.

◆ endLogEventsList()

LogEventsList::endLogEventsList ( )

Returns: string

Definition at line 311 of file LogEventsList.php.

◆ getExcludeClause()

static 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 757 of file LogEventsList.php.

◆ getLinkRenderer()

LogEventsList::getLinkRenderer ( )

protected

Since: 1.30

Returns: LinkRenderer

Definition at line 94 of file LogEventsList.php.

Referenced by logLine().

◆ isDeleted()

static 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 529 of file LogEventsList.php.

◆ logLine()

LogEventsList::logLine ( $row )

Parameters

stdClass $row A single row from the result set

Returns: string Formatted HTML list item

Definition at line 319 of file LogEventsList.php.

References ChangeTags\formatSummaryRow(), getContext(), MediaWiki\Context\ContextSource\getLanguage(), and getLinkRenderer().

◆ showLogExtract()

static LogEventsList::showLogExtract	(	&	$out,
			$types = [],
			$page = '',
			$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	$page	The page title 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)

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

Definition at line 558 of file LogEventsList.php.

References $flags, and MediaWiki\HookContainer\HookRunner\onLogEventsListShowLogExtract().

◆ showOptions()

LogEventsList::showOptions	(	$type = '',
		$year = 0,
		$month = 0,
		$day = 0 )

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.

Returns: bool Whether the options are valid

Definition at line 113 of file LogEventsList.php.

References MediaWiki\Context\ContextSource\getConfig(), getContext(), StatusValue\isGood(), and MediaWiki\Context\ContextSource\setContext().

◆ typeAction()

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

static

Parameters

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

Returns: bool

Definition at line 463 of file LogEventsList.php.

◆ userCan()

static 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 483 of file LogEventsList.php.

◆ userCanBitfield()

static 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 497 of file LogEventsList.php.

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

◆ userCanViewLogType()

static 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 516 of file LogEventsList.php.

References MediaWiki\Permissions\Authority\isAllowed().

Member Data Documentation

◆ $flags

LogEventsList::$flags

Definition at line 55 of file LogEventsList.php.

Referenced by __construct(), and showLogExtract().

◆ $showTagEditUI

bool LogEventsList::$showTagEditUI

protected

Definition at line 60 of file LogEventsList.php.

◆ NO_ACTION_LINK

const LogEventsList::NO_ACTION_LINK = 1

Definition at line 51 of file LogEventsList.php.

◆ NO_EXTRA_USER_LINKS

const LogEventsList::NO_EXTRA_USER_LINKS = 2

Definition at line 52 of file LogEventsList.php.

◆ USE_CHECKBOXES

const LogEventsList::USE_CHECKBOXES = 4

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

◆ getExcludeClause()

◆ getLinkRenderer()

◆ isDeleted()

◆ logLine()

◆ showLogExtract()

◆ showOptions()

◆ typeAction()

◆ userCan()

◆ userCanBitfield()

◆ userCanViewLogType()

Member Data Documentation

◆ $flags

◆ $showTagEditUI

◆ NO_ACTION_LINK

◆ NO_EXTRA_USER_LINKS

◆ USE_CHECKBOXES