Class for handling file operation journaling. More...

Inheritance diagram for FileJournal:

Collaboration diagram for FileJournal:

Public Member Functions
	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
static	factory (array $config, $backend)
	Create an appropriate FileJournal object from config.
Protected Member Functions
	__construct (array $config)
	Construct a new instance from configuration.
	doGetChangeEntries ($start, $limit)
	doGetCurrentPosition ()
	doGetPositionAtTime ($time)
	doLogChangeBatch (array $entries, $batchId)
	doPurgeOldLogs ()
Protected Attributes
string	$backend
	*
int	$ttlDays
	*

Detailed Description

Class for handling file operation journaling.

Subclasses should avoid throwing exceptions at all costs.

Since:: 1.20

Definition at line 38 of file FileJournal.php.

Constructor & Destructor Documentation

FileJournal::__construct ( array $ config ) [protected]

Construct a new instance from configuration.

Parameters:

array $config Includes: 'ttlDays' : days to keep log entries around (false means "forever")

Reimplemented in DBFileJournal.

Definition at line 49 of file FileJournal.php.

Member Function Documentation

FileJournal::doGetChangeEntries	(	$	start,
		$	limit
	)		`[abstract, protected]`

See also:: FileJournal::getChangeEntries()

Parameters:

int	$start
int	$limit

Returns:: array

Reimplemented in NullFileJournal, and DBFileJournal.

FileJournal::doGetCurrentPosition ( ) [abstract, protected]

See also:: FileJournal::getCurrentPosition()

Returns:: int|bool

Reimplemented in NullFileJournal, and DBFileJournal.

FileJournal::doGetPositionAtTime ( $ time ) [abstract, protected]

See also:: FileJournal::getPositionAtTime()

Parameters:

int | string $time Timestamp

Returns:: int|bool

Reimplemented in NullFileJournal, and DBFileJournal.

FileJournal::doLogChangeBatch	(	array $	entries,
		$	batchId
	)		`[abstract, protected]`

See also:: FileJournal::logChangeBatch()

Parameters:

array	$entries	List of file operations (each an array of parameters)
string	$batchId	UUID string that identifies the operation batch

Returns:: Status

Reimplemented in NullFileJournal, and DBFileJournal.

FileJournal::doPurgeOldLogs ( ) [abstract, protected]

See also:: FileJournal::purgeOldLogs()

Returns:: Status

Reimplemented in NullFileJournal, and DBFileJournal.

static FileJournal::factory	(	array $	config,
		$	backend
	)		`[static, final]`

Create an appropriate FileJournal object from config.

Parameters:

array	$config
string	$backend	A registered file backend name

Exceptions:

MWException

Returns:: FileJournal

Definition at line 61 of file FileJournal.php.

FileJournal::getChangeEntries	(	$	start = `null`,
		$	limit = `0`,
		&$	next = `null`
	)		`[final]`

Get an array of file change log entries.

A starting change ID and/or limit can be specified.

Parameters:

int	$start	Starting change ID or null
int	$limit	Maximum number of items to return
string	&$next	Updated to the ID of the next entry.

Returns:: array List of associative arrays, each having: id : unique, monotonic, ID for this change batch_uuid : UUID for an operation batch backend : the backend name op : primitive operation (create,update,delete,null) path : affected storage path new_sha1 : base 36 sha1 of the new file had the operation succeeded timestamp : TS_MW timestamp of the batch change Also, $next is updated to the ID of the next entry.

Definition at line 164 of file FileJournal.php.

FileJournal::getCurrentPosition ( ) [final]

Get the position ID of the latest journal entry.

Returns:: int|bool

Definition at line 120 of file FileJournal.php.

FileJournal::getPositionAtTime ( $ time ) [final]

Get the position ID of the latest journal entry at some point in time.

Parameters:

int | string $time Timestamp

Returns:: int|bool

Definition at line 136 of file FileJournal.php.

FileJournal::getTimestampedUUID ( ) [final]

Get a statistically unique ID string.

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

Definition at line 77 of file FileJournal.php.

Referenced by FileOpBatch\attempt().

FileJournal::logChangeBatch	(	array $	entries,
		$	batchId
	)		`[final]`

Log changes made by a batch file operation.

Parameters:

array	$entries	List of file operations (each an array of parameters) which contain: op : Basic operation name (create, update, delete) path : The storage path of the file newSha1 : The final base 36 SHA-1 of the file Note that 'false' should be used as the SHA-1 for non-existing files.
string	$batchId	UUID string that identifies the operation batch

Returns:: Status

Definition at line 98 of file FileJournal.php.

Referenced by FileOpBatch\attempt().

FileJournal::purgeOldLogs ( ) [final]

Purge any old log entries.

Returns:: Status

Definition at line 189 of file FileJournal.php.

Member Data Documentation

string FileJournal::$backend [protected]

*

Definition at line 39 of file FileJournal.php.

int FileJournal::$ttlDays [protected]

*

Definition at line 41 of file FileJournal.php.

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

includes/filebackend/filejournal/FileJournal.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation