MediaWiki REL1_28
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.
 
 doDBDeletes ()
 
 execute ()
 Run the transaction.
 

Protected Member Functions

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

Private Attributes

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

Detailed Description

Helper class for file deletion.

Definition at line 2072 of file LocalFile.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 2103 of file LocalFile.php.

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

Member Function Documentation

◆ addCurrent()

LocalFileDeleteBatch::addCurrent ( )

Definition at line 2116 of file LocalFile.php.

References file.

◆ addOld()

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

Definition at line 2123 of file LocalFile.php.

References file.

Referenced by addOlds().

◆ addOlds()

LocalFileDeleteBatch::addOlds ( )

Add the old versions of the image to the batch.

Returns
array List of archive names from old versions

Definition at line 2132 of file LocalFile.php.

References addOld(), as, and file.

◆ doDBDeletes()

LocalFileDeleteBatch::doDBDeletes ( )

Definition at line 2332 of file LocalFile.php.

References file, getOldRels(), and list.

Referenced by execute().

◆ doDBInserts()

LocalFileDeleteBatch::doDBInserts ( )
protected

◆ execute()

LocalFileDeleteBatch::execute ( )

Run the transaction.

Returns
Status

Definition at line 2353 of file LocalFile.php.

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

◆ getHashes()

LocalFileDeleteBatch::getHashes ( )
protected
Returns
array

Definition at line 2169 of file LocalFile.php.

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

Referenced by execute().

◆ getOldRels()

LocalFileDeleteBatch::getOldRels ( )
protected
Returns
array

Definition at line 2153 of file LocalFile.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 2413 of file LocalFile.php.

References $batch, $files, as, file, and list.

Referenced by execute().

Member Data Documentation

◆ $archiveUrls

array LocalFileDeleteBatch::$archiveUrls = []
private

Definition at line 2083 of file LocalFile.php.

◆ $deletionBatch

array LocalFileDeleteBatch::$deletionBatch
private

Items to be processed in the deletion batch.

Definition at line 2086 of file LocalFile.php.

◆ $file

LocalFile LocalFileDeleteBatch::$file
private

Definition at line 2074 of file LocalFile.php.

Referenced by __construct().

◆ $reason

string LocalFileDeleteBatch::$reason
private

Definition at line 2077 of file LocalFile.php.

Referenced by __construct(), and doDBInserts().

◆ $srcRels

array LocalFileDeleteBatch::$srcRels = []
private

Definition at line 2080 of file LocalFile.php.

Referenced by getOldRels().

◆ $status

FileRepoStatus LocalFileDeleteBatch::$status
private

Definition at line 2092 of file LocalFile.php.

Referenced by execute().

◆ $suppress

bool LocalFileDeleteBatch::$suppress
private

Whether to suppress all suppressable fields when deleting.

Definition at line 2089 of file LocalFile.php.

Referenced by __construct().

◆ $user

User LocalFileDeleteBatch::$user
private

Definition at line 2095 of file LocalFile.php.

Referenced by __construct().


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