RightsLogFormatter Class Reference
This class formats rights log entries. More...
Inheritance diagram for RightsLogFormatter:
Collaboration diagram for RightsLogFormatter:
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. | |
| makePageLink (Title $title=null, $parameters=array()) | |
| Helper to make a link to the page, taking the plaintext value in consideration. | |
Detailed Description
Member Function Documentation
| RightsLogFormatter::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 1145 of file LogFormatter.php.
| RightsLogFormatter::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 1154 of file LogFormatter.php.
| RightsLogFormatter::makePageLink | ( | Title $ | title = null, |
| $ | parameters = array() |
||
| ) | [protected] |
Helper to make a link to the page, taking the plaintext value in consideration.
- Parameters:
-
$title Title the page array $parameters query parameters
- Exceptions:
-
MWException
- Returns:
- String
Reimplemented from LogFormatter.
Definition at line 1125 of file LogFormatter.php.
The documentation for this class was generated from the following file:
- includes/logging/LogFormatter.php
