MediaWiki  REL1_22
LogEntry Interface Reference

Interface for log entries. More...

Inheritance diagram for LogEntry:

List of all members.

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.
 getPerformer ()
 Get the user for performed this action.
 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.

Since:
1.19

Definition at line 35 of file LogEntry.php.


Member Function Documentation

Get the user provided comment.

Returns:
string

Implemented in ManualLogEntry, RCDatabaseLogEntry, and DatabaseLogEntry.

Get the access restriction.

Returns:
string

Implemented in ManualLogEntry, RCDatabaseLogEntry, and DatabaseLogEntry.

Referenced by LogEntryBase\isDeleted().

The full logtype in format maintype/subtype.

Returns:
string

Implemented in LogEntryBase.

Referenced by LogFormatter\newFromEntry().

Get the extra parameters stored for this message.

Returns:
array

Implemented in ManualLogEntry, and DatabaseLogEntry.

Get the user for performed this action.

Returns:
User

Implemented in ManualLogEntry, RCDatabaseLogEntry, and DatabaseLogEntry.

The log subtype.

Returns:
string

Implemented in ManualLogEntry, RCDatabaseLogEntry, and DatabaseLogEntry.

Referenced by LogEntryBase\getFullType().

Get the target page of this action.

Returns:
Title

Implemented in ManualLogEntry, RCDatabaseLogEntry, and DatabaseLogEntry.

Get the timestamp when the action was executed.

Returns:
string

Implemented in ManualLogEntry, RCDatabaseLogEntry, and DatabaseLogEntry.

The main log type.

Returns:
string

Implemented in ManualLogEntry, RCDatabaseLogEntry, and DatabaseLogEntry.

Referenced by LogEntryBase\getFullType(), and LogFormatter\newFromEntry().

LogEntry::isDeleted ( field)
Parameters:
$fieldInteger: one of LogPage::DELETED_* bitfield constants
Returns:
Boolean

Implemented in LogEntryBase.


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