Implements the default log formatting. More...

Inherited by BlockLogFormatter, ContentModelLogFormatter, DeleteLogFormatter, ImportLogFormatter, LegacyLogFormatter, MergeLogFormatter, MoveLogFormatter, NewUsersLogFormatter, PageLangLogFormatter, PatrolLogFormatter, ProtectLogFormatter, RenameuserLogFormatter, RightsLogFormatter, TagLogFormatter, UploadLogFormatter, and WikitextLogFormatter.

Collaboration diagram for LogFormatter:

[legend]

Public Member Functions
	canViewLogType ()
	Check if a log item type can be displayed.

	formatParametersForApi ()
	Format parameters for API output.

	getActionLinks ()
	Returns extra links that comes after the action text, like "revert", etc.

	getActionText ()
	Gets the log action, including username.

	getComment ()
	Gets the user provided comment.

	getIRCActionComment ()
	Even uglier hack to maintain backwards compatibility with IRC bots (T36508).

	getIRCActionText ()
	Even uglier hack to maintain backwards compatibility with IRC bots (T36508).

	getLinkRenderer ()

	getMessageParametersForTesting ()

	getPerformerElement ()
	Provides the name of the user who performed the log action.

	getPlainActionText ()
	Ugly hack to produce plaintext version of the message.

	getPreloadTitles ()

	setAudience ( $audience)
	Set the visibility restrictions for displaying content.

	setContext (IContextSource $context)
	Replace the default context.

	setLinkRenderer (LinkRenderer $linkRenderer)

	setShowUserToolLinks ( $value)
	If set to true, will produce user tool links after the user name.

Static Public Member Functions
static	newFromEntry (LogEntry $entry)
	Constructs a new formatter suitable for given entry.

static	newFromRow ( $row)
	Handy shortcut for constructing a formatter directly from database row.

Public Attributes
IContextSource	$context
	Context for logging.

const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

Protected Member Functions
	__construct (LogEntry $entry)

	canView ( $field)
	Check if a log item can be displayed.

	extractParameters ()
	Extracts the optional extra parameters for use in action messages.

	formatParameterValue ( $type, $value)
	Formats parameters values dependent to their type.

	formatParameterValueForApi ( $name, $type, $value)
	Format a single parameter value for API output.

	getActionMessage ()
	Returns a sentence describing the log action.

	getMessageKey ()
	Returns a key to be used for formatting the action sentence.

	getMessageParameters ()
	Formats parameters intended for action message from array of all parameters.

	getParametersForApi ()
	Get the array of parameters, converted from legacy format if necessary.

	getRestrictedElement ( $message)
	Helper method for displaying restricted element.

	makePageLink (Title $title=null, $parameters=[], $html=null)
	Helper to make a link to the page, taking the plaintext value in consideration.

	makeUserLink (UserIdentity $user, $toolFlags=0)

	msg ( $key,... $params)
	Shortcut for wfMessage which honors local context.

	styleRestrictedElement ( $content)
	Helper method for styling restricted element.

Protected Attributes
int	$audience = self::FOR_PUBLIC
	Constant for handling log_deleted.

LogEntryBase	$entry

bool	$irctext = false

bool	$linkFlood = false
	Whether to output user tool links.

array	$parsedParameters

bool	$plaintext = false
	Set to true if we are constructing a message text that is going to be included in page history or send to IRC feed.

Detailed Description

Implements the default log formatting.

Can be overridden by subclassing and setting:

    $wgLogActionsHandlers['type/subtype'] = 'class'; or
    $wgLogActionsHandlers['type/*'] = 'class';
* 

Stability: stable: to extend

Since: 1.19

Definition at line 47 of file LogFormatter.php.

Constructor & Destructor Documentation

◆ __construct()

LogFormatter::__construct ( LogEntry $entry )

protected

Stability: stable: to call

Parameters

LogEntry $entry

Definition at line 126 of file LogFormatter.php.

Member Function Documentation

◆ canView()

LogFormatter::canView ( $field )

protected

Check if a log item can be displayed.

Parameters

int $field LogPage::DELETED_* constant

Returns: bool

Definition at line 189 of file LogFormatter.php.

Referenced by getActionText(), getComment(), getMessageParameters(), and getPerformerElement().

◆ canViewLogType()

LogFormatter::canViewLogType ( )

Check if a log item type can be displayed.

Returns: bool

Definition at line 175 of file LogFormatter.php.

References $type.

◆ extractParameters()

LogFormatter::extractParameters ( )

protected

Extracts the optional extra parameters for use in action messages.

The array indexes start from number 3.

Stability: stable: to override

Returns: array

Reimplemented in BlockLogFormatter.

Definition at line 529 of file LogFormatter.php.

References $type, formatParameterValue(), LogEntry\getParameters(), and LogEntryBase\isLegacy().

Referenced by ContentModelLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), MergeLogFormatter\getActionLinks(), MoveLogFormatter\getActionLinks(), ImportLogFormatter\getMessageKey(), MoveLogFormatter\getMessageKey(), ProtectLogFormatter\getMessageKey(), RenameuserLogFormatter\getMessageKey(), getMessageParameters(), MergeLogFormatter\getPreloadTitles(), MoveLogFormatter\getPreloadTitles(), ProtectLogFormatter\getPreloadTitles(), and RenameuserLogFormatter\getPreloadTitles().

◆ formatParametersForApi()

LogFormatter::formatParametersForApi ( )

Format parameters for API output.

The result array should generally map named keys to values. Index and type should be omitted, e.g. "4::foo" should be returned as "foo" in the output. Values should generally be unformatted.

Renames or removals of keys besides from the legacy numeric format to modern named style should be avoided. Any renames should be announced to the mediawiki-api-announce mailing list.

Since: 1.25

Stability: stable: to override

Returns: array

Reimplemented in BlockLogFormatter, DeleteLogFormatter, ProtectLogFormatter, and RightsLogFormatter.

Definition at line 862 of file LogFormatter.php.

References formatParameterValueForApi(), getParametersForApi(), and wfLogWarning().

◆ formatParameterValue()

LogFormatter::formatParameterValue	(		$type,
			$value )

protected

Formats parameters values dependent to their type.

Parameters

string	$type	The type of the value. Valid are currently: - (empty) or plain: The value is returned as-is raw: The value will be added to the log message as raw parameter (e.g. no escaping) Use this only if there is no other working type like user-link or title-link msg: The value is a message-key, the output is the message in user language msg-content: The value is a message-key, the output is the message in content language user: The value is a user name, e.g. for GENDER user-link: The value is a user name, returns a link for the user title: The value is a page title, returns name of page title-link: The value is a page title, returns link to this page number: Format value as number list: Format value as a comma-separated list
mixed	$value	The parameter value that should be formatted

Returns: string|array Formatted value

Since: 1.21

Definition at line 621 of file LogFormatter.php.

References $title, $type, makePageLink(), makeUserLink(), msg(), User\newFromName(), Message\numParam(), Message\rawParam(), and setShowUserToolLinks().

Referenced by extractParameters().

◆ formatParameterValueForApi()

LogFormatter::formatParameterValueForApi	(	$name,
		$type,
		$value )

protected

Format a single parameter value for API output.

Since: 1.25

Parameters

string	$name
string	$type
string	$value

Returns: array

Definition at line 892 of file LogFormatter.php.

References $title, $type, SpecialPage\getTitleFor(), msg(), User\newFromName(), and wfTimestamp().

Referenced by BlockLogFormatter\formatParametersForApi(), and formatParametersForApi().

◆ getActionLinks()

LogFormatter::getActionLinks ( )

Returns extra links that comes after the action text, like "revert", etc.

Stability: stable: to override

Returns: string

Reimplemented in BlockLogFormatter, ContentModelLogFormatter, DeleteLogFormatter, LegacyLogFormatter, MergeLogFormatter, MoveLogFormatter, and ProtectLogFormatter.

Definition at line 519 of file LogFormatter.php.

◆ getActionMessage()

LogFormatter::getActionMessage ( )

protected

Returns a sentence describing the log action.

Usually a Message object is returned, but old style log types and entries might return pre-escaped HTML string.

Returns: Message|string Pre-escaped HTML

Reimplemented in LegacyLogFormatter, and WikitextLogFormatter.

Definition at line 491 of file LogFormatter.php.

References getMessageKey(), getMessageParameters(), and msg().

Referenced by getActionText().

◆ getActionText()

LogFormatter::getActionText ( )

Gets the log action, including username.

Stability: stable: to override

Returns: string HTML phan-taint-check gets very confused by $this->plaintext, so disable.; -taint onlysafefor_html

Definition at line 466 of file LogFormatter.php.

References canView(), getActionMessage(), getPerformerElement(), getRestrictedElement(), msg(), and styleRestrictedElement().

Referenced by getPlainActionText().

◆ getComment()

LogFormatter::getComment ( )

Gets the user provided comment.

Stability: stable: to override

Returns: string HTML

Reimplemented in LegacyLogFormatter, and NewUsersLogFormatter.

Definition at line 728 of file LogFormatter.php.

References canView(), getRestrictedElement(), and styleRestrictedElement().

◆ getIRCActionComment()

LogFormatter::getIRCActionComment ( )

Even uglier hack to maintain backwards compatibility with IRC bots (T36508).

See also: getActionText()

Returns: string Text

Definition at line 231 of file LogFormatter.php.

References getIRCActionText(), and wfMessage().

◆ getIRCActionText()

LogFormatter::getIRCActionText ( )

Even uglier hack to maintain backwards compatibility with IRC bots (T36508).

See also: getActionText()

Returns: string Text

Definition at line 253 of file LogFormatter.php.

References LogEntry\getParameters(), getPlainActionText(), LogEntry\getSubtype(), LogEntry\getTarget(), LogEntry\getTimestamp(), LogEntry\getType(), LogEntryBase\isLegacy(), wfMessage(), and wfTimestamp().

Referenced by getIRCActionComment().

◆ getLinkRenderer()

LogFormatter::getLinkRenderer ( )

Since: 1.30

Returns: LinkRenderer

Definition at line 151 of file LogFormatter.php.

Referenced by BlockLogFormatter\getActionLinks(), ContentModelLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), MergeLogFormatter\getActionLinks(), MoveLogFormatter\getActionLinks(), ProtectLogFormatter\getActionLinks(), PatrolLogFormatter\getMessageParameters(), TagLogFormatter\getMessageParameters(), makePageLink(), and RenameuserLogFormatter\myPageLink().

◆ getMessageKey()

LogFormatter::getMessageKey ( )

protected

Returns a key to be used for formatting the action sentence.

Default is logentry-TYPE-SUBTYPE for modern logs. Legacy log types will use custom keys, and subclasses can also alter the key depending on the entry itself.

Stability: stable: to override

Returns: string Message key

Reimplemented in BlockLogFormatter, DeleteLogFormatter, ImportLogFormatter, MoveLogFormatter, PatrolLogFormatter, ProtectLogFormatter, RenameuserLogFormatter, RightsLogFormatter, and TagLogFormatter.

Definition at line 506 of file LogFormatter.php.

References $type.

Referenced by getActionMessage().

◆ getMessageParameters()

LogFormatter::getMessageParameters ( )

protected

Formats parameters intended for action message from array of all parameters.

There are three hardcoded parameters (array is zero-indexed, this list not):

1: user name with premade link
2: usable for gender magic function
3: target page with premade link
Stability: stable
to override

Returns
array

Reimplemented in BlockLogFormatter, ContentModelLogFormatter, DeleteLogFormatter, MergeLogFormatter, MoveLogFormatter, NewUsersLogFormatter, PageLangLogFormatter, PatrolLogFormatter, ProtectLogFormatter, RenameuserLogFormatter, RightsLogFormatter, and TagLogFormatter.

Definition at line 577 of file LogFormatter.php.

References canView(), extractParameters(), getPerformerElement(), LogEntry\getPerformerIdentity(), LogEntry\getTarget(), makePageLink(), and Message\rawParam().

Referenced by getActionMessage(), and getMessageParametersForTesting().

◆ getMessageParametersForTesting()

LogFormatter::getMessageParametersForTesting ( )

Returns: array Output of getMessageParameters() for testing

Definition at line 830 of file LogFormatter.php.

References getMessageParameters().

◆ getParametersForApi()

LogFormatter::getParametersForApi ( )

protected

Get the array of parameters, converted from legacy format if necessary.

Since: 1.25

Stability: stable: to override

Returns: array

Reimplemented in BlockLogFormatter, DeleteLogFormatter, MergeLogFormatter, MoveLogFormatter, PatrolLogFormatter, ProtectLogFormatter, RightsLogFormatter, and UploadLogFormatter.

Definition at line 843 of file LogFormatter.php.

Referenced by formatParametersForApi().

◆ getPerformerElement()

LogFormatter::getPerformerElement ( )

Provides the name of the user who performed the log action.

Used as part of log action message or standalone, depending which parts of the log entry has been hidden.

Returns: string

Definition at line 709 of file LogFormatter.php.

References canView(), getRestrictedElement(), makeUserLink(), and styleRestrictedElement().

Referenced by LegacyLogFormatter\getActionMessage(), getActionText(), and getMessageParameters().

◆ getPlainActionText()

LogFormatter::getPlainActionText ( )

Ugly hack to produce plaintext version of the message.

Usually you also want to set extraneous request context to avoid formatting for any particular user.

See also: getActionText()

Returns: string Plain text; -taint tainted

Definition at line 217 of file LogFormatter.php.

References getActionText().

Referenced by getIRCActionText().

◆ getPreloadTitles()

LogFormatter::getPreloadTitles ( )

Stability: stable: to override

Returns: LinkTarget[] Array of titles that should be preloaded with LinkBatch

Reimplemented in BlockLogFormatter, MergeLogFormatter, MoveLogFormatter, NewUsersLogFormatter, ProtectLogFormatter, and RenameuserLogFormatter.

Definition at line 823 of file LogFormatter.php.

◆ getRestrictedElement()

LogFormatter::getRestrictedElement ( $message )

protected

Helper method for displaying restricted element.

Parameters

string $message

Returns: string HTML or wiki text; -taint onlysafefor_html

Definition at line 750 of file LogFormatter.php.

References msg(), and styleRestrictedElement().

Referenced by getActionText(), getComment(), and getPerformerElement().

◆ makePageLink()

LogFormatter::makePageLink	(	Title	$title = null,
			$parameters = [],
			$html = null )

protected

Helper to make a link to the page, taking the plaintext value in consideration.

Stability: stable: to override

Parameters

Title \| null	$title	The page
array	$parameters	Query parameters
string \| null	$html	Linktext of the link as raw html

Returns: string wikitext or html; -taint onlysafefor_html

Reimplemented in RightsLogFormatter.

Definition at line 683 of file LogFormatter.php.

References $title, getLinkRenderer(), and msg().

Referenced by formatParameterValue(), BlockLogFormatter\getMessageParameters(), getMessageParameters(), MergeLogFormatter\getMessageParameters(), MoveLogFormatter\getMessageParameters(), and ProtectLogFormatter\getMessageParameters().

◆ makeUserLink()

LogFormatter::makeUserLink	(	UserIdentity	$user,
			$toolFlags = 0 )

protected

Parameters

UserIdentity	$user
int	$toolFlags	Combination of Linker::TOOL_LINKS_* flags

Returns: string wikitext or html; -taint onlysafefor_html

Definition at line 791 of file LogFormatter.php.

References MediaWiki\User\UserIdentity\getId(), MediaWiki\User\UserIdentity\getName(), and MediaWiki\User\UserIdentity\isRegistered().

Referenced by formatParameterValue(), BlockLogFormatter\getMessageParameters(), NewUsersLogFormatter\getMessageParameters(), and getPerformerElement().

◆ msg()

LogFormatter::msg	(		$key,
			$params )

protected

Shortcut for wfMessage which honors local context.

Parameters

string	$key
	mixed	...$params

Returns: Message

Definition at line 781 of file LogFormatter.php.

Referenced by formatParameterValue(), formatParameterValueForApi(), RightsLogFormatter\formatRightsList(), BlockLogFormatter\getActionLinks(), ContentModelLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), MergeLogFormatter\getActionLinks(), MoveLogFormatter\getActionLinks(), ProtectLogFormatter\getActionLinks(), LegacyLogFormatter\getActionMessage(), getActionMessage(), getActionText(), BlockLogFormatter\getMessageParameters(), DeleteLogFormatter\getMessageParameters(), PageLangLogFormatter\getMessageParameters(), RightsLogFormatter\getMessageParameters(), getRestrictedElement(), and makePageLink().

◆ newFromEntry()

static LogFormatter::newFromEntry ( LogEntry $entry )

static

Constructs a new formatter suitable for given entry.

Parameters

LogEntry $entry

Returns: LogFormatter

Definition at line 59 of file LogFormatter.php.

References LogEntry\getFullType(), and LogEntry\getType().

◆ newFromRow()

static LogFormatter::newFromRow ( $row )

static

Handy shortcut for constructing a formatter directly from database row.

Parameters

stdClass | array $row

See also: DatabaseLogEntry::getSelectQueryData

Returns: LogFormatter

Definition at line 80 of file LogFormatter.php.

Referenced by MediaWiki\Feed\FeedUtils\formatDiff().

◆ setAudience()

LogFormatter::setAudience ( $audience )

Set the visibility restrictions for displaying content.

If set to public, and an item is deleted, then it will be replaced with a placeholder even if the context user is allowed to view it.

Parameters

int $audience Const self::FOR_THIS_USER or self::FOR_PUBLIC

Definition at line 165 of file LogFormatter.php.

◆ setContext()

LogFormatter::setContext ( IContextSource $context )

Replace the default context.

Parameters

IContextSource $context

Definition at line 135 of file LogFormatter.php.

◆ setLinkRenderer()

LogFormatter::setLinkRenderer ( LinkRenderer $linkRenderer )

Since: 1.30

Parameters

LinkRenderer $linkRenderer

Definition at line 143 of file LogFormatter.php.

◆ setShowUserToolLinks()

LogFormatter::setShowUserToolLinks ( $value )

If set to true, will produce user tool links after the user name.

This should be replaced with generic CSS/JS solution.

Parameters

bool $value

Definition at line 205 of file LogFormatter.php.

Referenced by formatParameterValue().

◆ styleRestrictedElement()

LogFormatter::styleRestrictedElement ( $content )

protected

Helper method for styling restricted element.

Parameters

string $content

Returns: string HTML or wiki text

Definition at line 763 of file LogFormatter.php.

References $content.

Referenced by getActionText(), getComment(), getPerformerElement(), and getRestrictedElement().

Member Data Documentation

◆ $audience

int LogFormatter::$audience = self::FOR_PUBLIC

protected

Constant for handling log_deleted.

Definition at line 90 of file LogFormatter.php.

◆ $context

IContextSource LogFormatter::$context

Context for logging.

Definition at line 93 of file LogFormatter.php.

◆ $entry

LogEntryBase LogFormatter::$entry

protected

Definition at line 87 of file LogFormatter.php.

Referenced by LegacyLogFormatter\getActionMessage(), BlockLogFormatter\getParametersForApi(), DeleteLogFormatter\getParametersForApi(), MergeLogFormatter\getParametersForApi(), MoveLogFormatter\getParametersForApi(), PatrolLogFormatter\getParametersForApi(), ProtectLogFormatter\getParametersForApi(), RightsLogFormatter\getParametersForApi(), and UploadLogFormatter\getParametersForApi().

◆ $irctext

bool LogFormatter::$irctext = false

protected

Definition at line 108 of file LogFormatter.php.

◆ $linkFlood

bool LogFormatter::$linkFlood = false

protected

Whether to output user tool links.

Definition at line 96 of file LogFormatter.php.

◆ $parsedParameters

array LogFormatter::$parsedParameters

protected

See also: LogFormatter::getMessageParameters

Definition at line 119 of file LogFormatter.php.

◆ $plaintext

bool LogFormatter::$plaintext = false

protected

Set to true if we are constructing a message text that is going to be included in page history or send to IRC feed.

Links are replaced with plaintext or with [[pagename]] kind of syntax, that is parsed by page histories and IRC feeds.

Definition at line 105 of file LogFormatter.php.

◆ FOR_PUBLIC

const LogFormatter::FOR_PUBLIC = 1

Definition at line 49 of file LogFormatter.php.

◆ FOR_THIS_USER

const LogFormatter::FOR_THIS_USER = 2

Definition at line 50 of file LogFormatter.php.

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

includes/logging/LogFormatter.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canView()

◆ canViewLogType()

◆ extractParameters()

◆ formatParametersForApi()

◆ formatParameterValue()

◆ formatParameterValueForApi()

◆ getActionLinks()

◆ getActionMessage()

◆ getActionText()

◆ getComment()

◆ getIRCActionComment()

◆ getIRCActionText()

◆ getLinkRenderer()

◆ getMessageKey()

◆ getMessageParameters()

◆ getMessageParametersForTesting()

◆ getParametersForApi()

◆ getPerformerElement()

◆ getPlainActionText()

◆ getPreloadTitles()

◆ getRestrictedElement()

◆ makePageLink()

◆ makeUserLink()

◆ msg()

◆ newFromEntry()

◆ newFromRow()

◆ setAudience()

◆ setContext()

◆ setLinkRenderer()

◆ setShowUserToolLinks()

◆ styleRestrictedElement()

Member Data Documentation

◆ $audience

◆ $context

◆ $entry

◆ $irctext

◆ $linkFlood

◆ $parsedParameters

◆ $plaintext

◆ FOR_PUBLIC

◆ FOR_THIS_USER