[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/filebackend/filejournal/ -> FileJournal.php (summary)

(no description)

File Size: 251 lines (7 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 1 class

NullFileJournal:: (5 methods):
  doLogChangeBatch()
  doGetCurrentPosition()
  doGetPositionAtTime()
  doGetChangeEntries()
  doPurgeOldLogs()

Defines 5 functions

  __construct()
  factory()
  getTimestampedUUID()
  logChangeBatch()
  getCurrentPosition()
  getPositionAtTime()
  getChangeEntries()
  purgeOldLogs()

Class: NullFileJournal  - X-Ref

Simple version of FileJournal that does nothing

doLogChangeBatch( array $entries, $batchId )   X-Ref

param: array $entries
param: string $batchId
return: Status

doGetCurrentPosition()   X-Ref

return: int|bool

doGetPositionAtTime( $time )   X-Ref

param: int|string $time Timestamp
return: int|bool

doGetChangeEntries( $start, $limit )   X-Ref

param: int $start
param: int $limit
return: array

doPurgeOldLogs()   X-Ref

return: Status

Functions
Functions that are not part of a class:

__construct( array $config )   X-Ref
Construct a new instance from configuration.

param: array $config Includes:

factory( array $config, $backend )   X-Ref
Create an appropriate FileJournal object from config

param: array $config
param: string $backend A registered file backend name
return: FileJournal

getTimestampedUUID()   X-Ref
Get a statistically unique ID string

return: string <9 char TS_MW timestamp in base 36><22 random base 36 chars>

logChangeBatch( array $entries, $batchId )   X-Ref
Log changes made by a batch file operation.

param: array $entries List of file operations (each an array of parameters) which contain:
param: string $batchId UUID string that identifies the operation batch
return: Status

getCurrentPosition()   X-Ref
Get the position ID of the latest journal entry

return: int|bool

getPositionAtTime( $time )   X-Ref
Get the position ID of the latest journal entry at some point in time

param: int|string $time Timestamp
return: int|bool

getChangeEntries( $start = null, $limit = 0, &$next = null )   X-Ref
Get an array of file change log entries.
A starting change ID and/or limit can be specified.

param: int $start Starting change ID or null
param: int $limit Maximum number of items to return
param: string &$next Updated to the ID of the next entry.
return: array List of associative arrays, each having:

purgeOldLogs()   X-Ref
Purge any old log entries

return: Status



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1