This class formats move log entries. More...
Public Member Functions | |
| getActionLinks () | |
| Returns extra links that comes after the action text, like "revert", etc. | |
| getPreloadTitles () | |
 Public Member Functions inherited from LogFormatter | |
| formatParametersForApi () | |
| Format parameters for API output. | |
| 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. | |
| 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. | |
Protected Member Functions | |
| getMessageKey () | |
| Returns a key to be used for formatting the action sentence. | |
| getMessageParameters () | |
| Formats parameters intented 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 (User $user, $toolFlags=0) | |
| msg ( $key) | |
| Shortcut for wfMessage which honors local context. | |
| styleRestricedElement ( $content) | |
| Helper method for styling restricted element. | |
Additional Inherited Members | |
| 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 |
| string | $irctext = false |
| bool | $linkFlood = false |
| Whether to output user tool links. | |
| 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. | |
Detailed Description
Member Function Documentation
◆ getActionLinks()
| MoveLogFormatter::getActionLinks | ( | ) |
Returns extra links that comes after the action text, like "revert", etc.
- Returns
- string
Reimplemented from LogFormatter.
Definition at line 60 of file MoveLogFormatter.php.
References $params, $revert, LogPage\DELETED_ACTION, LogFormatter\extractParameters(), LogFormatter\getLinkRenderer(), LogFormatter\msg(), and text.
◆ 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.
- Returns
- string Message key
Reimplemented from LogFormatter.
Definition at line 38 of file MoveLogFormatter.php.
References $params, and LogFormatter\extractParameters().
◆ 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
- Returns
- array
Reimplemented from LogFormatter.
Definition at line 49 of file MoveLogFormatter.php.
References $params, and LogFormatter\makePageLink().
◆ getParametersForApi()
|
protected |
Get the array of parameters, converted from legacy format if necessary.
- Since
- 1.25
- Returns
- array
Reimplemented from LogFormatter.
Definition at line 89 of file MoveLogFormatter.php.
References LogFormatter\$entry, $params, and LogEntry\getParameters().
◆ getPreloadTitles()
| MoveLogFormatter::getPreloadTitles | ( | ) |
- Returns
- array Array of titles that should be preloaded with LinkBatch
Reimplemented from LogFormatter.
Definition at line 32 of file MoveLogFormatter.php.
References $params, and LogFormatter\extractParameters().
The documentation for this class was generated from the following file:
- includes/logging/MoveLogFormatter.php
