MediaWiki master
BlockLogFormatter Class Reference

This class formats block log entries. More...

Inherits LogFormatter.

Collaboration diagram for BlockLogFormatter:

Public Member Functions

 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.
Since
1.25
Stability: stable
to override
Returns
array

 
 getActionLinks ()
 Returns extra links that comes after the action text, like "revert", etc.
 
 getPreloadTitles ()
 
- Public Member Functions inherited from LogFormatter
 __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 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.
 

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.
 
- Protected Member Functions inherited from LogFormatter
 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

- 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
 
bool $irctext = false
 
bool $linkFlood = false
 Whether to output user tool links.
 
array $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.
 

Detailed Description

This class formats block log entries.

Since
1.25

Definition at line 37 of file BlockLogFormatter.php.

Member Function Documentation

◆ extractParameters()

BlockLogFormatter::extractParameters ( )
protected

Extracts the optional extra parameters for use in action messages.

The array indexes start from number 3.

Stability: stable
to override
Returns
array

Reimplemented from LogFormatter.

Definition at line 148 of file BlockLogFormatter.php.

References $params.

Referenced by getPreloadTitles().

◆ formatBlockFlag()

static BlockLogFormatter::formatBlockFlag ( $flag,
Language $lang )
static

Translate a block log flag if possible.

Parameters
string$flagFlag to translate
Language$langLanguage object to use
Returns
string

Definition at line 236 of file BlockLogFormatter.php.

References wfMessage().

◆ formatBlockFlags()

static BlockLogFormatter::formatBlockFlags ( $flags,
Language $lang )
static

Convert a comma-delimited list of block log flags into a more readable (and translated) form.

Parameters
string$flagsFlags to format
Language$lang
Returns
string

Definition at line 213 of file BlockLogFormatter.php.

References wfMessage().

◆ formatParametersForApi()

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.

Since
1.25
Stability: stable
to override
Returns
array

Reimplemented from LogFormatter.

Definition at line 315 of file BlockLogFormatter.php.

References LogFormatter\formatParameterValueForApi().

◆ getActionLinks()

BlockLogFormatter::getActionLinks ( )

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

Stability: stable
to override
Returns
string

Reimplemented from LogFormatter.

Definition at line 178 of file BlockLogFormatter.php.

References LogFormatter\getLinkRenderer(), and LogFormatter\msg().

◆ getMessageKey()

BlockLogFormatter::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.

Stability: stable
to override
Returns
string Message key

Reimplemented from LogFormatter.

Definition at line 336 of file BlockLogFormatter.php.

References $params.

◆ getMessageParameters()

BlockLogFormatter::getMessageParameters ( )
protected

Formats parameters intended for action message from array of all parameters.

There are three hardcoded parameters:

  • $1: user name with premade link
  • $2: usable for gender magic function
  • $3: target page with premade link More parameters might be present, depending on what code created the log entry.

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.

Stability: stable
to override
Returns
array
See also
ManualLogEntry::setParameters() for how parameters are determined.

Reimplemented from LogFormatter.

Definition at line 38 of file BlockLogFormatter.php.

References $params, LogFormatter\makePageLink(), LogFormatter\makeUserLink(), LogFormatter\msg(), NS_MAIN, and wfTimestamp().

◆ getParametersForApi()

BlockLogFormatter::getParametersForApi ( )
protected

Get the array of parameters, converted from legacy format if necessary.

Since
1.25
Stability: stable
to override
Returns
array

Reimplemented from LogFormatter.

Definition at line 260 of file BlockLogFormatter.php.

References LogFormatter\$entry, $params, LogEntry\getParameters(), LogEntry\getSubtype(), LogEntry\getTimestamp(), wfIsInfinity(), and wfTimestamp().

◆ getPreloadTitles()

BlockLogFormatter::getPreloadTitles ( )
Stability: stable
to override
Returns
LinkTarget[] Array of titles that should be preloaded with LinkBatch

Reimplemented from LogFormatter.

Definition at line 161 of file BlockLogFormatter.php.

References $params, and extractParameters().


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