MediaWiki  master
RightsLogFormatter Class Reference

This class formats rights log entries. More...

Inheritance diagram for RightsLogFormatter:
Collaboration diagram for RightsLogFormatter:

Public Member Functions

 formatParametersForApi ()
 Format parameters for API output. More...
 
- Public Member Functions inherited from LogFormatter
 canViewLogType ()
 Check if a log item type can be displayed. More...
 
 getActionLinks ()
 Returns extra links that comes after the action text, like "revert", etc. More...
 
 getActionText ()
 Gets the log action, including username. More...
 
 getComment ()
 Gets the user provided comment Stable to override. 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...
 
 getPreloadTitles ()
 Stable to override. 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

 formatRightsList ( $groups, $serializedUGMs=[])
 
 getMessageKey ()
 Returns a key to be used for formatting the action sentence. More...
 
 getMessageParameters ()
 Formats parameters intented for action message from array of all parameters. More...
 
 getParametersForApi ()
 Get the array of parameters, converted from legacy format if necessary. More...
 
 makePageLink (Title $title=null, $parameters=[], $html=null)
 Helper to make a link to the page, taking the plaintext value in consideration. More...
 
- Protected Member Functions inherited from LogFormatter
 __construct (LogEntry $entry)
 Stable to call. More...
 
 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...
 
 makeUserLink (User $user, $toolFlags=0)
 
 msg ( $key,... $params)
 Shortcut for wfMessage which honors local context. More...
 
 styleRestricedElement ( $content)
 Helper method for styling restricted element. More...
 

Private Member Functions

 makeGroupArray ( $group)
 

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

Detailed Description

This class formats rights log entries.

Since
1.21

Definition at line 33 of file RightsLogFormatter.php.

Member Function Documentation

◆ formatParametersForApi()

RightsLogFormatter::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 Stable to override
Returns
array

Reimplemented from LogFormatter.

Definition at line 213 of file RightsLogFormatter.php.

References ApiResult\setArrayType(), and ApiResult\setIndexedTagName().

◆ formatRightsList()

RightsLogFormatter::formatRightsList (   $groups,
  $serializedUGMs = [] 
)
protected

Definition at line 119 of file RightsLogFormatter.php.

References LogFormatter\msg().

Referenced by getMessageParameters().

◆ getMessageKey()

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. Stable to override

Returns
string Message key

Reimplemented from LogFormatter.

Definition at line 62 of file RightsLogFormatter.php.

References getMessageParameters().

◆ getMessageParameters()

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 Stable to override
    Returns
    array

Reimplemented from LogFormatter.

Definition at line 73 of file RightsLogFormatter.php.

References formatRightsList(), UserGroupMembership\getGroupMemberName(), makeGroupArray(), LogFormatter\msg(), and Message\rawParam().

Referenced by getMessageKey().

◆ getParametersForApi()

RightsLogFormatter::getParametersForApi ( )
protected

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

Since
1.25 Stable to override
Returns
array

Reimplemented from LogFormatter.

Definition at line 155 of file RightsLogFormatter.php.

References LogFormatter\$entry, ApiResult\formatExpiry(), LogEntry\getParameters(), and makeGroupArray().

◆ makeGroupArray()

RightsLogFormatter::makeGroupArray (   $group)
private

Definition at line 232 of file RightsLogFormatter.php.

Referenced by getMessageParameters(), and getParametersForApi().

◆ makePageLink()

RightsLogFormatter::makePageLink ( Title  $title = null,
  $parameters = [],
  $html = null 
)
protected

Helper to make a link to the page, taking the plaintext value in consideration.

Stable to override

Parameters
Title | null$titleThe page
array$parametersQuery parameters
string | null$htmlLinktext of the link as raw html
Returns
string

Reimplemented from LogFormatter.

Definition at line 34 of file RightsLogFormatter.php.

References $title, $wgUserrightsInterwikiDelimiter, and WikiMap\foreignUserLink().


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