$this->setProps( $props );
}
+ /**
+ * @param $prefix string
+ * @return array
+ */
function getCacheFields( $prefix = 'img_' ) {
static $fields = array( 'size', 'width', 'height', 'bits', 'media_type',
'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user', 'user_text', 'description' );
/**
* Decode a row from the database (either object or array) to an array
* with timestamps and MIME types decoded, and the field prefix removed.
+ * @param $row
+ * @param $prefix string
+ * @throws MWException
* @return array
*/
function decodeRow( $row, $prefix = 'img_' ) {
/** getPath inherited */
/** isVisible inhereted */
+ /**
+ * @return bool
+ */
function isMissing() {
if ( $this->missing === null ) {
list( $fileExists ) = $this->repo->fileExists( $this->getVirtualUrl() );
/**
* Return the width of the image
*
- * Returns false on error
- * @return bool
+ * @param $page int
+ * @return bool|int Returns false on error
*/
public function getWidth( $page = 1 ) {
$this->load();
/**
* Return the height of the image
*
- * Returns false on error
- * @return bool
+ * @param $page int
+ * @return bool|int Returns false on error
*/
public function getHeight( $page = 1 ) {
$this->load();
* Returns ID or name of user who uploaded the file
*
* @param $type string 'text' or 'id'
+ * @return int|string
*/
function getUser( $type = 'text' ) {
$this->load();
return $this->metadata;
}
+ /**
+ * @return int
+ */
function getBitDepth() {
$this->load();
return $this->bits;
/**
* Return the size of the image file, in bytes
+ * @return int
*/
public function getSize() {
$this->load();
/**
* Returns the mime type of the file.
+ * @return string
*/
function getMimeType() {
$this->load();
/**
* Return the type of the media in the file.
* Use the value returned by this function with the MEDIATYPE_xxx constants.
+ * @return string
*/
function getMediaType() {
$this->load();
/** purgeDescription inherited */
/** purgeEverything inherited */
+ /**
+ * @param $limit null
+ * @param $start null
+ * @param $end null
+ * @param $inc bool
+ * @return array
+ */
function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
$dbr = $this->repo->getSlaveDB();
$tables = array( 'oldimage' );
* @param $comment String: upload description
* @param $pageText String: text to use for the new description page,
* if a new description page is created
- * @param $flags Integer: flags for publish()
- * @param $props Array: File properties, if known. This can be used to reduce the
+ * @param $flags Integer|bool: flags for publish()
+ * @param $props Array|bool: File properties, if known. This can be used to reduce the
* upload time when uploading virtual URLs for which the file info
* is already known
- * @param $timestamp String: timestamp for img_timestamp, or false to use the current time
- * @param $user Mixed: User object or null to use $wgUser
+ * @param $timestamp String|bool: timestamp for img_timestamp, or false to use the current time
+ * @param $user User|null: User object or null to use $wgUser
*
* @return FileRepoStatus object. On success, the value member contains the
* archive name, or an empty string if it was a new file.
/**
* Record a file upload in the upload log and the image table
+ * @param $oldver
+ * @param $desc string
+ * @param $license string
+ * @param $copyStatus string
+ * @param $source string
+ * @param $watch bool
+ * @param $timestamp string|bool
* @return bool
*/
function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
/**
* Record a file upload in the upload log and the image table
+ * @param $oldver
+ * @param $comment string
+ * @param $pageText string
+ * @param $props bool|array
+ * @param $timestamp bool|string
+ * @param $user null|User
* @return bool
*/
function recordUpload2(
return $pout->getText();
}
+ /**
+ * @return string
+ */
function getDescription() {
$this->load();
return $this->description;
}
+ /**
+ * @return bool|string
+ */
function getTimestamp() {
$this->load();
return $this->timestamp;
}
+ /**
+ * @return string
+ */
function getSha1() {
$this->load();
// Initialise now if necessary
return $this->sha1;
}
+ /**
+ * @return bool
+ */
function isCacheable() {
$this->load();
return strlen( $this->metadata ) <= self::CACHE_FIELD_MAX_LEN; // avoid OOMs
var $reason, $srcRels = array(), $archiveUrls = array(), $deletionBatch, $suppress;
var $status;
+ /**
+ * @param $file File
+ * @param $reason string
+ * @param $suppress bool
+ */
function __construct( File $file, $reason = '', $suppress = false ) {
$this->file = $file;
$this->reason = $reason;
$this->srcRels['.'] = $this->file->getRel();
}
+ /**
+ * @param $oldName string
+ */
function addOld( $oldName ) {
$this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
$this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
return $archiveNames;
}
+ /**
+ * @return array
+ */
function getOldRels() {
if ( !isset( $this->srcRels['.'] ) ) {
$oldRels =& $this->srcRels;
return array( $oldRels, $deleteCurrent );
}
+ /**
+ * @return array
+ */
protected function getHashes() {
$hashes = array();
list( $oldRels, $deleteCurrent ) = $this->getOldRels();
/**
* Removes non-existent files from a deletion batch.
+ * @param $batch array
* @return array
*/
function removeNonexistentFiles( $batch ) {
var $cleanupBatch, $ids, $all, $unsuppress = false;
+ /**
+ * @param $file File
+ * @param $unsuppress bool
+ */
function __construct( File $file, $unsuppress = false ) {
$this->file = $file;
$this->cleanupBatch = $this->ids = array();
/**
* Removes non-existent files from a store batch.
+ * @param $triplets array
* @return array
*/
function removeNonexistentFiles( $triplets ) {
$files = $filteredTriplets = array();
- foreach ( $triplets as $file )
+ foreach ( $triplets as $file ) {
$files[$file[0]] = $file[0];
+ }
$result = $this->file->repo->fileExistsBatch( $files );
/**
* Removes non-existent files from a cleanup batch.
+ * @param $batch array
* @return array
*/
function removeNonexistentFromCleanup( $batch ) {
*/
var $target;
- var $cur, $olds, $oldCount, $archive, $db;
+ var $cur, $olds, $oldCount, $archive;
+ /**
+ * @var DatabaseBase
+ */
+ var $db;
+
+ /**
+ * @param File $file
+ * @param Title $target
+ */
function __construct( File $file, Title $target ) {
$this->file = $file;
$this->target = $target;
$this->newName = $this->file->repo->getNameFromTitle( $this->target );
$this->oldRel = $this->oldHash . $this->oldName;
$this->newRel = $this->newHash . $this->newName;
- $this->db = $file->repo->getMasterDb();
+ $this->db = $file->getRepo()->getMasterDb();
}
/**
/**
* Removes non-existent files from move batch.
+ * @param $triplets array
* @return array
*/
function removeNonexistentFiles( $triplets ) {