MediaWiki  master
MergeLogFormatter Class Reference

This class formats merge log entries. More...

Inheritance diagram for MergeLogFormatter:
Collaboration diagram for MergeLogFormatter:

Public Member Functions

 getActionLinks ()
 Returns extra links that comes after the action text, like "revert", etc. More...
 
 getPreloadTitles ()
 Stable to override. More...
 
- Public Member Functions inherited from LogFormatter
 canViewLogType ()
 Check if a log item type can be displayed. More...
 
 formatParametersForApi ()
 Format parameters for API output. More...
 
 getActionText ()
 Gets the log action, including username. More...
 
 getComment ()
 Gets the user provided comment Stable to override. More...
 
 getIRCActionComment ()
 Even uglier hack to maintain backwards compatibility with IRC bots (T36508). More...
 
 getIRCActionText ()
 Even uglier hack to maintain backwards compatibility with IRC bots (T36508). More...
 
 getLinkRenderer ()
 
 getMessageParametersForTesting ()
 
 getPerformerElement ()
 Provides the name of the user who performed the log action. More...
 
 getPlainActionText ()
 Ugly hack to produce plaintext version of the message. More...
 
 setAudience ( $audience)
 Set the visibility restrictions for displaying content. More...
 
 setContext (IContextSource $context)
 Replace the default context. More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setShowUserToolLinks ( $value)
 If set to true, will produce user tool links after the user name. More...
 

Protected Member Functions

 getMessageParameters ()
 Formats parameters intented for action message from array of all parameters. More...
 
 getParametersForApi ()
 Get the array of parameters, converted from legacy format if necessary. More...
 
- Protected Member Functions inherited from LogFormatter
 __construct (LogEntry $entry)
 Stable to call. More...
 
 canView ( $field)
 Check if a log item can be displayed. More...
 
 extractParameters ()
 Extracts the optional extra parameters for use in action messages. More...
 
 formatParameterValue ( $type, $value)
 Formats parameters values dependent to their type. More...
 
 formatParameterValueForApi ( $name, $type, $value)
 Format a single parameter value for API output. More...
 
 getActionMessage ()
 Returns a sentence describing the log action. More...
 
 getMessageKey ()
 Returns a key to be used for formatting the action sentence. More...
 
 getRestrictedElement ( $message)
 Helper method for displaying restricted element. More...
 
 makePageLink (Title $title=null, $parameters=[], $html=null)
 Helper to make a link to the page, taking the plaintext value in consideration. More...
 
 makeUserLink (User $user, $toolFlags=0)
 
 msg ( $key,... $params)
 Shortcut for wfMessage which honors local context. More...
 
 styleRestricedElement ( $content)
 Helper method for styling restricted element. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from LogFormatter
static newFromEntry (LogEntry $entry)
 Constructs a new formatter suitable for given entry. More...
 
static newFromRow ( $row)
 Handy shortcut for constructing a formatter directly from database row. More...
 
- Public Attributes inherited from LogFormatter
IContextSource $context
 Context for logging. More...
 
const FOR_PUBLIC = 1
 
const FOR_THIS_USER = 2
 
- Protected Attributes inherited from LogFormatter
int $audience = self::FOR_PUBLIC
 Constant for handling log_deleted. More...
 
LogEntryBase $entry
 
string $irctext = false
 
bool $linkFlood = false
 Whether to output user tool links. More...
 
array $parsedParameters
 
string $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. More...
 

Detailed Description

This class formats merge log entries.

Since
1.25

Definition at line 32 of file MergeLogFormatter.php.

Member Function Documentation

◆ getActionLinks()

MergeLogFormatter::getActionLinks ( )

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

Stable to override

Returns
string

Reimplemented from LogFormatter.

Definition at line 50 of file MergeLogFormatter.php.

References LogPage\DELETED_ACTION, LogFormatter\extractParameters(), LogFormatter\getLinkRenderer(), SpecialPage\getTitleFor(), and LogFormatter\msg().

◆ getMessageParameters()

MergeLogFormatter::getMessageParameters ( )
protected

Formats parameters intented 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 Stable to override
    Returns
    array

Reimplemented from LogFormatter.

Definition at line 39 of file MergeLogFormatter.php.

References LogFormatter\makePageLink(), Title\newFromText(), and Message\rawParam().

◆ getParametersForApi()

MergeLogFormatter::getParametersForApi ( )
protected

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

Since
1.25 Stable to override
Returns
array

Reimplemented from LogFormatter.

Definition at line 76 of file MergeLogFormatter.php.

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

◆ getPreloadTitles()

MergeLogFormatter::getPreloadTitles ( )

Stable to override.

Returns
array Array of titles that should be preloaded with LinkBatch

Reimplemented from LogFormatter.

Definition at line 33 of file MergeLogFormatter.php.

References LogFormatter\extractParameters(), and Title\newFromText().


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