MediaWiki  master
LogEntry Interface Reference

Interface for log entries. More...

Inheritance diagram for LogEntry:

Public Member Functions

 getComment ()
 Get the user provided comment. More...
 
 getDeleted ()
 Get the access restriction. More...
 
 getFullType ()
 The full logtype in format maintype/subtype. More...
 
 getParameters ()
 Get the extra parameters stored for this message. More...
 
 getPerformer ()
 Get the user for performed this action. More...
 
 getSubtype ()
 The log subtype. More...
 
 getTarget ()
 Get the target page of this action. More...
 
 getTimestamp ()
 Get the timestamp when the action was executed. More...
 
 getType ()
 The main log type. More...
 
 isDeleted ( $field)
 

Detailed Description

Interface for log entries.

Every log entry has these methods.

Since
1.19

Definition at line 31 of file LogEntry.php.

Member Function Documentation

◆ getComment()

LogEntry::getComment ( )

Get the user provided comment.

Returns
string

Implemented in ManualLogEntry, DatabaseLogEntry, and RCDatabaseLogEntry.

◆ getDeleted()

LogEntry::getDeleted ( )

Get the access restriction.

Returns
int

Implemented in ManualLogEntry, DatabaseLogEntry, and RCDatabaseLogEntry.

Referenced by LogEntryBase\isDeleted().

◆ getFullType()

LogEntry::getFullType ( )

The full logtype in format maintype/subtype.

Returns
string

Implemented in LogEntryBase.

Referenced by LogFormatter\newFromEntry().

◆ getParameters()

◆ getPerformer()

LogEntry::getPerformer ( )

Get the user for performed this action.

Returns
User

Implemented in ManualLogEntry, DatabaseLogEntry, and RCDatabaseLogEntry.

Referenced by LogFormatter\getMessageParameters().

◆ getSubtype()

◆ getTarget()

LogEntry::getTarget ( )

◆ getTimestamp()

LogEntry::getTimestamp ( )

Get the timestamp when the action was executed.

Returns
string

Implemented in ManualLogEntry, DatabaseLogEntry, and RCDatabaseLogEntry.

Referenced by LogFormatter\getIRCActionText(), and BlockLogFormatter\getParametersForApi().

◆ getType()

◆ isDeleted()

LogEntry::isDeleted (   $field)
Parameters
int$fieldOne of LogPage::DELETED_* bitfield constants
Returns
bool

Implemented in LogEntryBase.


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