Inheritance diagram for LogEventsList:

[legend]

Collaboration diagram for LogEventsList:

[legend]

Public Member Functions
	__construct ( $context, $linkRenderer=null, $flags=0)
	The first two parameters used to be $skin and $out, but now only a context is needed, that's why there's a second unused parameter.

	beginLogEventsList ()

	endLogEventsList ()

	logLine ( $row)

	setAllowedActions ( $actions)
	Sets the action types allowed for log filtering To one action type may correspond several log_actions.

	showOptions ( $types=[], $user='', $page='', $pattern=false, $year=0, $month=0, $day=0, $filter=null, $tagFilter='', $action=null)
	Show options for the log list.

Public Member Functions inherited from 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.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()
	Stable to override.

	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', User $user=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, $right='')

static	userCan ( $row, $field, User $user=null)
	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, User $user=null)
	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, User $user=null)
	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
array	$allowedActions = null

array	$mDefaultQuery

bool	$showTagEditUI

Private Member Functions
	getActionSelectorDesc ( $types, $action)
	Drop down menu for selection of actions that can be used to filter the log.

	getExtraInputsDesc ( $types)

	getFiltersDesc ( $filter)

	getShowHideLinks ( $row)

	getTitleInputDesc ( $title)

	getTitlePatternDesc ( $pattern)

	getTypeMenuDesc ( $queryTypes)

	getUserInputDesc ( $user)

Private Attributes
HookRunner	$hookRunner

LinkRenderer null	$linkRenderer

Detailed Description

Definition at line 31 of file LogEventsList.php.

Constructor & Destructor Documentation

◆ __construct()

LogEventsList::__construct	(	$context,
		$linkRenderer = `null`,
		$flags = `0`
	)

The first two parameters used to be $skin and $out, but now only a context is needed, that's why there's a second unused parameter.

Parameters

IContextSource \| Skin	$context	Context to use; formerly it was a Skin object. Use of Skin is deprecated.
LinkRenderer \| null	$linkRenderer	previously unused
int	$flags	Can be a combination of self::NO_ACTION_LINK, self::NO_EXTRA_USER_LINKS or self::USE_CHECKBOXES.

Definition at line 72 of file LogEventsList.php.

References ContextSource\$context, $flags, $linkRenderer, getUser(), ContextSource\setContext(), and ChangeTags\showTagEditingUI().

Member Function Documentation

◆ beginLogEventsList()

LogEventsList::beginLogEventsList ( )

Returns: string

Definition at line 361 of file LogEventsList.php.

◆ endLogEventsList()

LogEventsList::endLogEventsList ( )

Returns: string

Definition at line 368 of file LogEventsList.php.

◆ getActionSelectorDesc()

LogEventsList::getActionSelectorDesc	(	$types,
		$action
	)

private

Drop down menu for selection of actions that can be used to filter the log.

Parameters

array	$types
string	$action

Returns: array Form descriptor

Definition at line 330 of file LogEventsList.php.

References ContextSource\msg().

Referenced by showOptions().

◆ getExcludeClause()

static LogEventsList::getExcludeClause	(		$db,
			$audience = `'public'`,
		User	$user = `null`
	)

static

SQL clause to skip forbidden log types for this user.

Parameters

IDatabase	$db
string	$audience	Public/user
User \| null	$user	User to check, or null to use $wgUser (deprecated since 1.35)

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

Definition at line 797 of file LogEventsList.php.

References $wgLogRestrictions, getPermissionManager(), and wfDeprecated().

◆ getExtraInputsDesc()

LogEventsList::getExtraInputsDesc ( $types )

private

Parameters

array $types

Returns: array|string Form descriptor or string with HTML

Definition at line 302 of file LogEventsList.php.

Referenced by showOptions().

◆ getFiltersDesc()

LogEventsList::getFiltersDesc ( $filter )

private

Parameters

array $filter

Returns: array Form descriptor

Definition at line 205 of file LogEventsList.php.

References $type.

Referenced by showOptions().

◆ getLinkRenderer()

LogEventsList::getLinkRenderer ( )

protected

Since: 1.30

Returns: LinkRenderer

Definition at line 92 of file LogEventsList.php.

Referenced by logLine().

◆ getShowHideLinks()

LogEventsList::getShowHideLinks ( $row )

private

Parameters

stdClass $row

Returns: string

Definition at line 433 of file LogEventsList.php.

References LogPage\DELETED_RESTRICTED, SpecialPage\getTitleFor(), getUser(), Linker\revDeleteLink(), and Linker\revDeleteLinkDisabled().

Referenced by logLine().

◆ getTitleInputDesc()

LogEventsList::getTitleInputDesc ( $title )

private

Parameters

string $title

Returns: array Form descriptor

Definition at line 277 of file LogEventsList.php.

Referenced by showOptions().

◆ getTitlePatternDesc()

LogEventsList::getTitlePatternDesc ( $pattern )

private

Parameters

bool $pattern

Returns: array Form descriptor

Definition at line 290 of file LogEventsList.php.

Referenced by showOptions().

◆ getTypeMenuDesc()

LogEventsList::getTypeMenuDesc ( $queryTypes )

private

Parameters

array $queryTypes

Returns: array Form descriptor

Definition at line 228 of file LogEventsList.php.

References $type, getPermissionManager(), getUser(), and LogPage\validTypes().

Referenced by showOptions().

◆ getUserInputDesc()

LogEventsList::getUserInputDesc ( $user )

private

Parameters

string $user

Returns: array Form descriptor

Definition at line 264 of file LogEventsList.php.

Referenced by showOptions().

◆ isDeleted()

static LogEventsList::isDeleted	(	$row,
		$field
	)

static

Parameters

stdClass	$row
int	$field	One of DELETED_* bitfield constants

Returns: bool

Definition at line 605 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 376 of file LogEventsList.php.

References ChangeTags\formatSummaryRow(), getContext(), ContextSource\getLanguage(), getLinkRenderer(), getShowHideLinks(), and LogFormatter\newFromEntry().

◆ setAllowedActions()

LogEventsList::setAllowedActions ( $actions )

Sets the action types allowed for log filtering To one action type may correspond several log_actions.

Parameters

array $actions

Since: 1.27

Definition at line 354 of file LogEventsList.php.

◆ 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 \| Title	$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. 'log_action != ' . $dbr->addQuotes( '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 master 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 634 of file LogEventsList.php.

References $args, ContextSource\$context, $flags, $lang, $linkRenderer, $s, DB_MASTER, IContextSource\getLanguage(), IContextSource\getOutput(), MessageLocalizer\msg(), and wfGetDB().

◆ showOptions()

LogEventsList::showOptions	(	$types = `[]`,
		$user = `''`,
		$page = `''`,
		$pattern = `false`,
		$year = `0`,
		$month = `0`,
		$day = `0`,
		$filter = `null`,
		$tagFilter = `''`,
		$action = `null`
	)

Show options for the log list.

Parameters

array \| string	$types
string	$user
string	$page
bool	$pattern
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.
array \| null	$filter
string	$tagFilter	Tag to select by default
string \| null	$action

Definition at line 116 of file LogEventsList.php.

References ContextSource\$context, getActionSelectorDesc(), ContextSource\getConfig(), getContext(), getExtraInputsDesc(), getFiltersDesc(), SpecialPage\getTitleFor(), getTitleInputDesc(), getTitlePatternDesc(), getTypeMenuDesc(), getUserInputDesc(), ContextSource\msg(), and wfDeprecated().

◆ typeAction()

static LogEventsList::typeAction	(	$row,
		$type,
		$action,
		$right = `''`
	)

static

Parameters

stdClass	$row
string \| array	$type
string \| array	$action
string	$right	(deprecated since 1.35)

Returns: bool

Definition at line 507 of file LogEventsList.php.

References $type, and wfDeprecated().

◆ userCan()

static LogEventsList::userCan	(		$row,
			$field,
		User	$user = `null`
	)

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
User \| null	$user	User to check, or null to use $wgUser (deprecated since 1.35)

Returns: bool

Definition at line 536 of file LogEventsList.php.

References wfDeprecated().

◆ userCanBitfield()

static LogEventsList::userCanBitfield	(		$bitfield,
			$field,
		User	$user = `null`
	)

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
User \| null	$user	User to check, or null to use $wgUser (deprecated since 1.35)

Returns: bool

Definition at line 555 of file LogEventsList.php.

References LogPage\DELETED_RESTRICTED, wfDebug(), and wfDeprecated().

◆ userCanViewLogType()

static LogEventsList::userCanViewLogType	(		$type,
		User	$user = `null`
	)

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

stdClass	$type
User \| null	$user	User to check, or null to use $wgUser (deprecated since 1.35)

Returns: bool

Definition at line 584 of file LogEventsList.php.

References $type, getPermissionManager(), and wfDeprecated().

Member Data Documentation

◆ $allowedActions

array LogEventsList::$allowedActions = null

protected

Definition at line 52 of file LogEventsList.php.

◆ $flags

LogEventsList::$flags

Definition at line 36 of file LogEventsList.php.

Referenced by __construct(), and showLogExtract().

◆ $hookRunner

HookRunner LogEventsList::$hookRunner

private

Definition at line 60 of file LogEventsList.php.

◆ $linkRenderer

LinkRenderer null LogEventsList::$linkRenderer

private

Definition at line 57 of file LogEventsList.php.

Referenced by __construct(), and showLogExtract().

◆ $mDefaultQuery

array LogEventsList::$mDefaultQuery

protected

Deprecated:: since 1.34, no longer used.

Definition at line 42 of file LogEventsList.php.

◆ $showTagEditUI

bool LogEventsList::$showTagEditUI

protected

Definition at line 47 of file LogEventsList.php.

◆ NO_ACTION_LINK

const LogEventsList::NO_ACTION_LINK = 1

Definition at line 32 of file LogEventsList.php.

◆ NO_EXTRA_USER_LINKS

const LogEventsList::NO_EXTRA_USER_LINKS = 2

Definition at line 33 of file LogEventsList.php.

◆ USE_CHECKBOXES

const LogEventsList::USE_CHECKBOXES = 4

Definition at line 34 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

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beginLogEventsList()

◆ endLogEventsList()

◆ getActionSelectorDesc()

◆ getExcludeClause()

◆ getExtraInputsDesc()

◆ getFiltersDesc()

◆ getLinkRenderer()

◆ getShowHideLinks()

◆ getTitleInputDesc()

◆ getTitlePatternDesc()

◆ getTypeMenuDesc()

◆ getUserInputDesc()

◆ isDeleted()

◆ logLine()

◆ setAllowedActions()

◆ showLogExtract()

◆ showOptions()

◆ typeAction()

◆ userCan()

◆ userCanBitfield()

◆ userCanViewLogType()

Member Data Documentation

◆ $allowedActions

◆ $flags

◆ $hookRunner

◆ $linkRenderer

◆ $mDefaultQuery

◆ $showTagEditUI

◆ NO_ACTION_LINK

◆ NO_EXTRA_USER_LINKS

◆ USE_CHECKBOXES