A value class to process existing log entries. More...

Inheritance diagram for DatabaseLogEntry:

[legend]

Collaboration diagram for DatabaseLogEntry:

[legend]

Public Member Functions
	getAssociatedRevId ()

	getComment ()
	Get the user provided comment.

	getDeleted ()
	Get the access restriction.

	getId ()
	Returns the unique database id.

	getParameters ()
	Get the extra parameters stored for this message.

	getPerformer ()
	Get the user who 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.

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

Public Member Functions inherited from LogEntryBase
	getFullType ()
	The full logtype in format maintype/subtype.

	isDeleted ( $field)

Static Public Member Functions
static	getSelectQueryData ()
	Returns array of information that is needed for querying log entries.

static	newFromId ( $id, IDatabase $db)
	Loads a LogEntry with the given id from database.

static	newFromRow ( $row)
	Constructs new LogEntry from database result row.

Static Public Member Functions inherited from LogEntryBase
static	extractParams ( $blob)
	Extract a parameter array from a blob.

static	makeParamBlob ( $params)
	Create a blob from a parameter array.

Protected Member Functions
	__construct ( $row)

	getRawParameters ()
	Returns whatever is stored in the database field.

Protected Attributes
bool	$legacy
	Whether the parameters for this log entry are stored in new or old format.

array	$params
	Parameters for log entry.

User	$performer

int	$revId = null
	A rev id associated to the log entry.

stdClass	$row
	Database result row.

Detailed Description

A value class to process existing log entries.

In other words, this class caches a log entry from the database and provides an immutable object-oriented representation of it.

Since: 1.19

Definition at line 34 of file DatabaseLogEntry.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseLogEntry::__construct ( $row )

protected

Definition at line 126 of file DatabaseLogEntry.php.

References $row.

Member Function Documentation

◆ getAssociatedRevId()

DatabaseLogEntry::getAssociatedRevId ( )

Reimplemented in RCDatabaseLogEntry.

Definition at line 185 of file DatabaseLogEntry.php.

References $revId, and getParameters().

◆ getComment()

DatabaseLogEntry::getComment ( )

Get the user provided comment.

Returns: string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 224 of file DatabaseLogEntry.php.

◆ getDeleted()

DatabaseLogEntry::getDeleted ( )

Get the access restriction.

Returns: int

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 228 of file DatabaseLogEntry.php.

◆ getId()

DatabaseLogEntry::getId ( )

Returns the unique database id.

Returns: int

Reimplemented in RCDatabaseLogEntry.

Definition at line 135 of file DatabaseLogEntry.php.

◆ getParameters()

DatabaseLogEntry::getParameters ( )

Get the extra parameters stored for this message.

Returns: array

Implements LogEntry.

Definition at line 162 of file DatabaseLogEntry.php.

References $blob, $params, LogEntryBase\extractParams(), LogPage\extractParams(), and getRawParameters().

Referenced by getAssociatedRevId(), and isLegacy().

◆ getPerformer()

DatabaseLogEntry::getPerformer ( )

Get the user who performed this action.

Returns: User

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 191 of file DatabaseLogEntry.php.

References $performer, User\newFromActorId(), User\newFromId(), User\newFromName(), and User\newFromRow().

◆ getRawParameters()

DatabaseLogEntry::getRawParameters ( )

protected

Returns whatever is stored in the database field.

Returns: string

Reimplemented in RCDatabaseLogEntry.

Definition at line 144 of file DatabaseLogEntry.php.

Referenced by getParameters().

◆ getSelectQueryData()

static DatabaseLogEntry::getSelectQueryData ( )

static

Returns array of information that is needed for querying log entries.

Array contains the following keys: tables, fields, conds, options and join_conds

Returns: array

Definition at line 43 of file DatabaseLogEntry.php.

Referenced by ChangeTagsLogList\doQuery(), LogPager\getQueryInfo(), and newFromId().

◆ getSubtype()

DatabaseLogEntry::getSubtype ( )

The log subtype.

Returns: string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 158 of file DatabaseLogEntry.php.

◆ getTarget()

DatabaseLogEntry::getTarget ( )

Get the target page of this action.

Returns: Title

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 214 of file DatabaseLogEntry.php.

◆ getTimestamp()

DatabaseLogEntry::getTimestamp ( )

Get the timestamp when the action was executed.

Returns: string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 220 of file DatabaseLogEntry.php.

References wfTimestamp().

◆ getType()

DatabaseLogEntry::getType ( )

The main log type.

Returns: string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 154 of file DatabaseLogEntry.php.

◆ isLegacy()

DatabaseLogEntry::isLegacy ( )

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

Returns: bool

Reimplemented from LogEntryBase.

Definition at line 148 of file DatabaseLogEntry.php.

References $legacy, and getParameters().

◆ newFromId()

static DatabaseLogEntry::newFromId	(		$id,
		IDatabase	$db
	)

static

Loads a LogEntry with the given id from database.

Parameters

int	$id
IDatabase	$db

Returns: DatabaseLogEntry|null

Definition at line 94 of file DatabaseLogEntry.php.

References $row, getSelectQueryData(), newFromRow(), and Wikimedia\Rdbms\IDatabase\selectRow().

◆ newFromRow()

static DatabaseLogEntry::newFromRow ( $row )

static

Constructs new LogEntry from database result row.

Supports rows from both logging and recentchanges table.

Parameters

stdClass | array $row

Returns: DatabaseLogEntry

Definition at line 78 of file DatabaseLogEntry.php.

References $row.

Referenced by ApiQueryLogEvents\extractRowInfo(), RevDelLogItem\getApiData(), DeleteAutoPatrolLogs\getRowsOld(), LogEventsList\logLine(), newFromId(), and LogFormatter\newFromRow().

Member Data Documentation

◆ $legacy

bool DatabaseLogEntry::$legacy

protected

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

Definition at line 124 of file DatabaseLogEntry.php.

Referenced by isLegacy().

◆ $params

array DatabaseLogEntry::$params

protected

Parameters for log entry.

Definition at line 118 of file DatabaseLogEntry.php.

Referenced by getParameters().

◆ $performer

User DatabaseLogEntry::$performer

protected

Definition at line 115 of file DatabaseLogEntry.php.

Referenced by getPerformer(), and RCDatabaseLogEntry\getPerformer().

◆ $revId

int DatabaseLogEntry::$revId = null

protected

A rev id associated to the log entry.

Definition at line 121 of file DatabaseLogEntry.php.

Referenced by getAssociatedRevId().

◆ $row

stdClass DatabaseLogEntry::$row

protected

Database result row.

Definition at line 112 of file DatabaseLogEntry.php.

Referenced by __construct(), newFromId(), and newFromRow().

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

includes/logging/DatabaseLogEntry.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAssociatedRevId()

◆ getComment()

◆ getDeleted()

◆ getId()

◆ getParameters()

◆ getPerformer()

◆ getRawParameters()

◆ getSelectQueryData()

◆ getSubtype()

◆ getTarget()

◆ getTimestamp()

◆ getType()

◆ isLegacy()

◆ newFromId()

◆ newFromRow()

Member Data Documentation

◆ $legacy

◆ $params

◆ $performer

◆ $revId

◆ $row