Inheritance diagram for LogEventsList:

[legend]

Collaboration diagram for LogEventsList:

[legend]

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

	beginLogEventsList ()

	endLogEventsList ()

	logLine ( $row)

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

	showOptions ( $types=[], $user='', $page='', $pattern=false, $year=0, $month=0, $day=0, $filter=null, $tagFilter='', $action=null, $extras=[], $tagInvert=false)
	Show options for the log list. 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...

	getActionName ()
	Get the action name for the current web request. More...

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object. More...

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens. More...

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getTiming ()

	getTitle ()

	getUser ()

	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)

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

static	isDeleted ( $row, $field)

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

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

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

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

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

bool	$showTagEditUI

Detailed Description

Definition at line 35 of file LogEventsList.php.

Constructor & Destructor Documentation

◆ __construct()

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

Stability: stable: to call. As of the 1.36 release, there is no factory for this class, and it is instantiated directly by several extensions. The constructor needs to retain backwards compatibility until a factory has been introduced.

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

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

Member Function Documentation

◆ beginLogEventsList()

LogEventsList::beginLogEventsList ( )

Returns: string

Definition at line 371 of file LogEventsList.php.

◆ endLogEventsList()

LogEventsList::endLogEventsList ( )

Returns: string

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

Referenced by WikiExporter\dumpLogs(), ApiQueryLogEvents\execute(), and ApiQueryLogEvents\getCacheMode().

◆ getLinkRenderer()

LogEventsList::getLinkRenderer ( )

protected

Since: 1.30

Returns: LinkRenderer

Definition at line 84 of file LogEventsList.php.

Referenced by logLine().

◆ isDeleted()

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

static

Parameters

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

Returns: bool

Definition at line 590 of file LogEventsList.php.

Referenced by ProtectedPagesPager\formatValue().

◆ logLine()

LogEventsList::logLine ( $row )

Parameters

stdClass $row A single row from the result set

Returns: string Formatted HTML list item

Definition at line 386 of file LogEventsList.php.

References ChangeTags\formatSummaryRow(), ContextSource\getContext(), ContextSource\getLanguage(), getLinkRenderer(), SpecialPage\getTitleValueFor(), LogFormatter\newFromEntry(), and DatabaseLogEntry\newFromRow().

◆ 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 364 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 \| 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. '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 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 619 of file LogEventsList.php.

References $flags, DB_PRIMARY, RequestContext\getMain(), MediaWiki\HookContainer\HookRunner\onLogEventsListShowLogExtract(), and wfGetDB().

Referenced by MediaWiki\Specials\SpecialContributions\contributionsSub(), MediaWiki\Specials\SpecialEditTags\execute(), SpecialRevisionDelete\execute(), SpecialUnblock\execute(), SpecialUpload\getUploadForm(), ImagePage\openShowImage(), MediaWiki\Specials\SpecialBlock\postHtml(), MediaWiki\Specials\SpecialChangeContentModel\postHtml(), MediaWiki\Specials\SpecialMovePage\showForm(), SpecialUndelete\showHistory(), MediaWiki\Specials\SpecialUserRights\showLogFragment(), and Article\showMissingArticle().

◆ showOptions()

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

Show options for the log list.

Parameters

array \| string	$types
string	$user
string \| PageReference	$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
array	$extras
bool	$tagInvert	whether tags are filtered for (false) or out (true)

Definition at line 110 of file LogEventsList.php.

References HTMLForm\factory(), ContextSource\getConfig(), ContextSource\getContext(), SpecialPage\getTitleFor(), and wfDeprecated().

◆ typeAction()

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

static

Parameters

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

Returns: bool

Definition at line 523 of file LogEventsList.php.

References $type.

◆ 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
Authority	$performer	User to check

Returns: bool

Definition at line 543 of file LogEventsList.php.

References userCanBitfield(), and userCanViewLogType().

Referenced by ChangeTagsLogItem\canView(), RevDelLogItem\canView(), and RevDelLogItem\getApiData().

◆ 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
Authority	$performer	User to check

Returns: bool

Definition at line 557 of file LogEventsList.php.

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

Referenced by LogFormatter\canView(), ApiQueryRecentChanges\extractRowInfo(), ProtectedPagesPager\formatValue(), ChangesList\userCan(), and userCan().

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

References $type, and MediaWiki\Permissions\Authority\isAllowed().

Referenced by userCan().

Member Data Documentation

◆ $allowedActions

array LogEventsList::$allowedActions = null

protected

Definition at line 50 of file LogEventsList.php.

◆ $flags

LogEventsList::$flags

Definition at line 40 of file LogEventsList.php.

Referenced by __construct(), and showLogExtract().

◆ $showTagEditUI

bool LogEventsList::$showTagEditUI

protected

Definition at line 45 of file LogEventsList.php.

◆ NO_ACTION_LINK

const LogEventsList::NO_ACTION_LINK = 1

Definition at line 36 of file LogEventsList.php.

◆ NO_EXTRA_USER_LINKS

const LogEventsList::NO_EXTRA_USER_LINKS = 2

Definition at line 37 of file LogEventsList.php.

◆ USE_CHECKBOXES

const LogEventsList::USE_CHECKBOXES = 4

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

◆ setAllowedActions()

◆ showLogExtract()

◆ showOptions()

◆ typeAction()

◆ userCan()

◆ userCanBitfield()

◆ userCanViewLogType()

Member Data Documentation

◆ $allowedActions

◆ $flags

◆ $showTagEditUI

◆ NO_ACTION_LINK

◆ NO_EXTRA_USER_LINKS

◆ USE_CHECKBOXES