Helper class for file undeletion. More...
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. | |
| execute () | |
| Run the transaction, except the cleanup batch. | |
Protected Member Functions | |
| cleanupFailedBatch ( $storeStatus, $storeBatch) | |
| Cleanup a failed batch. | |
| removeNonexistentFiles ( $triplets) | |
| Removes non-existent files from a store batch. | |
| removeNonexistentFromCleanup ( $batch) | |
| Removes non-existent files from a cleanup batch. | |
Private Attributes | |
| bool | $all |
| Add all revisions of the file. | |
| string[] | $cleanupBatch |
| List of file IDs to restore. | |
| LocalFile | $file |
| string[] | $ids |
| List of file IDs to restore. | |
| bool | $unsuppress = false |
| Whether to remove all settings for suppressed fields. | |
Detailed Description
Helper class for file undeletion.
Definition at line 2760 of file LocalFile.php.
Constructor & Destructor Documentation
◆ __construct()
| LocalFileRestoreBatch::__construct | ( | File | $file, |
$unsuppress = false |
|||
| ) |
- Parameters
-
File $file bool $unsuppress
Definition at line 2780 of file LocalFile.php.
References $file, $unsuppress, and file.
Member Function Documentation
◆ addAll()
| LocalFileRestoreBatch::addAll | ( | ) |
Add all revisions of the file.
Definition at line 2806 of file LocalFile.php.
◆ addId()
| LocalFileRestoreBatch::addId | ( | $fa_id | ) |
◆ addIds()
| LocalFileRestoreBatch::addIds | ( | $ids | ) |
Add a whole lot of files by ID.
- Parameters
-
int[] $ids
Definition at line 2799 of file LocalFile.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 3125 of file LocalFile.php.
References file, and removeNonexistentFromCleanup().
◆ cleanupFailedBatch()
|
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 3144 of file LocalFile.php.
References $cleanupBatch, $success, as, and file.
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 2818 of file LocalFile.php.
References $ids, $user, $wgLang, as, cleanupFailedBatch(), File\DELETED_FILE, file, LocalRepo\getHashFromKey(), ArchivedFile\getQueryInfo(), User\newFromAnyId(), FileRepo\OVERWRITE_SAME, removeNonexistentFiles(), RepoGroup\singleton(), wfDebug(), and wfTimestamp().
◆ removeNonexistentFiles()
|
protected |
◆ removeNonexistentFromCleanup()
|
protected |
Member Data Documentation
◆ $all
|
private |
Add all revisions of the file.
Definition at line 2771 of file LocalFile.php.
◆ $cleanupBatch
|
private |
List of file IDs to restore.
Definition at line 2765 of file LocalFile.php.
Referenced by cleanupFailedBatch().
◆ $file
|
private |
Definition at line 2762 of file LocalFile.php.
Referenced by __construct(), removeNonexistentFiles(), and removeNonexistentFromCleanup().
◆ $ids
|
private |
List of file IDs to restore.
Definition at line 2768 of file LocalFile.php.
◆ $unsuppress
|
private |
Whether to remove all settings for suppressed fields.
Definition at line 2774 of file LocalFile.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- includes/filerepo/file/LocalFile.php
