MediaWiki REL1_32
Protected Member Functions | Protected Attributes | List of all members
DBFileJournal Class Reference

Version of FileJournal that logs to a DB table. More...

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

Protected Member Functions

 __construct (array $config)
 Construct a new instance from configuration.
 
 doGetChangeEntries ( $start, $limit)
 
 doGetCurrentPosition ()
 
 doGetPositionAtTime ( $time)
 
 doLogChangeBatch (array $entries, $batchId)
 
 doPurgeOldLogs ()
 
 getMasterDB ()
 Get a master connection to the logging DB.
 

Protected Attributes

IDatabase $dbw
 
 $wiki = false
 
- Protected Attributes inherited from FileJournal
string $backend
 
int $ttlDays
 

Additional Inherited Members

- Public Member Functions inherited from FileJournal
 getChangeEntries ( $start=null, $limit=0, &$next=null)
 Get an array of file change log entries.
 
 getCurrentPosition ()
 Get the position ID of the latest journal entry.
 
 getPositionAtTime ( $time)
 Get the position ID of the latest journal entry at some point in time.
 
 getTimestampedUUID ()
 Get a statistically unique ID string.
 
 logChangeBatch (array $entries, $batchId)
 Log changes made by a batch file operation.
 
 purgeOldLogs ()
 Purge any old log entries.
 
- Static Public Member Functions inherited from FileJournal
static factory (array $config, $backend)
 Create an appropriate FileJournal object from config.
 

Detailed Description

Version of FileJournal that logs to a DB table.

Since
1.20

Definition at line 32 of file DBFileJournal.php.

Constructor & Destructor Documentation

◆ __construct()

DBFileJournal::__construct ( array  $config)
protected

Construct a new instance from configuration.

Parameters
array$configIncludes: 'wiki' : wiki name to use for LoadBalancer

Reimplemented from FileJournal.

Definition at line 44 of file DBFileJournal.php.

References wiki.

Member Function Documentation

◆ doGetChangeEntries()

DBFileJournal::doGetChangeEntries (   $start,
  $limit 
)
protected
See also
FileJournal::doGetChangeEntries()
Parameters
int | null$start
int$limit
Returns
array[]

Reimplemented from FileJournal.

Definition at line 131 of file DBFileJournal.php.

References $dbw, $res, $value, Wikimedia\Rdbms\IDatabase\addQuotes(), array(), as, getMasterDB(), and Wikimedia\Rdbms\IDatabase\select().

◆ doGetCurrentPosition()

DBFileJournal::doGetCurrentPosition ( )
protected
See also
FileJournal::doGetCurrentPosition()
Returns
bool|mixed The value from the field, or false on failure.

Reimplemented from FileJournal.

Definition at line 99 of file DBFileJournal.php.

References $dbw, getMasterDB(), and Wikimedia\Rdbms\IDatabase\selectField().

◆ doGetPositionAtTime()

DBFileJournal::doGetPositionAtTime (   $time)
protected
See also
FileJournal::doGetPositionAtTime()
Parameters
int | string$timeTimestamp
Returns
bool|mixed The value from the field, or false on failure.

Reimplemented from FileJournal.

Definition at line 113 of file DBFileJournal.php.

References $dbw, $time, Wikimedia\Rdbms\IDatabase\addQuotes(), getMasterDB(), Wikimedia\Rdbms\IDatabase\selectField(), and Wikimedia\Rdbms\IDatabase\timestamp().

◆ doLogChangeBatch()

DBFileJournal::doLogChangeBatch ( array  $entries,
  $batchId 
)
protected
See also
FileJournal::logChangeBatch()
Parameters
array$entries
string$batchId
Returns
StatusValue

Reimplemented from FileJournal.

Definition at line 56 of file DBFileJournal.php.

References FileJournal\$backend, $dbw, $e, as, getMasterDB(), Wikimedia\Rdbms\IDatabase\insert(), FileJournal\purgeOldLogs(), Wikimedia\Rdbms\IDatabase\timestamp(), and wfTimestamp().

◆ doPurgeOldLogs()

DBFileJournal::doPurgeOldLogs ( )
protected
See also
FileJournal::purgeOldLogs()
Returns
StatusValue
Exceptions
DBError

Reimplemented from FileJournal.

Definition at line 160 of file DBFileJournal.php.

References $dbw, Wikimedia\Rdbms\IDatabase\addQuotes(), Wikimedia\Rdbms\IDatabase\delete(), getMasterDB(), and Wikimedia\Rdbms\IDatabase\timestamp().

◆ getMasterDB()

DBFileJournal::getMasterDB ( )
protected

Get a master connection to the logging DB.

Returns
IDatabase
Exceptions
DBError

Definition at line 183 of file DBFileJournal.php.

References $dbw, DB_MASTER, DBO_TRX, and wiki.

Referenced by doGetChangeEntries(), doGetCurrentPosition(), doGetPositionAtTime(), doLogChangeBatch(), and doPurgeOldLogs().

Member Data Documentation

◆ $dbw

IDatabase DBFileJournal::$dbw
protected

Definition at line 34 of file DBFileJournal.php.

Referenced by doGetChangeEntries(), doGetCurrentPosition(), doGetPositionAtTime(), doLogChangeBatch(), doPurgeOldLogs(), and getMasterDB().

◆ $wiki

DBFileJournal::$wiki = false
protected

Definition at line 36 of file DBFileJournal.php.

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