RightsLogFormatter Class Reference

This class formats rights log entries. More...

Inheritance diagram for RightsLogFormatter:

Collaboration diagram for RightsLogFormatter:

List of all members.

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

This class formats rights log entries.

Since:

1.21

Definition at line 31 of file RightsLogFormatter.php.

---

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 52 of file RightsLogFormatter.php.

References $key, $params, and 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

  Returns:

  array

Reimplemented from LogFormatter.

Definition at line 62 of file RightsLogFormatter.php.

References $params, array(), as, User\getGroupMember(), and LogFormatter\msg().

Referenced by getMessageKey().

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 32 of file RightsLogFormatter.php.

References $title, $wgContLang, WikiMap\foreignUserLink(), and global.

---

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

• includes/logging/RightsLogFormatter.php