MediaWiki master
|
This class formats block log entries. More...
Inherits LogFormatter.
Public Member Functions | |
__construct (LogEntry $entry, TitleParser $titleParser, NamespaceInfo $namespaceInfo) | |
formatParametersForApi () | |
Format parameters for API output.The result array should generally map named keys to values. Index and type should be omitted, e.g. "4::foo" should be returned as "foo" in the output. Values should generally be unformatted.Renames or removals of keys besides from the legacy numeric format to modern named style should be avoided. Any renames should be announced to the mediawiki-api-announce mailing list.
| |
getActionLinks () | |
Returns extra links that comes after the action text, like "revert", etc. | |
getPreloadTitles () | |
![]() | |
__construct (LogEntry $entry) | |
canViewLogType () | |
Check if a log item type can be displayed. | |
getActionText () | |
Gets the log action, including username. | |
getComment () | |
Gets the user provided comment. | |
getCommentFormatter () | |
getContentLanguage () | |
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. | |
getUserEditTracker () | |
setAudience ( $audience) | |
Set the visibility restrictions for displaying content. | |
setCommentFormatter (CommentFormatter $commentFormatter) | |
setContentLanguage (Language $contentLanguage) | |
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. | |
setUserEditTracker (UserEditTracker $userEditTracker) | |
Static Public Member Functions | |
static | formatBlockFlag ( $flag, Language $lang) |
Translate a block log flag if possible. | |
static | formatBlockFlags ( $flags, Language $lang) |
Convert a comma-delimited list of block log flags into a more readable (and translated) form. | |
![]() | |
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. | |
Protected Member Functions | |
extractParameters () | |
Extracts the optional extra parameters for use in action messages. | |
getMessageKey () | |
Returns a key to be used for formatting the action sentence. | |
getMessageParameters () | |
Formats parameters intended for action message from array of all parameters. | |
getParametersForApi () | |
Get the array of parameters, converted from legacy format if necessary. | |
![]() | |
canView ( $field) | |
Check if a log item can be displayed. | |
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 (UserIdentity $user, $toolFlags=0) | |
msg ( $key,... $params) | |
Shortcut for wfMessage which honors local context. | |
styleRestrictedElement ( $content) | |
Helper method for styling restricted element. | |
Additional Inherited Members | |
![]() | |
IContextSource | $context |
Context for logging. | |
const | FOR_PUBLIC = 1 |
const | FOR_THIS_USER = 2 |
![]() | |
int | $audience = self::FOR_PUBLIC |
Constant for handling log_deleted. | |
LogEntryBase | $entry |
bool | $irctext = false |
bool | $linkFlood = false |
Whether to output user tool links. | |
array null | $parsedParameters |
bool | $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. | |
This class formats block log entries.
Definition at line 42 of file BlockLogFormatter.php.
BlockLogFormatter::__construct | ( | LogEntry | $entry, |
TitleParser | $titleParser, | ||
NamespaceInfo | $namespaceInfo ) |
Definition at line 46 of file BlockLogFormatter.php.
|
protected |
Extracts the optional extra parameters for use in action messages.
The array indexes start from number 3.
Reimplemented from LogFormatter.
Definition at line 166 of file BlockLogFormatter.php.
References $params.
Referenced by getPreloadTitles().
|
static |
Translate a block log flag if possible.
string | $flag | Flag to translate |
Language | $lang | Language object to use |
Definition at line 290 of file BlockLogFormatter.php.
References wfMessage().
|
static |
Convert a comma-delimited list of block log flags into a more readable (and translated) form.
string | $flags | Flags to format |
Language | $lang |
Definition at line 267 of file BlockLogFormatter.php.
References MediaWiki\Language\Language\commaList(), and wfMessage().
BlockLogFormatter::formatParametersForApi | ( | ) |
Format parameters for API output.The result array should generally map named keys to values. Index and type should be omitted, e.g. "4::foo" should be returned as "foo" in the output. Values should generally be unformatted.Renames or removals of keys besides from the legacy numeric format to modern named style should be avoided. Any renames should be announced to the mediawiki-api-announce mailing list.
Reimplemented from LogFormatter.
Definition at line 369 of file BlockLogFormatter.php.
References LogFormatter\formatParameterValueForApi().
BlockLogFormatter::getActionLinks | ( | ) |
Returns extra links that comes after the action text, like "revert", etc.
Reimplemented from LogFormatter.
Definition at line 199 of file BlockLogFormatter.php.
References $params, LogFormatter\getLinkRenderer(), and LogFormatter\msg().
|
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.
Reimplemented from LogFormatter.
Definition at line 390 of file BlockLogFormatter.php.
References $params.
|
protected |
Formats parameters intended for action message from array of all parameters.
There are three hardcoded parameters:
The parameters are returned as a non-associative array that can be passed to Message::params(), so $logFormatter->getMessageParameters()[0] is the $1 parameter in the message and so on.
Reimplemented from LogFormatter.
Definition at line 56 of file BlockLogFormatter.php.
References $params, LogFormatter\makePageLink(), LogFormatter\makeUserLink(), LogFormatter\msg(), NS_MAIN, and wfTimestamp().
|
protected |
Get the array of parameters, converted from legacy format if necessary.
Reimplemented from LogFormatter.
Definition at line 314 of file BlockLogFormatter.php.
References LogFormatter\$entry, $params, LogEntry\getParameters(), LogEntry\getSubtype(), LogEntry\getTimestamp(), wfIsInfinity(), and wfTimestamp().
BlockLogFormatter::getPreloadTitles | ( | ) |
Reimplemented from LogFormatter.
Definition at line 179 of file BlockLogFormatter.php.
References $params, and extractParameters().