MediaWiki  REL1_23
Public Member Functions | Protected Member Functions | Private Attributes
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:
Inheritance graph
[legend]
Collaboration diagram for LegacyLogFormatter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 getActionLinks ()
 Returns extra links that comes after the action text, like "revert", etc.
 getComment ()
 Gets the user provided comment.

Protected Member Functions

 getActionMessage ()
 Returns a sentence describing the log action.

Private Attributes

string null $comment = null
 Backward compatibility for extension changing the comment from the LogLine hook.
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.

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 676 of file LogFormatter.php.

Member Function Documentation

LegacyLogFormatter::getActionLinks ( )

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

Returns:
string

Reimplemented from LogFormatter.

Definition at line 728 of file LogFormatter.php.

References LogFormatter\msg().

Referenced by 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 709 of file LogFormatter.php.

References getActionLinks().

LegacyLogFormatter::getComment ( )

Gets the user provided comment.

Returns:
string HTML

Reimplemented from LogFormatter.

Definition at line 695 of file LogFormatter.php.

Member Data Documentation

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 685 of file LogFormatter.php.

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 693 of file LogFormatter.php.

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