MediaWiki  1.23.13
DatabaseLogEntry Class Reference

This class wraps around database result row. More...

Inheritance diagram for DatabaseLogEntry:
Collaboration diagram for DatabaseLogEntry:

Public Member Functions

 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 newFromRow ( $row)
 Constructs new LogEntry from database result row. 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...
 
User $performer
 
stdClass $row
 Database result row. More...
 

Detailed Description

This class wraps around database result row.

Since
1.19

Definition at line 124 of file LogEntry.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseLogEntry::__construct (   $row)
protected

Definition at line 182 of file LogEntry.php.

References $row.

Member Function Documentation

◆ getComment()

DatabaseLogEntry::getComment ( )

Get the user provided comment.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 269 of file LogEntry.php.

◆ getDeleted()

DatabaseLogEntry::getDeleted ( )

Get the access restriction.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 273 of file LogEntry.php.

◆ getId()

DatabaseLogEntry::getId ( )

Returns the unique database id.

Returns
int

Reimplemented in RCDatabaseLogEntry.

Definition at line 190 of file LogEntry.php.

◆ getParameters()

DatabaseLogEntry::getParameters ( )

Get the extra parameters stored for this message.

Returns
array

Implements LogEntry.

Definition at line 221 of file LogEntry.php.

References $blob, $params, array(), getRawParameters(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by isLegacy().

◆ getPerformer()

DatabaseLogEntry::getPerformer ( )

Get the user for performed this action.

Returns
User

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 239 of file LogEntry.php.

References $performer, if, 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 198 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 133 of file LogEntry.php.

References $tables, and array().

Referenced by LogPager\getQueryInfo().

◆ getSubtype()

DatabaseLogEntry::getSubtype ( )

The log subtype.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 217 of file LogEntry.php.

◆ getTarget()

DatabaseLogEntry::getTarget ( )

Get the target page of this action.

Returns
Title

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 257 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 265 of file LogEntry.php.

References TS_MW, and wfTimestamp().

◆ getType()

DatabaseLogEntry::getType ( )

The main log type.

Returns
string

Implements LogEntry.

Reimplemented in RCDatabaseLogEntry.

Definition at line 213 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 204 of file LogEntry.php.

References $legacy, and getParameters().

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

References $row, and object.

Referenced by ApiQueryWatchlist\extractRowInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), RevDel_LogItem\getApiData(), LogEventsList\logLine(), 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 180 of file LogEntry.php.

Referenced by isLegacy().

◆ $performer

User DatabaseLogEntry::$performer
protected

Definition at line 176 of file LogEntry.php.

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

◆ $row

stdClass DatabaseLogEntry::$row
protected

Database result row.

Definition at line 174 of file LogEntry.php.

Referenced by __construct(), and newFromRow().


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