Implements the default log formatting. More...

Inheritance diagram for LogFormatter:

Collaboration diagram for LogFormatter:

Public Member Functions
	getActionLinks ()
	Returns extra links that comes after the action text, like "revert", etc.
	getActionText ()
	Gets the log action, including username.
	getComment ()
	Gets the luser provided comment.
	getIRCActionComment ()
	Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508).
	getIRCActionText ()
	Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508).
	getMessageParametersForTesting ()
	getPerformerElement ()
	Provides the name of the user who performed the log action.
	getPlainActionText ()
	Ugly hack to produce plaintext version of the message.
	getPreloadTitles ()
	setAudience ($audience)
	Set the visibility restrictions for displaying content.
	setContext (IContextSource $context)
	Replace the default context.
	setShowUserToolLinks ($value)
	If set to true, will produce user tool links after the user name.
Static Public Member Functions
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.
Public Attributes
const	FOR_PUBLIC = 1
const	FOR_THIS_USER = 2
Protected Member Functions
	__construct (LogEntry $entry)
	canView ($field)
	Check if a log item can be displayed.
	extractParameters ()
	Extracts the optional extra parameters for use in action messages.
	formatParameterValue ($type, $value)
	Formats parameters values dependent to their type.
	getActionMessage ()
	Returns a sentence describing the log action.
	getMessageKey ()
	Returns a key to be used for formatting the action sentence.
	getMessageParameters ()
	Formats parameters intented for action message from array of all parameters.
	getRestrictedElement ($message)
	Helper method for displaying restricted element.
	makePageLink (Title $title=null, $parameters=array())
	Helper to make a link to the page, taking the plaintext value in consideration.
	makeUserLink (User $user)
	msg ($key)
	Shortcut for wfMessage which honors local context.
	styleRestricedElement ($content)
	Helper method for styling restricted element.
Protected Attributes
	$audience = self::FOR_PUBLIC
	Integer constant for handling log_deleted.
	$entry
	$irctext = false
	$linkFlood = false
	Whether to output user tool links.
boolean	$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

Implements the default log formatting.

Can be overridden by subclassing and setting $wgLogActionsHandlers['type/subtype'] = 'class'; or $wgLogActionsHandlers['type/*'] = 'class';

Since:: 1.19

Definition at line 33 of file LogFormatter.php.

Constructor & Destructor Documentation

LogFormatter::__construct ( LogEntry $ entry ) [protected]

Definition at line 96 of file LogFormatter.php.

References $entry, and RequestContext\getMain().

Member Function Documentation

LogFormatter::canView ( $ field ) [protected]

Check if a log item can be displayed.

Parameters:

$field integer LogPage::DELETED_* constant

Returns:: bool

Definition at line 126 of file LogFormatter.php.

LogFormatter::extractParameters ( ) [protected]

Extracts the optional extra parameters for use in action messages.

The array indexes start from number 3.

Returns:: array

Definition at line 392 of file LogFormatter.php.

Referenced by MoveLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), and MoveLogFormatter\getPreloadTitles().

LogFormatter::formatParameterValue	(	$	type,
		$	value
	)		`[protected]`

Formats parameters values dependent to their type.

Parameters:

string	$type	The type of the value. Valid are currently: (empty) or plain: The value is returned as-is * raw: The value will be added to the log message as raw parameter (e.g. no escaping) Use this only if there is no other working type like user-link or title-link * msg: The value is a message-key, the output is the message in user language * msg-content: The value is a message-key, the output is the message in content language * user: The value is a user name, e.g. for GENDER * user-link: The value is a user name, returns a link for the user * title: The value is a page title, returns name of page * title-link: The value is a page title, returns link to this page * number: Format value as number
string	$value	The parameter value that should be formated

Returns:: string or Message::numParam or Message::rawParam Formated value

Since:: 1.21

Definition at line 478 of file LogFormatter.php.

LogFormatter::getActionLinks ( )

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

Returns:: string

Reimplemented in LegacyLogFormatter, DeleteLogFormatter, and MoveLogFormatter.

Definition at line 383 of file LogFormatter.php.

LogFormatter::getActionMessage ( ) [protected]

Returns a sentence describing the log action.

Usually a Message object is returned, but old style log types and entries might return pre-escaped html string.

Returns:: Message|string pre-escaped html

Reimplemented in LegacyLogFormatter.

Definition at line 358 of file LogFormatter.php.

LogFormatter::getActionText ( )

Gets the log action, including username.

Returns:: string HTML

Definition at line 335 of file LogFormatter.php.

LogFormatter::getComment ( )

Gets the luser provided comment.

Returns:: string HTML

Reimplemented in LegacyLogFormatter, and NewUsersLogFormatter.

Definition at line 567 of file LogFormatter.php.

LogFormatter::getIRCActionComment ( )

Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508).

See also:: getActionText()

Returns:: string text

Definition at line 165 of file LogFormatter.php.

LogFormatter::getIRCActionText ( )

Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508).

See also:: getActionText()

Returns:: string text

Definition at line 186 of file LogFormatter.php.

LogFormatter::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 in RightsLogFormatter, MoveLogFormatter, DeleteLogFormatter, and PatrolLogFormatter.

Definition at line 371 of file LogFormatter.php.

LogFormatter::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 in RightsLogFormatter, MoveLogFormatter, DeleteLogFormatter, PatrolLogFormatter, and NewUsersLogFormatter.

Definition at line 435 of file LogFormatter.php.

LogFormatter::getMessageParametersForTesting ( )

Returns:: Output of getMessageParameters() for testing

Definition at line 650 of file LogFormatter.php.

LogFormatter::getPerformerElement ( )

Provides the name of the user who performed the log action.

Used as part of log action message or standalone, depending which parts of the log entry has been hidden.

Returns:: String

Definition at line 549 of file LogFormatter.php.

LogFormatter::getPlainActionText ( )

Ugly hack to produce plaintext version of the message.

Usually you also want to set extraneous request context to avoid formatting for any particular user.

See also:: getActionText()

Returns:: string text

Definition at line 152 of file LogFormatter.php.

LogFormatter::getPreloadTitles ( )

Returns:: Array of titles that should be preloaded with LinkBatch.

Reimplemented in NewUsersLogFormatter, and MoveLogFormatter.

Definition at line 643 of file LogFormatter.php.

LogFormatter::getRestrictedElement ( $ message ) [protected]

Helper method for displaying restricted element.

Parameters:

$message string

Returns:: string HTML or wikitext

Definition at line 587 of file LogFormatter.php.

LogFormatter::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 in RightsLogFormatter.

Definition at line 531 of file LogFormatter.php.

Referenced by MoveLogFormatter\getMessageParameters().

LogFormatter::makeUserLink ( User $ user ) [protected]

Definition at line 620 of file LogFormatter.php.

References User\getEditCount(), User\getId(), User\getName(), Linker\userLink(), and Linker\userToolLinksRedContribs().

Referenced by NewUsersLogFormatter\getMessageParameters().

LogFormatter::msg ( $ key ) [protected]

Shortcut for wfMessage which honors local context.

Todo:: Would it be better to require replacing the global context instead?

Parameters:

$key string

Returns:: Message

Definition at line 616 of file LogFormatter.php.

Referenced by MoveLogFormatter\getActionLinks(), DeleteLogFormatter\getActionLinks(), DeleteLogFormatter\getMessageParameters(), and RightsLogFormatter\getMessageParameters().

static LogFormatter::newFromEntry ( LogEntry $ entry ) [static]

Constructs a new formatter suitable for given entry.

Parameters:

$entry LogEntry

Returns:: LogFormatter

Definition at line 45 of file LogFormatter.php.

References LogEntry\getFullType(), LogEntry\getType(), and global.

Referenced by RecentChangeTest\assertIRCComment(), Title\moveToInternal(), newFromRow(), and ManualLogEntry\publish().

static LogFormatter::newFromRow ( $ row ) [static]

Handy shortcut for constructing a formatter directly from database row.

Parameters:

$row

See also:: DatabaseLogEntry::getSelectQueryData

Returns:: LogFormatter

Definition at line 71 of file LogFormatter.php.

References newFromEntry(), and DatabaseLogEntry\newFromRow().

Referenced by FeedUtils\formatDiff(), RevDel_LogItem\getHTML(), and LogPager\getStartBody().

LogFormatter::setAudience ( $ audience )

Set the visibility restrictions for displaying content.

If set to public, and an item is deleted, then it will be replaced with a placeholder even if the context user is allowed to view it.

Parameters:

$audience integer self::FOR_THIS_USER or self::FOR_PUBLIC

Definition at line 115 of file LogFormatter.php.

LogFormatter::setContext ( IContextSource $ context )

Replace the default context.

Parameters:

$context IContextSource

Definition at line 105 of file LogFormatter.php.

LogFormatter::setShowUserToolLinks ( $ value )

If set to true, will produce user tool links after the user name.

This should be replaced with generic CSS/JS solution.

Parameters:

$value boolean

Definition at line 141 of file LogFormatter.php.

LogFormatter::styleRestricedElement ( $ content ) [protected]

Helper method for styling restricted element.

Parameters:

$content string

Returns:: string HTML or wikitext

Definition at line 602 of file LogFormatter.php.

Member Data Documentation

LogFormatter::$audience = self::FOR_PUBLIC [protected]

Integer constant for handling log_deleted.

Definition at line 81 of file LogFormatter.php.

LogFormatter::$entry [protected]

Definition at line 78 of file LogFormatter.php.

Referenced by __construct().

LogFormatter::$irctext = false [protected]

Definition at line 94 of file LogFormatter.php.

LogFormatter::$linkFlood = false [protected]

Whether to output user tool links.

Definition at line 84 of file LogFormatter.php.

boolean LogFormatter::$plaintext = false [protected]

Set to true if we are constructing a message text that is going to be included in page history or send to IRC feed.

Links are replaced with plaintext or with [[pagename]] kind of syntax, that is parsed by page histories and IRC feeds.

Definition at line 92 of file LogFormatter.php.

const LogFormatter::FOR_PUBLIC = 1

Definition at line 35 of file LogFormatter.php.

const LogFormatter::FOR_THIS_USER = 2

Definition at line 36 of file LogFormatter.php.

Referenced by RevDel_LogItem\getHTML().

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

includes/logging/LogFormatter.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation