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...
	execute ()
	Perform the move. More...

Protected Member Functions
	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 Status indicating how many rows where updated. More...
	getMoveTriplets ()
	Generate triplets for FileRepo::storeBatch(). More...
	removeNonexistentFiles ( $triplets)
	Removes non-existent files from move batch. More...
	verifyDBUpdates ()
	Verify the database updates and return a new Status indicating how many rows would be updated. More...

Protected Attributes
	$archive
	$cur
IDatabase	$db
LocalFile	$file
	$oldCount
	$olds
Title	$target

Detailed Description

Helper class for file movement.

Definition at line 2969 of file LocalFile.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

File	$file
Title	$target

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

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 3014 of file LocalFile.php.

References as, captcha-old\count, File\DELETED_FILE, list, and wfDebug().

cleanupSource()

LocalFileMoveBatch::cleanupSource (   $triplets )

protected

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 3272 of file LocalFile.php.

References as, and file.

Referenced by execute().

cleanupTarget()

LocalFileMoveBatch::cleanupTarget (   $triplets )

protected

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 3256 of file LocalFile.php.

References as, and file.

Referenced by execute().

doDBUpdates()

LocalFileMoveBatch::doDBUpdates ( )

protected

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

Definition at line 3177 of file LocalFile.php.

References $db, and Wikimedia\Rdbms\IDatabase\update().

Referenced by execute().

execute()

LocalFileMoveBatch::execute

(

)

Perform the move.

Returns

Status

Definition at line 3064 of file LocalFile.php.

References cleanupSource(), cleanupTarget(), doDBUpdates(), file, getMoveTriplets(), FileRepo\OVERWRITE_SAME, removeNonexistentFiles(), verifyDBUpdates(), wfDebugLog(), and wfLocalFile().

getMoveTriplets()

LocalFileMoveBatch::getMoveTriplets ( )

protected

Generate triplets for FileRepo::storeBatch().

Returns

array

Definition at line 3204 of file LocalFile.php.

References as, file, and wfDebugLog().

Referenced by execute().

removeNonexistentFiles()

LocalFileMoveBatch::removeNonexistentFiles (   $triplets )

protected

Removes non-existent files from move batch.

Parameters

array

$triplets

Returns

Status

Definition at line 3226 of file LocalFile.php.

References $file, as, file, StatusValue\newFatal(), StatusValue\newGood(), and wfDebugLog().

Referenced by execute().

verifyDBUpdates()

LocalFileMoveBatch::verifyDBUpdates ( )

protected

Verify the database updates and return a new Status indicating how many rows would be updated.

Returns

Status

Definition at line 3136 of file LocalFile.php.

References $db, file, and Wikimedia\Rdbms\IDatabase\selectField().

Referenced by execute().

Member Data Documentation

$archive

LocalFileMoveBatch::$archive

protected

Definition at line 2982 of file LocalFile.php.

$cur

LocalFileMoveBatch::$cur

protected

Definition at line 2976 of file LocalFile.php.

$db

IDatabase LocalFileMoveBatch::$db

protected

Definition at line 2985 of file LocalFile.php.

Referenced by doDBUpdates(), and verifyDBUpdates().

$file

LocalFile LocalFileMoveBatch::$file

protected

Definition at line 2971 of file LocalFile.php.

Referenced by __construct(), and removeNonexistentFiles().

$oldCount

LocalFileMoveBatch::$oldCount

protected

Definition at line 2980 of file LocalFile.php.

$olds

LocalFileMoveBatch::$olds

protected

Definition at line 2978 of file LocalFile.php.

$target

Title LocalFileMoveBatch::$target

protected

Definition at line 2974 of file LocalFile.php.

Referenced by __construct().

---

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

• includes/filerepo/file/LocalFile.php