MediaWiki  1.28.0
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 ()
 
 getActionLinks ()
 
 getPreloadTitles ()
 
- Public Member Functions inherited from LogFormatter
 formatParametersForApi ()
 Format parameters for API output. 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. More...
 
 getIRCActionComment ()
 Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508). More...
 
 getIRCActionText ()
 Even uglier hack to maintain backwards compatibilty with IRC bots (bug 34508). More...
 
 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 ()
 
 setAudience ($audience)
 Set the visibility restrictions for displaying content. More...
 
 setContext (IContextSource $context)
 Replace the default context. More...
 
 setShowUserToolLinks ($value)
 If set to true, will produce user tool links after the user name. More...
 

Protected Member Functions

 getMessageKey ()
 
 getMessageParameters ()
 
 getParametersForApi ()
 
- 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...
 
 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...
 
 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 (User $user, $toolFlags=0)
 
 msg ($key)
 Shortcut for wfMessage which honors local context. More...
 
 styleRestricedElement ($content)
 Helper method for styling restricted element. More...
 

Private Member Functions

 formatExpiry ($expiry)
 

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...
 
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 protect log entries.

Since
1.26

Definition at line 30 of file ProtectLogFormatter.php.

Member Function Documentation

ProtectLogFormatter::createProtectDescription ( array  $details)

Create the protect description to show in the log formatter.

Parameters
array$details
Returns
string

Definition at line 168 of file ProtectLogFormatter.php.

References as, and formatExpiry().

Referenced by getMessageParameters().

ProtectLogFormatter::formatExpiry (   $expiry)
private

Definition at line 199 of file ProtectLogFormatter.php.

References $lang, $user, text, and wfIsInfinity().

Referenced by createProtectDescription().

ProtectLogFormatter::formatParametersForApi ( )

Definition at line 147 of file ProtectLogFormatter.php.

References $ret, $wgContLang, as, global, and TS_ISO_8601.

ProtectLogFormatter::getActionLinks ( )
ProtectLogFormatter::getMessageKey ( )
protected

Definition at line 40 of file ProtectLogFormatter.php.

References $params, and LogFormatter\extractParameters().

ProtectLogFormatter::getMessageParameters ( )
protected
ProtectLogFormatter::getParametersForApi ( )
protected
ProtectLogFormatter::getPreloadTitles ( )

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