MediaWiki\Logging\LogEntry Interface Reference

An individual log entry. More...

Inherited by MediaWiki\Logging\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)
	isLegacy ()
	Whether the parameters for this log are stored in new or old format.

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 23 of file LogEntry.php.

Member Function Documentation

getComment()

MediaWiki\Logging\LogEntry::getComment

(

)

Get the user provided comment.

Returns

string

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\ManualLogEntry, and MediaWiki\Logging\RCDatabaseLogEntry.

getDeleted()

MediaWiki\Logging\LogEntry::getDeleted

(

)

Get the access restriction.

Returns

int

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\ManualLogEntry, and MediaWiki\Logging\RCDatabaseLogEntry.

Referenced by MediaWiki\Logging\LogEntryBase\isDeleted().

getFullType()

MediaWiki\Logging\LogEntry::getFullType

(

)

The full logtype in format maintype/subtype.

Returns

string

Implemented in MediaWiki\Logging\LogEntryBase.

getParameters()

MediaWiki\Logging\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 MediaWiki\Logging\DatabaseLogEntry, and MediaWiki\Logging\ManualLogEntry.

Referenced by MediaWiki\Logging\LegacyLogFormatter\getActionMessage(), MediaWiki\Logging\BlockLogFormatter\getParametersForApi(), MediaWiki\Logging\MergeLogFormatter\getParametersForApi(), MediaWiki\Logging\MoveLogFormatter\getParametersForApi(), MediaWiki\Logging\PatrolLogFormatter\getParametersForApi(), MediaWiki\Logging\ProtectLogFormatter\getParametersForApi(), and MediaWiki\Logging\UploadLogFormatter\getParametersForApi().

getPerformerIdentity()

MediaWiki\Logging\LogEntry::getPerformerIdentity

(

)

Since

1.36

Returns

UserIdentity

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\ManualLogEntry, and MediaWiki\Logging\RCDatabaseLogEntry.

getSubtype()

MediaWiki\Logging\LogEntry::getSubtype

(

)

The log subtype.

Returns

string

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\ManualLogEntry, and MediaWiki\Logging\RCDatabaseLogEntry.

Referenced by MediaWiki\Logging\LegacyLogFormatter\getActionMessage(), MediaWiki\Logging\LogEntryBase\getFullType(), MediaWiki\Logging\BlockLogFormatter\getParametersForApi(), MediaWiki\Logging\MergeLogFormatter\getParametersForApi(), and MediaWiki\Logging\ProtectLogFormatter\getParametersForApi().

getTarget()

MediaWiki\Logging\LogEntry::getTarget

(

)

Get the target page of this action.

Returns

Title

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\ManualLogEntry, and MediaWiki\Logging\RCDatabaseLogEntry.

Referenced by MediaWiki\Logging\LegacyLogFormatter\getActionMessage().

getTimestamp()

MediaWiki\Logging\LogEntry::getTimestamp

(

)

Get the timestamp when the action was executed.

Returns

string TS::MW timestamp, a string with 14 digits

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\ManualLogEntry, and MediaWiki\Logging\RCDatabaseLogEntry.

Referenced by MediaWiki\Logging\BlockLogFormatter\getParametersForApi().

getType()

MediaWiki\Logging\LogEntry::getType

(

)

The main log type.

Returns

string

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\ManualLogEntry, and MediaWiki\Logging\RCDatabaseLogEntry.

Referenced by MediaWiki\Logging\LegacyLogFormatter\getActionMessage(), and MediaWiki\Logging\LogEntryBase\getFullType().

isDeleted()

MediaWiki\Logging\LogEntry::isDeleted

(

$field

)

Parameters

int

$field

One of LogPage::DELETED_* bitfield constants

Returns

bool

Implemented in MediaWiki\Logging\LogEntryBase.

isLegacy()

MediaWiki\Logging\LogEntry::isLegacy

(

)

Whether the parameters for this log are stored in new or old format.

Implemented in MediaWiki\Logging\DatabaseLogEntry, MediaWiki\Logging\LogEntryBase, and MediaWiki\Logging\ManualLogEntry.

---

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

• includes/Logging/LogEntry.php