PatrolLogFormatter Class Reference

This class formats patrol log entries. More...

Inheritance diagram for PatrolLogFormatter:

Collaboration diagram for PatrolLogFormatter:

Protected Member Functions
	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.
Protected Member Functions inherited from LogFormatter
	__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.
	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
Public Member Functions inherited from 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.
	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 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 patrol log entries.

Since

1.19

Definition at line 31 of file PatrolLogFormatter.php.

Member Function Documentation

getMessageKey()

PatrolLogFormatter::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 LogFormatter.

Definition at line 32 of file PatrolLogFormatter.php.

References getMessageParameters().

getMessageParameters()

PatrolLogFormatter::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 from LogFormatter.

Definition at line 43 of file PatrolLogFormatter.php.

References LogFormatter\getLinkRenderer(), and Message\rawParam().

Referenced by getMessageKey().

getParametersForApi()

PatrolLogFormatter::getParametersForApi ( )

protected

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

Since

1.25

Stability: stable

to override

Returns

array

Reimplemented from LogFormatter.

Definition at line 67 of file PatrolLogFormatter.php.

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

---

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

• includes/logging/PatrolLogFormatter.php