LogEntry Interface Reference

An individual log entry. More...

Inherited by LogEntryBase.

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

An individual log entry.

This is the basis for methods that all log entries support.

Must not be implemented directly by extensions, extend LogEntryBase instead.

Stability: stable

to type

Since

1.19

Author

Niklas Laxström

Definition at line 35 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

(

)

The full logtype in format maintype/subtype.

Returns

string

Implemented in LogEntryBase.

Referenced by LogFormatter\newFromEntry().

getParameters()

LogEntry::getParameters

(

)

Get the extra parameters stored for this message.

This will be in the same format as setParameters(), ie. the array keys might include message formatting prefixes.

Returns

array

See also

ManualLogEntry::setParameters() for message formatting prefixes.

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 TS_MW timestamp, a string with 14 digits

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