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. 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...

Static Public Member Functions
static	factory (array $config, $backend)
	Create an appropriate FileJournal object from config. More...

Protected Member Functions
	__construct (array $config)
	Construct a new instance from configuration. More...

	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")

Definition at line 51 of file FileJournal.php.

Member Function Documentation

FileJournal::doGetChangeEntries	(	$start,
		$limit
	)

abstractprotected

See also: FileJournal::getChangeEntries()

Parameters

int	$start
int	$limit

Returns: array

Referenced by getChangeEntries().

FileJournal::doGetCurrentPosition ( )

abstractprotected

See also: FileJournal::getCurrentPosition()

Returns: int|bool

Referenced by getCurrentPosition().

FileJournal::doGetPositionAtTime ( $time )

abstractprotected

See also: FileJournal::getPositionAtTime()

Parameters

int | string $time Timestamp

Returns: int|bool

Referenced by getPositionAtTime().

FileJournal::doLogChangeBatch	(	array	$entries,
			$batchId
	)

abstractprotected

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: StatusValue

Referenced by logChangeBatch().

FileJournal::doPurgeOldLogs ( )

abstractprotected

See also: FileJournal::purgeOldLogs()

Returns: StatusValue

Referenced by purgeOldLogs().

static FileJournal::factory	(	array	$config,
			$backend
	)

staticfinal

Create an appropriate FileJournal object from config.

Parameters

array	$config
string	$backend	A registered file backend name

Exceptions

Exception

Returns: FileJournal

Definition at line 63 of file FileJournal.php.

References $backend.

Referenced by FileBackend\__construct(), FileBackendGroup\config(), and FileBackendTest\setUp().

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 166 of file FileJournal.php.

References $last, $limit, and doGetChangeEntries().

FileJournal::getCurrentPosition ( )

final

Get the position ID of the latest journal entry.

Returns: int|bool

Definition at line 122 of file FileJournal.php.

References doGetCurrentPosition().

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 138 of file FileJournal.php.

References $time, and doGetPositionAtTime().

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 79 of file FileJournal.php.

References $s, TS_MW, and wfTimestamp().

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