MediaWiki  1.23.1
LocalFileMoveBatch Class Reference

Helper class for file movement. More...

Collaboration diagram for LocalFileMoveBatch:

Public Member Functions

 __construct (File $file, Title $target)
 
 addCurrent ()
 Add the current image to the batch. More...
 
 addOlds ()
 Add the old versions of the image to the batch. More...
 
 cleanupSource ( $triplets)
 Cleanup a fully moved array of triplets by deleting the source files. More...
 
 cleanupTarget ( $triplets)
 Cleanup a partially moved array of triplets by deleting the target files. More...
 
 doDBUpdates ()
 Do the database updates and return a new FileRepoStatus indicating how many rows where updated. More...
 
 execute ()
 Perform the move. More...
 
 getMoveTriplets ()
 Generate triplets for FileRepo::storeBatch(). More...
 
 removeNonexistentFiles ( $triplets)
 Removes non-existent files from move batch. More...
 

Protected Attributes

 $archive
 
 $cur
 
DatabaseBase $db
 
LocalFile $file
 
 $oldCount
 
 $olds
 
Title $target
 

Detailed Description

Helper class for file movement.

Definition at line 2590 of file LocalFile.php.

Constructor & Destructor Documentation

◆ __construct()

LocalFileMoveBatch::__construct ( File  $file,
Title  $target 
)
Parameters
File$file
Title$target

Definition at line 2609 of file LocalFile.php.

References $file, $target, file, and File\getRepo().

Member Function Documentation

◆ addCurrent()

LocalFileMoveBatch::addCurrent ( )

Add the current image to the batch.

Definition at line 2624 of file LocalFile.php.

References array().

◆ addOlds()

LocalFileMoveBatch::addOlds ( )

Add the old versions of the image to the batch.

Returns
array List of archive names from old versions

Definition at line 2632 of file LocalFile.php.

References $timestamp, array(), as, File\DELETED_FILE, list, and wfDebug().

◆ cleanupSource()

LocalFileMoveBatch::cleanupSource (   $triplets)

Cleanup a fully moved array of triplets by deleting the source files.

Called at the end of the move process if everything else went ok.

Definition at line 2853 of file LocalFile.php.

References $files, array(), as, and file.

Referenced by execute().

◆ cleanupTarget()

LocalFileMoveBatch::cleanupTarget (   $triplets)

Cleanup a partially moved array of triplets by deleting the target files.

Called if something went wrong half way.

Definition at line 2838 of file LocalFile.php.

References array(), as, and file.

Referenced by execute().

◆ doDBUpdates()

LocalFileMoveBatch::doDBUpdates ( )

Do the database updates and return a new FileRepoStatus indicating how many rows where updated.

Returns
FileRepoStatus

Definition at line 2739 of file LocalFile.php.

References $db, $oldCount, $total, array(), file, and DatabaseBase\update().

Referenced by execute().

◆ execute()

LocalFileMoveBatch::execute ( )

◆ getMoveTriplets()

LocalFileMoveBatch::getMoveTriplets ( )

Generate triplets for FileRepo::storeBatch().

Returns
array

Definition at line 2791 of file LocalFile.php.

References array(), as, file, and wfDebugLog().

Referenced by execute().

◆ removeNonexistentFiles()

LocalFileMoveBatch::removeNonexistentFiles (   $triplets)

Removes non-existent files from move batch.

Parameters
array$triplets
Returns
array

Definition at line 2813 of file LocalFile.php.

References $file, $files, array(), as, file, and wfDebugLog().

Referenced by execute().

Member Data Documentation

◆ $archive

LocalFileMoveBatch::$archive
protected

Definition at line 2601 of file LocalFile.php.

◆ $cur

LocalFileMoveBatch::$cur
protected

Definition at line 2595 of file LocalFile.php.

◆ $db

DatabaseBase LocalFileMoveBatch::$db
protected

Definition at line 2603 of file LocalFile.php.

Referenced by doDBUpdates().

◆ $file

LocalFile LocalFileMoveBatch::$file
protected

Definition at line 2591 of file LocalFile.php.

Referenced by __construct(), and removeNonexistentFiles().

◆ $oldCount

LocalFileMoveBatch::$oldCount
protected

Definition at line 2599 of file LocalFile.php.

Referenced by doDBUpdates().

◆ $olds

LocalFileMoveBatch::$olds
protected

Definition at line 2597 of file LocalFile.php.

◆ $target

Title LocalFileMoveBatch::$target
protected

Definition at line 2593 of file LocalFile.php.

Referenced by __construct().


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