LocalFileRestoreBatch Class Reference

Helper class for file undeletion. More...

Collaboration diagram for LocalFileRestoreBatch:

Public Member Functions
	__construct (File $file, $unsuppress=false)
	addAll ()
	Add all revisions of the file. More...
	addId ( $fa_id)
	Add a file by ID. More...
	addIds ( $ids)
	Add a whole lot of files by ID. More...
	cleanup ()
	Delete unused files in the deleted zone. More...
	execute ()
	Run the transaction, except the cleanup batch. More...

Protected Member Functions
	cleanupFailedBatch ( $storeStatus, $storeBatch)
	Cleanup a failed batch. More...
	removeNonexistentFiles ( $triplets)
	Removes non-existent files from a store batch. More...
	removeNonexistentFromCleanup ( $batch)
	Removes non-existent files from a cleanup batch. More...

Private Attributes
bool	$all
	Add all revisions of the file. More...
string[]	$cleanupBatch
	List of file IDs to restore. More...
LocalFile	$file
string[]	$ids
	List of file IDs to restore. More...
bool	$unsuppress = false
	Whether to remove all settings for suppressed fields. More...

Detailed Description

Helper class for file undeletion.

Definition at line 30 of file LocalFileRestoreBatch.php.

Constructor & Destructor Documentation

__construct()

LocalFileRestoreBatch::__construct	(	File	$file,
			$unsuppress = false
	)

Parameters

File	$file
bool	$unsuppress

Definition at line 50 of file LocalFileRestoreBatch.php.

References $file, and $unsuppress.

Member Function Documentation

addAll()

LocalFileRestoreBatch::addAll

(

)

Add all revisions of the file.

Definition at line 76 of file LocalFileRestoreBatch.php.

addId()

LocalFileRestoreBatch::addId

(

$fa_id

)

Add a file by ID.

Parameters

int

$fa_id

Definition at line 61 of file LocalFileRestoreBatch.php.

addIds()

LocalFileRestoreBatch::addIds

(

$ids

)

Add a whole lot of files by ID.

Parameters

int[]

$ids

Definition at line 69 of file LocalFileRestoreBatch.php.

References $ids.

cleanup()

LocalFileRestoreBatch::cleanup

(

)

Delete unused files in the deleted zone.

This should be called from outside the transaction in which execute() was called.

Returns

Status

Definition at line 395 of file LocalFileRestoreBatch.php.

References $status, and removeNonexistentFromCleanup().

cleanupFailedBatch()

LocalFileRestoreBatch::cleanupFailedBatch (   $storeStatus,   $storeBatch  )

protected

Cleanup a failed batch.

The batch was only partially successful, so rollback by removing all items that were successfully copied.

Parameters

Status	$storeStatus
array[]	$storeBatch

Definition at line 414 of file LocalFileRestoreBatch.php.

References $cleanupBatch, and $success.

Referenced by execute().

execute()

LocalFileRestoreBatch::execute

(

)

Run the transaction, except the cleanup batch.

The cleanup batch should be run in a separate transaction, because it locks different rows and there's no need to keep the image row locked while it's acquiring those locks The caller may have its own transaction open. So we save the batch and let the caller call cleanup()

Returns

Status

Definition at line 88 of file LocalFileRestoreBatch.php.

References $ids, $status, $wgLang, DeferredUpdates\addUpdate(), cleanupFailedBatch(), File\DELETED_FILE, SiteStatsUpdate\factory(), LocalRepo\getHashFromKey(), ArchivedFile\getQueryInfo(), User\newFromAnyId(), ActorMigration\newMigration(), FileRepo\OVERWRITE_SAME, removeNonexistentFiles(), RepoGroup\singleton(), wfDebug(), and wfTimestamp().

removeNonexistentFiles()

LocalFileRestoreBatch::removeNonexistentFiles (   $triplets )

protected

Removes non-existent files from a store batch.

Parameters

array

$triplets

Returns

Status

Definition at line 344 of file LocalFileRestoreBatch.php.

References $file, StatusValue\newFatal(), and StatusValue\newGood().

Referenced by execute().

removeNonexistentFromCleanup()

LocalFileRestoreBatch::removeNonexistentFromCleanup (   $batch )

protected

Removes non-existent files from a cleanup batch.

Parameters

string[]

$batch

Returns

string[]

Definition at line 370 of file LocalFileRestoreBatch.php.

References $file.

Referenced by cleanup().

Member Data Documentation

$all

bool LocalFileRestoreBatch::$all

private

Add all revisions of the file.

Definition at line 41 of file LocalFileRestoreBatch.php.

$cleanupBatch

string [] LocalFileRestoreBatch::$cleanupBatch

private

List of file IDs to restore.

Definition at line 35 of file LocalFileRestoreBatch.php.

Referenced by cleanupFailedBatch().

$file

LocalFile LocalFileRestoreBatch::$file

private

Definition at line 32 of file LocalFileRestoreBatch.php.

Referenced by __construct(), removeNonexistentFiles(), and removeNonexistentFromCleanup().

$ids

string [] LocalFileRestoreBatch::$ids

private

List of file IDs to restore.

Definition at line 38 of file LocalFileRestoreBatch.php.

Referenced by addIds(), and execute().

$unsuppress

bool LocalFileRestoreBatch::$unsuppress = false

private

Whether to remove all settings for suppressed fields.

Definition at line 44 of file LocalFileRestoreBatch.php.

Referenced by __construct().

---

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

• includes/filerepo/file/LocalFileRestoreBatch.php