/** @var bool Does the file exist on disk? (loadFromXxx) */
protected $fileExists;
- /** @var int image width */
+ /** @var int Image width */
protected $width;
- /** @var int image height */
+ /** @var int Image height */
protected $height;
/** @var int Returned by getimagesize (loadFromXxx) */
/** @var int Result of the query for the file's history (nextHistoryLine) */
private $historyRes;
- /** @var string Major mime type */
+ /** @var string Major MIME type */
private $major_mime;
- /** @var string Minor mime type */
+ /** @var string Minor MIME type */
private $minor_mime;
/** @var string Upload timestamp */
* Create a LocalFile from a SHA-1 key
* Do not call this except from inside a repo class.
*
- * @param string $sha1 base-36 SHA-1
+ * @param string $sha1 Base-36 SHA-1
* @param LocalRepo $repo
* @param string|bool $timestamp MW_timestamp (optional)
* @return bool|LocalFile
/**
* Load file metadata from the DB
+ * @param int $flags
*/
function loadFromDB( $flags = 0 ) {
# Polymorphic function name to distinguish foreign and local fetches
/**
* @param DatabaseBase $dbr
* @param string $fname
- * @return array|false
+ * @return array|bool
*/
private function loadFieldsWithTimestamp( $dbr, $fname ) {
$fieldMap = false;
}
/**
- * Returns the mime type of the file.
+ * Returns the MIME type of the file.
* @return string
*/
function getMimeType() {
/**
* Get all thumbnail names previously generated for this file
* @param string|bool $archiveName Name of an archive file, default false
- * @return array first element is the base dir, then files in that base dir.
+ * @return array First element is the base dir, then files in that base dir.
*/
function getThumbnails( $archiveName = false ) {
if ( $archiveName ) {
/**
* Delete cached transformed files for the current version only.
+ * @param array $options
*/
function purgeThumbnails( $options = array() ) {
global $wgUseSquid;
# Fail now if the file isn't there
if ( !$this->fileExists ) {
wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
+ $dbw->rollback( __METHOD__ );
wfProfileOut( __METHOD__ );
return false;
* Start a transaction and lock the image for update
* Increments a reference counter if the lock is already held
* @throws MWException Throws an error if the lock was not acquired
- * @return bool success
+ * @return bool Success
*/
function lock() {
$dbw = $this->repo->getMasterDB();
/**
* Add a file by ID
+ * @param int $fa_id
*/
function addId( $fa_id ) {
$this->ids[] = $fa_id;
/**
* Add a whole lot of files by ID
+ * @param int[] $ids
*/
function addIds( $ids ) {
$this->ids = array_merge( $this->ids, $ids );
/**
* Cleanup a partially moved array of triplets by deleting the target
* files. Called if something went wrong half way.
+ * @param array $triplets
*/
function cleanupTarget( $triplets ) {
// Create dest pairs from the 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.
+ * @param array $triplets
*/
function cleanupSource( $triplets ) {
// Create source file names from the triplets