MediaWiki master
NewUsersLogFormatter Class Reference

This class formats new user log entries. More...

Inherits LogFormatter.

Collaboration diagram for NewUsersLogFormatter:

Public Member Functions

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

Protected Member Functions

 getMessageParameters ()
 Formats parameters intended for action message from array of all parameters.
 
- Protected Member Functions inherited from LogFormatter
 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.
 
 formatParameterValueForApi ( $name, $type, $value)
 Format a single parameter value for API output.
 
 getActionMessage ()
 Returns a sentence describing the log action.
 
 getMessageKey ()
 Returns a key to be used for formatting the action sentence.
 
 getParametersForApi ()
 Get the array of parameters, converted from legacy format if necessary.
 
 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

- 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.
 
- 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 new user log entries.

Since
1.19

Definition at line 34 of file NewUsersLogFormatter.php.

Member Function Documentation

◆ getComment()

NewUsersLogFormatter::getComment ( )

Gets the user provided comment.

Stability: stable
to override
Returns
string HTML

Reimplemented from LogFormatter.

Definition at line 51 of file NewUsersLogFormatter.php.

References wfTimestamp().

◆ getMessageParameters()

NewUsersLogFormatter::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 35 of file NewUsersLogFormatter.php.

References $params, and LogFormatter\makeUserLink().

◆ getPreloadTitles()

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

Reimplemented from LogFormatter.

Definition at line 62 of file NewUsersLogFormatter.php.

References NS_USER_TALK.


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