MediaWiki  1.29.1
LegacyLogFormatter Class Reference

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

Inheritance diagram for LegacyLogFormatter:
Collaboration diagram for LegacyLogFormatter:

Public Member Functions

 getActionLinks ()
 Returns extra links that comes after the action text, like "revert", etc. More...
 
 getComment ()
 Gets the user provided comment. More...
 
- Public Member Functions inherited from LogFormatter
 formatParametersForApi ()
 Format parameters for API output. More...
 
 getActionText ()
 Gets the log action, including username. More...
 
 getIRCActionComment ()
 Even uglier hack to maintain backwards compatibilty with IRC bots (T36508). More...
 
 getIRCActionText ()
 Even uglier hack to maintain backwards compatibilty with IRC bots (T36508). More...
 
 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...
 
 getPreloadTitles ()
 
 setAudience ( $audience)
 Set the visibility restrictions for displaying content. More...
 
 setContext (IContextSource $context)
 Replace the default context. More...
 
 setShowUserToolLinks ( $value)
 If set to true, will produce user tool links after the user name. More...
 

Protected Member Functions

 getActionMessage ()
 Returns a sentence describing the log action. More...
 
- Protected Member Functions inherited from LogFormatter
 __construct (LogEntry $entry)
 
 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...
 
 getMessageKey ()
 Returns a key to be used for formatting the action sentence. More...
 
 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...
 
 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)
 Shortcut for wfMessage which honors local context. More...
 
 styleRestricedElement ( $content)
 Helper method for styling restricted element. More...
 

Private Attributes

string null $comment = null
 Backward compatibility for extension changing the comment from the LogLine hook. More...
 
string null $revert = null
 Cache for the result of getActionLinks() so that it does not need to run multiple times depending on the order that getComment() and getActionLinks() are called. 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...
 
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 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 874 of file LogFormatter.php.

Member Function Documentation

◆ getActionLinks()

LegacyLogFormatter::getActionLinks ( )

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

Returns
string

Reimplemented from LogFormatter.

Definition at line 930 of file LogFormatter.php.

References $params, $revert, $title, $type, LogPage\DELETED_ACTION, getComment(), and Hooks\run().

Referenced by getComment().

◆ getActionMessage()

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

Definition at line 909 of file LogFormatter.php.

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

◆ getComment()

LegacyLogFormatter::getComment ( )

Gets the user provided comment.

Returns
string HTML

Reimplemented from LogFormatter.

Definition at line 895 of file LogFormatter.php.

References $comment, and getActionLinks().

Referenced by getActionLinks().

Member Data Documentation

◆ $comment

string null LegacyLogFormatter::$comment = null
private

Backward compatibility for extension changing the comment from the LogLine hook.

This will be set by the first call on getComment(), then it might be modified by the hook when calling getActionLinks(), so that the modified value will be returned when calling getComment() a second time.

Definition at line 884 of file LogFormatter.php.

Referenced by getComment().

◆ $revert

string null LegacyLogFormatter::$revert = null
private

Cache for the result of getActionLinks() so that it does not need to run multiple times depending on the order that getComment() and getActionLinks() are called.

Definition at line 893 of file LogFormatter.php.

Referenced by getActionLinks().


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