LocalFileRestoreBatch Class Reference

Helper class for file undeletion. More...

Collaboration diagram for LocalFileRestoreBatch:

List of all members.

Public Member Functions
	__construct (File $file, $unsuppress=false)
	addAll ()
	Add all revisions of the file.
	addId ($fa_id)
	Add a file by ID.
	addIds ($ids)
	Add a whole lot of files by ID.
	cleanup ()
	Delete unused files in the deleted zone.
	cleanupFailedBatch ($storeStatus, $storeBatch)
	Cleanup a failed batch.
	execute ()
	Run the transaction, except the cleanup batch.
	removeNonexistentFiles ($triplets)
	Removes non-existent files from a store batch.
	removeNonexistentFromCleanup ($batch)
	Removes non-existent files from a cleanup batch.
Public Attributes
	$all
	$cleanupBatch
LocalFile	$file
	$ids
	$unsuppress = false

---

Detailed Description

Helper class for file undeletion.

Definition at line 1942 of file LocalFile.php.

---

Constructor & Destructor Documentation

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

Parameters:

$file	File
$unsuppress	bool

Definition at line 1953 of file LocalFile.php.

---

Member Function Documentation

LocalFileRestoreBatch::addAll

(

)

Add all revisions of the file.

Definition at line 1977 of file LocalFile.php.

LocalFileRestoreBatch::addId

(

$

fa_id

)

Add a file by ID.

Definition at line 1963 of file LocalFile.php.

LocalFileRestoreBatch::addIds

(

$

ids

)

Add a whole lot of files by ID.

Definition at line 1970 of file LocalFile.php.

LocalFileRestoreBatch::cleanup

(

)

Delete unused files in the deleted zone.

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

Returns:

FileRepoStatus|void

Definition at line 2263 of file LocalFile.php.

LocalFileRestoreBatch::cleanupFailedBatch	(	$	storeStatus,
		$	storeBatch
	)

Cleanup a failed batch.

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

Parameters:

Status	$storeStatus
array	$storeBatch

Definition at line 2282 of file LocalFile.php.

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:

FileRepoStatus

Definition at line 1989 of file LocalFile.php.

LocalFileRestoreBatch::removeNonexistentFiles

(

$

triplets

)

Removes non-existent files from a store batch.

Parameters:

$triplets

array

Returns:

array

Definition at line 2216 of file LocalFile.php.

LocalFileRestoreBatch::removeNonexistentFromCleanup

(

$

batch

)

Removes non-existent files from a cleanup batch.

Parameters:

$batch

array

Returns:

array

Definition at line 2238 of file LocalFile.php.

---

Member Data Documentation

LocalFileRestoreBatch::$all

Definition at line 1947 of file LocalFile.php.

LocalFileRestoreBatch::$cleanupBatch

Definition at line 1947 of file LocalFile.php.

LocalFile LocalFileRestoreBatch::$file

Definition at line 1945 of file LocalFile.php.

LocalFileRestoreBatch::$ids

Definition at line 1947 of file LocalFile.php.

LocalFileRestoreBatch::$unsuppress = false

Definition at line 1947 of file LocalFile.php.

---

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

• includes/filerepo/file/LocalFile.php