MediaWiki  1.32.5
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DatabaseLogEntry Class Reference

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

Inheritance diagram for DatabaseLogEntry:
Inheritance graph
[legend]
Collaboration diagram for DatabaseLogEntry:
Collaboration graph
[legend]

Public Member Functions

 getAssociatedRevId ()
 
 getComment ()
 Get the user provided comment. More...
 
 getDeleted ()
 Get the access restriction. More...
 
 getId ()
 Returns the unique database id. More...
 
 getParameters ()
 Get the extra parameters stored for this message. More...
 
 getPerformer ()
 Get the user for performed this action. More...
 
 getSubtype ()
 The log subtype. More...
 
 getTarget ()
 Get the target page of this action. More...
 
 getTimestamp ()
 Get the timestamp when the action was executed. More...
 
 getType ()
 The main log type. More...
 
 isLegacy ()
 Whether the parameters for this log are stored in new or old format. More...
 
- Public Member Functions inherited from LogEntryBase
 getFullType ()
 The full logtype in format maintype/subtype. More...
 
 isDeleted ( $field)
 

Static Public Member Functions

static getSelectQueryData ()
 Returns array of information that is needed for querying log entries. More...
 
static newFromId ( $id, IDatabase $db)
 Loads a LogEntry with the given id from database. More...
 
static newFromRow ( $row)
 Constructs new LogEntry from database result row. More...
 
- Static Public Member Functions inherited from LogEntryBase
static extractParams ( $blob)
 Extract a parameter array from a blob. More...
 
static makeParamBlob ( $params)
 Create a blob from a parameter array. More...
 

Protected Member Functions

 __construct ( $row)
 
 getRawParameters ()
 Returns whatever is stored in the database field. More...
 

Protected Attributes

bool $legacy
 Whether the parameters for this log entry are stored in new or old format. More...
 
array $params
 Parameters for log entry. More...
 
User $performer
 
int $revId = null
 A rev id associated to the log entry. More...
 
stdClass $row
 Database result row. More...
 

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

Constructor & Destructor Documentation

◆ __construct()

DatabaseLogEntry::__construct (   $row)
protected

Definition at line 256 of file LogEntry.php.

References $row.

Member Function Documentation

◆ getAssociatedRevId()

DatabaseLogEntry::getAssociatedRevId ( )

Reimplemented in RCDatabaseLogEntry.

Definition at line 315 of file LogEntry.php.

References $revId, and getParameters().

◆ getComment()

DatabaseLogEntry::getComment ( )

Get the user provided comment.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 356 of file LogEntry.php.

References CommentStore\getStore().

◆ getDeleted()

DatabaseLogEntry::getDeleted ( )

Get the access restriction.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 360 of file LogEntry.php.

◆ getId()

DatabaseLogEntry::getId ( )

Returns the unique database id.

Returns
int

Reimplemented in RCDatabaseLogEntry.

Definition at line 265 of file LogEntry.php.

◆ getParameters()

DatabaseLogEntry::getParameters ( )

Get the extra parameters stored for this message.

Returns
array

Implements LogEntry.

Definition at line 292 of file LogEntry.php.

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

Referenced by getAssociatedRevId(), and isLegacy().

◆ getPerformer()

DatabaseLogEntry::getPerformer ( )

Get the user for performed this action.

Returns
User

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 321 of file LogEntry.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 274 of file LogEntry.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 173 of file LogEntry.php.

References $tables, CommentStore\getStore(), and ActorMigration\newMigration().

Referenced by ChangeTagsLogList\doQuery(), LogPager\getQueryInfo(), newFromId(), MediaWiki\Auth\AuthManagerTest\testAccountCreationLogging(), and MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation().

◆ getSubtype()

DatabaseLogEntry::getSubtype ( )

The log subtype.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 288 of file LogEntry.php.

◆ getTarget()

DatabaseLogEntry::getTarget ( )

Get the target page of this action.

Returns
Title

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 344 of file LogEntry.php.

References $title, and Title\makeTitle().

◆ getTimestamp()

DatabaseLogEntry::getTimestamp ( )

Get the timestamp when the action was executed.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 352 of file LogEntry.php.

References wfTimestamp().

◆ getType()

DatabaseLogEntry::getType ( )

The main log type.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 284 of file LogEntry.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 278 of file LogEntry.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 224 of file LogEntry.php.

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

Referenced by DatabaseLogEntryTest\testNewFromId().

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

References $row, and object.

Referenced by ApiQueryLogEvents\extractRowInfo(), RevDelLogItem\getApiData(), DeleteAutoPatrolLogs\getRowsOld(), LogEventsList\logLine(), newFromId(), LogFormatter\newFromRow(), MediaWiki\Auth\AuthManagerTest\testAccountCreationLogging(), and MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation().

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

Referenced by isLegacy().

◆ $params

array DatabaseLogEntry::$params
protected

Parameters for log entry.

Definition at line 248 of file LogEntry.php.

Referenced by getParameters().

◆ $performer

User DatabaseLogEntry::$performer
protected

Definition at line 245 of file LogEntry.php.

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

◆ $revId

int DatabaseLogEntry::$revId = null
protected

A rev id associated to the log entry.

Definition at line 251 of file LogEntry.php.

Referenced by getAssociatedRevId().

◆ $row

stdClass DatabaseLogEntry::$row
protected

Database result row.

Definition at line 242 of file LogEntry.php.

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

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