Interface for log entries. More...
Public Member Functions | |
| getComment () | |
| Get the user provided comment. | |
| getDeleted () | |
| Get the access restriction. | |
| getFullType () | |
| The full logtype in format maintype/subtype. | |
| getParameters () | |
| Get the extra parameters stored for this message. | |
| getPerformerIdentity () | |
| getSubtype () | |
| The log subtype. | |
| getTarget () | |
| Get the target page of this action. | |
| getTimestamp () | |
| Get the timestamp when the action was executed. | |
| getType () | |
| The main log type. | |
| isDeleted ( $field) | |
Detailed Description
Interface for log entries.
Every log entry has these methods.
- Stability: unstable
- for implementation, extensions should subclass LogEntryBase instead.
- Since
- 1.19
Definition at line 34 of file LogEntry.php.
Member Function Documentation
◆ getComment()
| LogEntry::getComment | ( | ) |
Get the user provided comment.
- Returns
- string
Implemented in DatabaseLogEntry, ManualLogEntry, and RCDatabaseLogEntry.
◆ getDeleted()
| LogEntry::getDeleted | ( | ) |
Get the access restriction.
- Returns
- int
Implemented in DatabaseLogEntry, ManualLogEntry, and RCDatabaseLogEntry.
Referenced by LogEntryBase\isDeleted().
◆ getFullType()
| LogEntry::getFullType | ( | ) |
◆ getParameters()
| LogEntry::getParameters | ( | ) |
Get the extra parameters stored for this message.
- Returns
- array
Implemented in DatabaseLogEntry, and ManualLogEntry.
Referenced by LogFormatter\extractParameters(), LegacyLogFormatter\getActionMessage(), LogFormatter\getIRCActionText(), BlockLogFormatter\getParametersForApi(), DeleteLogFormatter\getParametersForApi(), MergeLogFormatter\getParametersForApi(), MoveLogFormatter\getParametersForApi(), PatrolLogFormatter\getParametersForApi(), ProtectLogFormatter\getParametersForApi(), RightsLogFormatter\getParametersForApi(), and UploadLogFormatter\getParametersForApi().
◆ getPerformerIdentity()
| LogEntry::getPerformerIdentity | ( | ) |
- Since
- 1.36
- Returns
- UserIdentity
Implemented in DatabaseLogEntry, ManualLogEntry, and RCDatabaseLogEntry.
Referenced by LogFormatter\getMessageParameters().
◆ getSubtype()
| LogEntry::getSubtype | ( | ) |
The log subtype.
- Returns
- string
Implemented in DatabaseLogEntry, ManualLogEntry, and RCDatabaseLogEntry.
Referenced by LegacyLogFormatter\getActionMessage(), LogEntryBase\getFullType(), LogFormatter\getIRCActionText(), BlockLogFormatter\getParametersForApi(), DeleteLogFormatter\getParametersForApi(), and ProtectLogFormatter\getParametersForApi().
◆ getTarget()
| LogEntry::getTarget | ( | ) |
Get the target page of this action.
- Returns
- Title
Implemented in DatabaseLogEntry, ManualLogEntry, and RCDatabaseLogEntry.
Referenced by LegacyLogFormatter\getActionMessage(), LogFormatter\getIRCActionText(), and LogFormatter\getMessageParameters().
◆ getTimestamp()
| LogEntry::getTimestamp | ( | ) |
Get the timestamp when the action was executed.
- Returns
- string
Implemented in DatabaseLogEntry, ManualLogEntry, and RCDatabaseLogEntry.
Referenced by LogFormatter\getIRCActionText(), and BlockLogFormatter\getParametersForApi().
◆ getType()
| LogEntry::getType | ( | ) |
The main log type.
- Returns
- string
Implemented in DatabaseLogEntry, ManualLogEntry, and RCDatabaseLogEntry.
Referenced by LegacyLogFormatter\getActionMessage(), LogEntryBase\getFullType(), LogFormatter\getIRCActionText(), and LogFormatter\newFromEntry().
◆ isDeleted()
| LogEntry::isDeleted | ( | $field | ) |
- Parameters
-
int $field One of LogPage::DELETED_* bitfield constants
- Returns
- bool
Implemented in LogEntryBase.
The documentation for this interface was generated from the following file:
- includes/logging/LogEntry.php
