MediaWiki  REL1_24
Public Member Functions | Protected Attributes
LocalFileMoveBatch Class Reference
File abstraction

Helper class for file movement. More...

Collaboration diagram for LocalFileMoveBatch:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Protected Attributes

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

Detailed Description

Helper class for file movement.

Definition at line 2706 of file LocalFile.php.

Constructor & Destructor Documentation

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

Definition at line 2725 of file LocalFile.php.

Member Function Documentation

LocalFileMoveBatch::addCurrent ( )

Add the current image to the batch.

Definition at line 2740 of file LocalFile.php.

References $file.

LocalFileMoveBatch::addOlds ( )

Add the old versions of the image to the batch.

Returns:
array List of archive names from old versions

Definition at line 2748 of file LocalFile.php.

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

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.

Parameters:
array$triplets

Definition at line 2983 of file LocalFile.php.

LocalFileMoveBatch::cleanupTarget ( $  triplets)

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

Called if something went wrong half way.

Parameters:
array$triplets

Definition at line 2967 of file LocalFile.php.

LocalFileMoveBatch::doDBUpdates ( )

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

Returns:
FileRepoStatus

Definition at line 2863 of file LocalFile.php.

LocalFileMoveBatch::execute ( )

Perform the move.

Returns:
FileRepoStatus

Definition at line 2798 of file LocalFile.php.

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

LocalFileMoveBatch::getMoveTriplets ( )

Generate triplets for FileRepo::storeBatch().

Returns:
array

Definition at line 2915 of file LocalFile.php.

LocalFileMoveBatch::removeNonexistentFiles ( $  triplets)

Removes non-existent files from move batch.

Parameters:
array$triplets
Returns:
Status

Definition at line 2937 of file LocalFile.php.

Member Data Documentation

LocalFileMoveBatch::$archive [protected]

Definition at line 2717 of file LocalFile.php.

LocalFileMoveBatch::$cur [protected]

Definition at line 2711 of file LocalFile.php.

DatabaseBase LocalFileMoveBatch::$db [protected]

*

Definition at line 2719 of file LocalFile.php.

LocalFile LocalFileMoveBatch::$file [protected]

*

Definition at line 2707 of file LocalFile.php.

Referenced by addCurrent(), and addOlds().

LocalFileMoveBatch::$oldCount [protected]

Definition at line 2715 of file LocalFile.php.

LocalFileMoveBatch::$olds [protected]

Definition at line 2713 of file LocalFile.php.

Title LocalFileMoveBatch::$target [protected]

*

Definition at line 2709 of file LocalFile.php.

Referenced by addOlds().

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