MediaWiki  master
LocalFileDeleteBatch Class Reference

Helper class for file deletion. More...

Collaboration diagram for LocalFileDeleteBatch:

Public Member Functions

 __construct (File $file, $reason='', $suppress=false, $user=null)
 
 addCurrent ()
 
 addOld ( $oldName)
 
 addOlds ()
 Add the old versions of the image to the batch. More...
 
 doDBDeletes ()
 
 execute ()
 Run the transaction. More...
 

Protected Member Functions

 doDBInserts ()
 
 getHashes ()
 
 getOldRels ()
 
 removeNonexistentFiles ( $batch)
 Removes non-existent files from a deletion batch. More...
 

Private Attributes

array $archiveUrls = []
 
array $deletionBatch
 Items to be processed in the deletion batch. More...
 
LocalFile $file
 
string $reason
 
array $srcRels = []
 
Status $status
 
bool $suppress
 Whether to suppress all suppressable fields when deleting. More...
 
User $user
 

Detailed Description

Helper class for file deletion.

Definition at line 30 of file LocalFileDeleteBatch.php.

Constructor & Destructor Documentation

◆ __construct()

LocalFileDeleteBatch::__construct ( File  $file,
  $reason = '',
  $suppress = false,
  $user = null 
)
Parameters
File$file
string$reason
bool$suppress
User | null$user

Definition at line 61 of file LocalFileDeleteBatch.php.

References $file, $reason, $suppress, file, and user.

Member Function Documentation

◆ addCurrent()

LocalFileDeleteBatch::addCurrent ( )

Definition at line 70 of file LocalFileDeleteBatch.php.

References file.

◆ addOld()

LocalFileDeleteBatch::addOld (   $oldName)
Parameters
string$oldName

Definition at line 77 of file LocalFileDeleteBatch.php.

References file.

Referenced by addOlds().

◆ addOlds()

LocalFileDeleteBatch::addOlds ( )

Add the old versions of the image to the batch.

Returns
string[] List of archive names from old versions

Definition at line 86 of file LocalFileDeleteBatch.php.

References addOld(), as, and file.

◆ doDBDeletes()

LocalFileDeleteBatch::doDBDeletes ( )

Definition at line 322 of file LocalFileDeleteBatch.php.

References file, getOldRels(), and list.

Referenced by execute().

◆ doDBInserts()

◆ execute()

LocalFileDeleteBatch::execute ( )

Run the transaction.

Returns
Status

Definition at line 343 of file LocalFileDeleteBatch.php.

References $ext, $hashes, $name, $status, as, doDBDeletes(), doDBInserts(), file, getHashes(), StatusValue\isGood(), and removeNonexistentFiles().

◆ getHashes()

LocalFileDeleteBatch::getHashes ( )
protected
Returns
array

Definition at line 123 of file LocalFileDeleteBatch.php.

References $hashes, $name, $res, as, file, getOldRels(), and list.

Referenced by execute().

◆ getOldRels()

LocalFileDeleteBatch::getOldRels ( )
protected
Returns
array

Definition at line 107 of file LocalFileDeleteBatch.php.

References $srcRels.

Referenced by doDBDeletes(), doDBInserts(), and getHashes().

◆ removeNonexistentFiles()

LocalFileDeleteBatch::removeNonexistentFiles (   $batch)
protected

Removes non-existent files from a deletion batch.

Parameters
array$batch
Returns
Status

Definition at line 403 of file LocalFileDeleteBatch.php.

References $batch, as, file, list, StatusValue\newFatal(), StatusValue\newGood(), and null.

Referenced by execute().

Member Data Documentation

◆ $archiveUrls

array LocalFileDeleteBatch::$archiveUrls = []
private

Definition at line 41 of file LocalFileDeleteBatch.php.

◆ $deletionBatch

array LocalFileDeleteBatch::$deletionBatch
private

Items to be processed in the deletion batch.

Definition at line 44 of file LocalFileDeleteBatch.php.

◆ $file

LocalFile LocalFileDeleteBatch::$file
private

Definition at line 32 of file LocalFileDeleteBatch.php.

Referenced by __construct().

◆ $reason

string LocalFileDeleteBatch::$reason
private

Definition at line 35 of file LocalFileDeleteBatch.php.

Referenced by __construct().

◆ $srcRels

array LocalFileDeleteBatch::$srcRels = []
private

Definition at line 38 of file LocalFileDeleteBatch.php.

Referenced by getOldRels().

◆ $status

Status LocalFileDeleteBatch::$status
private

Definition at line 50 of file LocalFileDeleteBatch.php.

Referenced by execute().

◆ $suppress

bool LocalFileDeleteBatch::$suppress
private

Whether to suppress all suppressable fields when deleting.

Definition at line 47 of file LocalFileDeleteBatch.php.

Referenced by __construct().

◆ $user

User LocalFileDeleteBatch::$user
private

Definition at line 53 of file LocalFileDeleteBatch.php.


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