Implements the default log formatting. More...

Collaboration diagram for MediaWiki\Logging\LogFormatter:

[legend]

Public Member Functions
	__construct (LogEntry $entry)

	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.

	getCommentFormatter ()

	getContentLanguage ()

	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 ()

	getUserEditTracker ()

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

	setCommentFormatter (CommentFormatter $commentFormatter)

	setContentLanguage (Language $contentLanguage)

	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.

	setUserEditTracker (UserEditTracker $userEditTracker)

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
	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 null	$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 63 of file LogFormatter.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Logging\LogFormatter::__construct ( LogEntry $entry )

Stability: stable: to call

Parameters

LogEntry $entry

Definition at line 143 of file LogFormatter.php.

References MediaWiki\Logging\LogFormatter\$entry.

Member Function Documentation

◆ canView()

MediaWiki\Logging\LogFormatter::canView ( $field )

protected

Check if a log item can be displayed.

Parameters

int $field LogPage::DELETED_* constant

Returns: bool

Definition at line 269 of file LogFormatter.php.

◆ canViewLogType()

MediaWiki\Logging\LogFormatter::canViewLogType ( )

Check if a log item type can be displayed.

Returns: bool

Definition at line 255 of file LogFormatter.php.

◆ extractParameters()

MediaWiki\Logging\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 MediaWiki\Logging\BlockLogFormatter.

Definition at line 609 of file LogFormatter.php.

◆ formatParametersForApi()

MediaWiki\Logging\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 MediaWiki\Logging\BlockLogFormatter, MediaWiki\Logging\DeleteLogFormatter, MediaWiki\Logging\ProtectLogFormatter, and MediaWiki\Logging\RightsLogFormatter.

Definition at line 949 of file LogFormatter.php.

References wfLogWarning().

◆ formatParameterValue()

MediaWiki\Logging\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: mixed Formatted value

Since: 1.21

Definition at line 708 of file LogFormatter.php.

◆ formatParameterValueForApi()

MediaWiki\Logging\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 979 of file LogFormatter.php.

References wfTimestamp().

Referenced by MediaWiki\Logging\BlockLogFormatter\formatParametersForApi().

◆ getActionLinks()

MediaWiki\Logging\LogFormatter::getActionLinks ( )

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

Stability: stable: to override

Returns: string

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

Definition at line 599 of file LogFormatter.php.

◆ getActionMessage()

MediaWiki\Logging\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 MediaWiki\Logging\LegacyLogFormatter, and MediaWiki\Logging\WikitextLogFormatter.

Definition at line 571 of file LogFormatter.php.

◆ getActionText()

MediaWiki\Logging\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.

Definition at line 546 of file LogFormatter.php.

◆ getComment()

MediaWiki\Logging\LogFormatter::getComment ( )

Gets the user provided comment.

Stability: stable: to override

Returns: string HTML

Reimplemented in MediaWiki\Logging\LegacyLogFormatter, and MediaWiki\Logging\NewUsersLogFormatter.

Definition at line 815 of file LogFormatter.php.

◆ getCommentFormatter()

MediaWiki\Logging\LogFormatter::getCommentFormatter ( )

final

Since: 1.42

Returns: CommentFormatter

Definition at line 210 of file LogFormatter.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

◆ getContentLanguage()

MediaWiki\Logging\LogFormatter::getContentLanguage ( )

final

Since: 1.42

Returns: Language

Definition at line 189 of file LogFormatter.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

Referenced by MediaWiki\Logging\ProtectLogFormatter\formatParametersForApi(), and MediaWiki\Logging\RightsLogFormatter\makePageLink().

◆ getIRCActionComment()

MediaWiki\Logging\LogFormatter::getIRCActionComment ( )

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

See also: getActionText()

Returns: string Text

Definition at line 311 of file LogFormatter.php.

References wfMessage().

◆ getIRCActionText()

MediaWiki\Logging\LogFormatter::getIRCActionText ( )

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

See also: getActionText()

Returns: string Text

Definition at line 333 of file LogFormatter.php.

References wfMessage(), and wfTimestamp().

◆ getLinkRenderer()

MediaWiki\Logging\LogFormatter::getLinkRenderer ( )

Since: 1.30

Returns: LinkRenderer

Definition at line 167 of file LogFormatter.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

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

◆ getMessageKey()

MediaWiki\Logging\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 MediaWiki\Logging\BlockLogFormatter, MediaWiki\Logging\DeleteLogFormatter, MediaWiki\Logging\ImportLogFormatter, MediaWiki\Logging\MoveLogFormatter, MediaWiki\Logging\PatrolLogFormatter, MediaWiki\Logging\ProtectLogFormatter, MediaWiki\Logging\RenameuserLogFormatter, MediaWiki\Logging\RightsLogFormatter, and MediaWiki\Logging\TagLogFormatter.

Definition at line 586 of file LogFormatter.php.

◆ getMessageParameters()

MediaWiki\Logging\LogFormatter::getMessageParameters ( )

protected

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

There are three hardcoded parameters:

$1: user name with premade link
$2: usable for gender magic function
$3: target page with premade link More parameters might be present, depending on what code created the log entry.

The parameters are returned as a non-associative array that can be passed to Message::params(), so $logFormatter->getMessageParameters()[0] is the $1 parameter in the message and so on.

Stability: stable: to override

Returns: array

See also: ManualLogEntry::setParameters() for how parameters are determined.

Definition at line 664 of file LogFormatter.php.

◆ getMessageParametersForTesting()

MediaWiki\Logging\LogFormatter::getMessageParametersForTesting ( )

Returns: array Output of getMessageParameters() for testing

Definition at line 917 of file LogFormatter.php.

◆ getParametersForApi()

MediaWiki\Logging\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 MediaWiki\Logging\BlockLogFormatter, MediaWiki\Logging\DeleteLogFormatter, MediaWiki\Logging\MergeLogFormatter, MediaWiki\Logging\MoveLogFormatter, MediaWiki\Logging\PatrolLogFormatter, MediaWiki\Logging\ProtectLogFormatter, MediaWiki\Logging\RightsLogFormatter, and MediaWiki\Logging\UploadLogFormatter.

Definition at line 930 of file LogFormatter.php.

◆ getPerformerElement()

MediaWiki\Logging\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 796 of file LogFormatter.php.

Referenced by MediaWiki\Logging\LegacyLogFormatter\getActionMessage().

◆ getPlainActionText()

MediaWiki\Logging\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

Definition at line 297 of file LogFormatter.php.

◆ getPreloadTitles()

MediaWiki\Logging\LogFormatter::getPreloadTitles ( )

Stability: stable: to override

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

Reimplemented in MediaWiki\Logging\BlockLogFormatter, MediaWiki\Logging\MergeLogFormatter, MediaWiki\Logging\MoveLogFormatter, MediaWiki\Logging\NewUsersLogFormatter, MediaWiki\Logging\ProtectLogFormatter, and MediaWiki\Logging\RenameuserLogFormatter.

Definition at line 910 of file LogFormatter.php.

◆ getRestrictedElement()

MediaWiki\Logging\LogFormatter::getRestrictedElement ( $message )

protected

Helper method for displaying restricted element.

Parameters

string $message

Returns: string HTML or wiki text

Definition at line 837 of file LogFormatter.php.

◆ getUserEditTracker()

MediaWiki\Logging\LogFormatter::getUserEditTracker ( )

final

Since: 1.42

Returns: UserEditTracker

Definition at line 231 of file LogFormatter.php.

References wfDeprecated().

◆ makePageLink()

MediaWiki\Logging\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

Reimplemented in MediaWiki\Logging\RightsLogFormatter.

Definition at line 770 of file LogFormatter.php.

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

◆ makeUserLink()

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

protected

Parameters

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

Returns: string wikitext or html

Definition at line 880 of file LogFormatter.php.

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

Referenced by MediaWiki\Logging\BlockLogFormatter\getMessageParameters(), and MediaWiki\Logging\NewUsersLogFormatter\getMessageParameters().

◆ msg()

MediaWiki\Logging\LogFormatter::msg	(		$key,
			$params )

protected

Shortcut for wfMessage which honors local context.

Parameters

string	$key	@phpcs:ignore Generic.Files.LineLength
	MessageParam\|MessageSpecifier\|string\|int\|float\|list<MessageParam\|MessageSpecifier\|string\|int\|float>	...$params See Message::params()

Returns: Message

Definition at line 870 of file LogFormatter.php.

◆ newFromEntry()

static MediaWiki\Logging\LogFormatter::newFromEntry ( LogEntry $entry )

static

Constructs a new formatter suitable for given entry.

Parameters

LogEntry $entry

Returns: LogFormatter

Deprecated: since 1.42, use LogFormatterFactory instead, hard-deprecated since 1.43

Definition at line 76 of file LogFormatter.php.

References MediaWiki\Logging\LogFormatter\$entry, MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

Referenced by MediaWiki\Logging\LogFormatter\newFromRow().

◆ newFromRow()

static MediaWiki\Logging\LogFormatter::newFromRow ( $row )

static

Handy shortcut for constructing a formatter directly from database row.

Parameters

stdClass | array $row

See also: DatabaseLogEntry::getSelectQueryData

Returns: LogFormatter

Deprecated: since 1.42, use LogFormatterFactory instead, hard-deprecated since 1.43

Definition at line 89 of file LogFormatter.php.

References MediaWiki\Logging\LogFormatter\newFromEntry(), MediaWiki\Logging\DatabaseLogEntry\newFromRow(), and wfDeprecated().

◆ setAudience()

MediaWiki\Logging\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 245 of file LogFormatter.php.

◆ setCommentFormatter()

MediaWiki\Logging\LogFormatter::setCommentFormatter ( CommentFormatter $commentFormatter )

final

Access: internal: For factory only

Since: 1.42

Parameters

CommentFormatter $commentFormatter

Definition at line 202 of file LogFormatter.php.

◆ setContentLanguage()

MediaWiki\Logging\LogFormatter::setContentLanguage ( Language $contentLanguage )

final

Access: internal: For factory only

Since: 1.42

Parameters

Language $contentLanguage

Definition at line 181 of file LogFormatter.php.

◆ setContext()

MediaWiki\Logging\LogFormatter::setContext ( IContextSource $context )

Replace the default context.

Definition at line 151 of file LogFormatter.php.

References MediaWiki\Logging\LogFormatter\$context.

◆ setLinkRenderer()

MediaWiki\Logging\LogFormatter::setLinkRenderer ( LinkRenderer $linkRenderer )

Since: 1.30

Parameters

LinkRenderer $linkRenderer

Definition at line 159 of file LogFormatter.php.

◆ setShowUserToolLinks()

MediaWiki\Logging\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 285 of file LogFormatter.php.

◆ setUserEditTracker()

MediaWiki\Logging\LogFormatter::setUserEditTracker ( UserEditTracker $userEditTracker )

final

Access: internal: For factory only

Since: 1.42

Parameters

UserEditTracker $userEditTracker

Definition at line 223 of file LogFormatter.php.

◆ styleRestrictedElement()

MediaWiki\Logging\LogFormatter::styleRestrictedElement ( $content )

protected

Helper method for styling restricted element.

Parameters

string $content

Returns: string HTML or wiki text

Definition at line 850 of file LogFormatter.php.

Member Data Documentation

◆ $audience

int MediaWiki\Logging\LogFormatter::$audience = self::FOR_PUBLIC

protected

Constant for handling log_deleted.

Definition at line 100 of file LogFormatter.php.

◆ $context

IContextSource MediaWiki\Logging\LogFormatter::$context

Context for logging.

Definition at line 103 of file LogFormatter.php.

Referenced by MediaWiki\Logging\LogFormatter\setContext().

◆ $entry

LogEntryBase MediaWiki\Logging\LogFormatter::$entry

protected

Definition at line 97 of file LogFormatter.php.

◆ $irctext

bool MediaWiki\Logging\LogFormatter::$irctext = false

protected

Definition at line 118 of file LogFormatter.php.

◆ $linkFlood

bool MediaWiki\Logging\LogFormatter::$linkFlood = false

protected

Whether to output user tool links.

Definition at line 106 of file LogFormatter.php.

◆ $parsedParameters

array null MediaWiki\Logging\LogFormatter::$parsedParameters

protected

See also: LogFormatter::getMessageParameters

Definition at line 136 of file LogFormatter.php.

◆ $plaintext

bool MediaWiki\Logging\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 115 of file LogFormatter.php.

◆ FOR_PUBLIC

const MediaWiki\Logging\LogFormatter::FOR_PUBLIC = 1

Definition at line 65 of file LogFormatter.php.

◆ FOR_THIS_USER

const MediaWiki\Logging\LogFormatter::FOR_THIS_USER = 2

Definition at line 66 of file LogFormatter.php.

Referenced by MediaWiki\ChangeTags\ChangeTagsLogItem\getHTML().

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()

◆ getCommentFormatter()

◆ getContentLanguage()

◆ getIRCActionComment()

◆ getIRCActionText()

◆ getLinkRenderer()

◆ getMessageKey()

◆ getMessageParameters()

◆ getMessageParametersForTesting()

◆ getParametersForApi()

◆ getPerformerElement()

◆ getPlainActionText()

◆ getPreloadTitles()

◆ getRestrictedElement()

◆ getUserEditTracker()

◆ makePageLink()

◆ makeUserLink()

◆ msg()

◆ newFromEntry()

◆ newFromRow()

◆ setAudience()

◆ setCommentFormatter()

◆ setContentLanguage()

◆ setContext()

◆ setLinkRenderer()

◆ setShowUserToolLinks()

◆ setUserEditTracker()

◆ styleRestrictedElement()

Member Data Documentation

◆ $audience

◆ $context

◆ $entry

◆ $irctext

◆ $linkFlood

◆ $parsedParameters

◆ $plaintext

◆ FOR_PUBLIC

◆ FOR_THIS_USER