Inherits MediaWiki\Logging\LogFormatter.

Collaboration diagram for MediaWiki\Logging\UnsafeLogFormatter:

[legend]

Public Member Functions
	__construct (LogEntry $entry)

	getIRCActionText ()
	Even uglier hack to maintain backwards compatibility with IRC bots (T36508). See also getActionText() Returns string Text

Public Member Functions inherited from MediaWiki\Logging\LogFormatter
	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).

	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
	extractParameters ()
	Extracts the optional extra parameters for use in action messages.The array indexes start from number 3. Stability: stable to override Returns array

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

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

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

	getParametersForApi ()
	Get the array of parameters, converted from legacy format if necessary. Since 1.25 Stability: stable to override Returns array

Protected Member Functions inherited from MediaWiki\Logging\LogFormatter
	canView ( $field)
	Check if a log item can be displayed.

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

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

	getCommentWikiId ()
	Returns the wiki ID to use for resolving links in the log comment.

	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 MediaWiki\Logging\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 MediaWiki\Logging\LogFormatter
IContextSource	$context
	Context for logging.

const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

Protected Attributes inherited from MediaWiki\Logging\LogFormatter
int	$audience = self::FOR_PUBLIC
	Constant for handling log_deleted.

LogEntry	$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

Definition at line 7 of file UnsafeLogFormatter.php.

Constructor & Destructor Documentation

◆ __construct()

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

Stability: stable: to call

Parameters

LogEntry $entry

Reimplemented from MediaWiki\Logging\LogFormatter.

Definition at line 9 of file UnsafeLogFormatter.php.

References MediaWiki\Logging\LogFormatter\$entry, and MediaWiki\Logging\LogEntry\getParameters().

Member Function Documentation

◆ extractParameters()

MediaWiki\Logging\UnsafeLogFormatter::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 from MediaWiki\Logging\LogFormatter.

Definition at line 65 of file UnsafeLogFormatter.php.

◆ getActionMessage()

MediaWiki\Logging\UnsafeLogFormatter::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 from MediaWiki\Logging\LogFormatter.

Definition at line 31 of file UnsafeLogFormatter.php.

References MediaWiki\Logging\LogFormatter\getPerformerElement(), and MediaWiki\Logging\LogFormatter\msg().

◆ getIRCActionText()

MediaWiki\Logging\UnsafeLogFormatter::getIRCActionText ( )

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

See also: getActionText()

Returns: string Text

Reimplemented from MediaWiki\Logging\LogFormatter.

Definition at line 60 of file UnsafeLogFormatter.php.

◆ getMessageKey()

MediaWiki\Logging\UnsafeLogFormatter::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 from MediaWiki\Logging\LogFormatter.

Definition at line 45 of file UnsafeLogFormatter.php.

◆ getMessageParameters()

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

Reimplemented from MediaWiki\Logging\LogFormatter.

Definition at line 50 of file UnsafeLogFormatter.php.

◆ getParametersForApi()

MediaWiki\Logging\UnsafeLogFormatter::getParametersForApi ( )

protected

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

Since: 1.25

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Logging\LogFormatter.

Definition at line 55 of file UnsafeLogFormatter.php.

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

includes/Logging/UnsafeLogFormatter.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ extractParameters()

◆ getActionMessage()

◆ getIRCActionText()

◆ getMessageKey()

◆ getMessageParameters()

◆ getParametersForApi()