MediaWiki  master
NullFileJournal Class Reference

Simple version of FileJournal that does nothing. More...

Inheritance diagram for NullFileJournal:
Collaboration diagram for NullFileJournal:

Public Member Functions

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

Protected Member Functions

 doGetChangeEntries ( $start, $limit)
 
 doGetCurrentPosition ()
 
 doGetPositionAtTime ( $time)
 
 doLogChangeBatch (array $entries, $batchId)
 
 doPurgeOldLogs ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FileJournal
static factory (array $config, $backend)
 Create an appropriate FileJournal object from config. More...
 
- Protected Attributes inherited from FileJournal
string $backend
 
int false $ttlDays
 

Detailed Description

Simple version of FileJournal that does nothing.

Since
1.20

Definition at line 6 of file NullFileJournal.php.

Constructor & Destructor Documentation

◆ __construct()

NullFileJournal::__construct ( )

Definition at line 7 of file NullFileJournal.php.

Member Function Documentation

◆ doGetChangeEntries()

NullFileJournal::doGetChangeEntries (   $start,
  $limit 
)
protected
See also
FileJournal::doGetChangeEntries()
Parameters
int$start
int$limit
Returns
array

Reimplemented from FileJournal.

Definition at line 44 of file NullFileJournal.php.

◆ doGetCurrentPosition()

NullFileJournal::doGetCurrentPosition ( )
protected
See also
FileJournal::doGetCurrentPosition()
Returns
int|bool

Reimplemented from FileJournal.

Definition at line 25 of file NullFileJournal.php.

◆ doGetPositionAtTime()

NullFileJournal::doGetPositionAtTime (   $time)
protected
See also
FileJournal::doGetPositionAtTime()
Parameters
int | string$timeTimestamp
Returns
int|bool

Reimplemented from FileJournal.

Definition at line 34 of file NullFileJournal.php.

◆ doLogChangeBatch()

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

Reimplemented from FileJournal.

Definition at line 17 of file NullFileJournal.php.

References StatusValue\newGood().

◆ doPurgeOldLogs()

NullFileJournal::doPurgeOldLogs ( )
protected
See also
FileJournal::doPurgeOldLogs()
Returns
StatusValue

Reimplemented from FileJournal.

Definition at line 52 of file NullFileJournal.php.

References StatusValue\newGood().


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