This class formats all log entries for log types which have not been converted to the new system. More...

Collaboration diagram for LegacyLogFormatter:

[legend]

Public Member Functions
	__construct (LogEntry $entry, HookContainer $hookContainer)

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

	getComment ()
	Gets the user provided comment.

Public Member Functions inherited from LogFormatter
	__construct (LogEntry $entry)

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

	formatParametersForApi ()
	Format parameters for API output.

	getActionText ()
	Gets the log action, including username.

	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)

Protected Member Functions
	getActionMessage ()

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

	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.

Additional Inherited Members
Static Public Member Functions inherited from LogFormatter
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 inherited from LogFormatter
IContextSource	$context
	Context for logging.

const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

Protected Attributes inherited from LogFormatter
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

This class formats all log entries for log types which have not been converted to the new system.

This is not about old log entries which store parameters in a different format - the new LogFormatter classes have code to support formatting those too.

Since: 1.19

Definition at line 38 of file LegacyLogFormatter.php.

Constructor & Destructor Documentation

◆ __construct()

LegacyLogFormatter::__construct	(	LogEntry	$entry,
		HookContainer	$hookContainer )

Definition at line 61 of file LegacyLogFormatter.php.

References LogFormatter\$entry.

Member Function Documentation

◆ getActionLinks()

LegacyLogFormatter::getActionLinks ( )

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

Stability: stable: to override

Returns: string

Reimplemented from LogFormatter.

Definition at line 106 of file LegacyLogFormatter.php.

References $params, and getComment().

Referenced by getComment().

◆ getActionMessage()

LegacyLogFormatter::getActionMessage ( )

protected

Returns: string

Reimplemented from LogFormatter.

Definition at line 85 of file LegacyLogFormatter.php.

References LogFormatter\$entry, LogEntry\getParameters(), LogFormatter\getPerformerElement(), LogEntry\getSubtype(), LogEntry\getTarget(), LogEntry\getType(), and LogFormatter\msg().

◆ getComment()

LegacyLogFormatter::getComment ( )

Gets the user provided comment.

Stability: stable: to override

Returns: string HTML

Reimplemented from LogFormatter.

Definition at line 69 of file LegacyLogFormatter.php.

References getActionLinks().

Referenced by getActionLinks().

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

includes/logging/LegacyLogFormatter.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActionLinks()

◆ getActionMessage()

◆ getComment()