MediaWiki  master
ProtectLogFormatter Class Reference

This class formats protect log entries. More...

Inheritance diagram for ProtectLogFormatter:
Collaboration diagram for ProtectLogFormatter:

Public Member Functions

 createProtectDescription (array $details)
 Create the protect description to show in the log formatter. More...
 
 formatParametersForApi ()
 Format parameters for API output. More...
 
 getActionLinks ()
 Returns extra links that comes after the action text, like "revert", etc. More...
 
 getPreloadTitles ()
 
- Public Member Functions inherited from LogFormatter
 canViewLogType ()
 Check if a log item type can be displayed. More...
 
 getActionText ()
 Gets the log action, including username. More...
 
 getComment ()
 Gets the user provided comment. More...
 
 getIRCActionComment ()
 Even uglier hack to maintain backwards compatibility with IRC bots (T36508). More...
 
 getIRCActionText ()
 Even uglier hack to maintain backwards compatibility with IRC bots (T36508). More...
 
 getLinkRenderer ()
 
 getMessageParametersForTesting ()
 
 getPerformerElement ()
 Provides the name of the user who performed the log action. More...
 
 getPlainActionText ()
 Ugly hack to produce plaintext version of the message. More...
 
 setAudience ( $audience)
 Set the visibility restrictions for displaying content. More...
 
 setContext (IContextSource $context)
 Replace the default context. More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setShowUserToolLinks ( $value)
 If set to true, will produce user tool links after the user name. More...
 

Protected Member Functions

 getMessageKey ()
 Returns a key to be used for formatting the action sentence. More...
 
 getMessageParameters ()
 Formats parameters intended for action message from array of all parameters. More...
 
 getParametersForApi ()
 Get the array of parameters, converted from legacy format if necessary. More...
 
- Protected Member Functions inherited from LogFormatter
 __construct (LogEntry $entry)
 
 canView ( $field)
 Check if a log item can be displayed. More...
 
 extractParameters ()
 Extracts the optional extra parameters for use in action messages. More...
 
 formatParameterValue ( $type, $value)
 Formats parameters values dependent to their type. More...
 
 formatParameterValueForApi ( $name, $type, $value)
 Format a single parameter value for API output. More...
 
 getActionMessage ()
 Returns a sentence describing the log action. More...
 
 getRestrictedElement ( $message)
 Helper method for displaying restricted element. More...
 
 makePageLink (Title $title=null, $parameters=[], $html=null)
 Helper to make a link to the page, taking the plaintext value in consideration. More...
 
 makeUserLink (UserIdentity $user, $toolFlags=0)
 
 msg ( $key,... $params)
 Shortcut for wfMessage which honors local context. More...
 
 styleRestrictedElement ( $content)
 Helper method for styling restricted element. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from LogFormatter
static newFromEntry (LogEntry $entry)
 Constructs a new formatter suitable for given entry. More...
 
static newFromRow ( $row)
 Handy shortcut for constructing a formatter directly from database row. More...
 
- Public Attributes inherited from LogFormatter
IContextSource $context
 Context for logging. More...
 
const FOR_PUBLIC = 1
 
const FOR_THIS_USER = 2
 
- Protected Attributes inherited from LogFormatter
int $audience = self::FOR_PUBLIC
 Constant for handling log_deleted. More...
 
LogEntryBase $entry
 
bool $irctext = false
 
bool $linkFlood = false
 Whether to output user tool links. More...
 
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. More...
 

Detailed Description

This class formats protect log entries.

Since
1.26

Definition at line 32 of file ProtectLogFormatter.php.

Member Function Documentation

◆ createProtectDescription()

ProtectLogFormatter::createProtectDescription ( array  $details)

Create the protect description to show in the log formatter.

Parameters
array[]$details
Returns
string

Definition at line 177 of file ProtectLogFormatter.php.

Referenced by getMessageParameters().

◆ formatParametersForApi()

ProtectLogFormatter::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 156 of file ProtectLogFormatter.php.

◆ getActionLinks()

ProtectLogFormatter::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 81 of file ProtectLogFormatter.php.

References $title, LogPage\DELETED_ACTION, LogFormatter\getLinkRenderer(), and LogFormatter\msg().

◆ getMessageKey()

ProtectLogFormatter::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 42 of file ProtectLogFormatter.php.

References LogFormatter\extractParameters().

◆ getMessageParameters()

ProtectLogFormatter::getMessageParameters ( )
protected

Formats parameters intended 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
    Stability: stable
    to override
    Returns
    array

Reimplemented from LogFormatter.

Definition at line 53 of file ProtectLogFormatter.php.

References createProtectDescription(), LogFormatter\makePageLink(), Title\newFromText(), and Message\rawParam().

◆ getParametersForApi()

ProtectLogFormatter::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 123 of file ProtectLogFormatter.php.

References LogFormatter\$entry, LogEntry\getParameters(), and LogEntry\getSubtype().

◆ getPreloadTitles()

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

Reimplemented from LogFormatter.

Definition at line 33 of file ProtectLogFormatter.php.

References LogFormatter\extractParameters(), and Title\newFromText().


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