Class to represent a local file in the wiki's own database. More...

Inheritance diagram for LocalFile:

[legend]

Collaboration diagram for LocalFile:

[legend]

Public Member Functions
	__construct ( $title, $repo)
	Do not call this except from inside a repo class. More...

	__destruct ()
	Clean up any dangling locks. More...

	acquireFileLock ()

	decodeRow ( $row, $prefix='img_')
	Decode a row from the database (either object or array) to an array with timestamps and MIME types decoded, and the field prefix removed. More...

	delete ( $reason, $suppress=false, $user=null)
	Delete all versions of the file. More...

	deleteOld ( $archiveName, $reason, $suppress=false, $user=null)
	Delete an old version of the file. More...

	exists ()
	canRender inherited More...

	getBitDepth ()

	getCacheKey ()
	Get the memcached key for the main data for this file, or false if there is no access to the shared cache. More...

	getDescription ( $audience=self::FOR_PUBLIC, User $user=null)

	getDescriptionShortUrl ()
	Get short description URL for a file based on the page ID. More...

	getDescriptionText (Language $lang=null)
	Get the HTML text of the description page This is not used by ImagePage for local files, since (among other things) it skips the parser cache. More...

	getDescriptionTouched ()

	getDescriptionUrl ()
	isMultipage inherited More...

	getHeight ( $page=1)
	Return the height of the image. More...

	getHistory ( $limit=null, $start=null, $end=null, $inc=true)
	purgeDescription inherited More...

	getMediaType ()
	Returns the type of the media in the file. More...

	getMetadata ()
	Get handler-specific metadata. More...

	getMimeType ()
	Returns the MIME type of the file. More...

	getMutableCacheKeys (WANObjectCache $cache)

	getSha1 ()

	getSize ()
	Returns the size of the image file, in bytes. More...

	getThumbnails ( $archiveName=false)
	getTransformScript inherited More...

	getTimestamp ()

	getUpgraded ()

	getUser ( $type='text')
	Returns user who uploaded the file. More...

	getWidth ( $page=1)
	Return the width of the image. More...

	invalidateCache ()
	Purge the file object/metadata cache. More...

	isCacheable ()

	isMissing ()
	splitMime inherited More...

	load ( $flags=0)
	Load file metadata from cache or DB, unless already loaded. More...

	loadFromDB ( $flags=0)
	Load file metadata from the DB. More...

	loadFromFile ()
	Load metadata from the file itself. More...

	loadFromRow ( $row, $prefix='img_')
	Load file metadata from a DB result row. More...

	lock ()
	Start an atomic DB section and lock the image for update or increments a reference counter if the lock is already held. More...

	move ( $target)
	getLinksTo inherited More...

	nextHistoryLine ()
	Returns the history of this file, line by line. More...

	prerenderThumbnails ()
	Prerenders a configurable set of thumbnails. More...

	publish ( $src, $flags=0, array $options=[])
	Move or copy a file to its public location. More...

	publishTo ( $src, $dstRel, $flags=0, array $options=[])
	Move or copy a file to a specified location. More...

	purgeCache ( $options=[])
	Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN. More...

	purgeMetadataCache ()
	Refresh metadata in memcached, but don't touch thumbnails or CDN. More...

	purgeOldThumbnails ( $archiveName)
	Delete cached transformed files for an archived version only. More...

	purgeThumbnails ( $options=[])
	Delete cached transformed files for the current version only. More...

	recordUpload ( $oldver, $desc, $license='', $copyStatus='', $source='', $watch=false, $timestamp=false, User $user=null)
	Record a file upload in the upload log and the image table. More...

	recordUpload2 ( $oldver, $comment, $pageText, $props=false, $timestamp=false, $user=null, $tags=[], $createNullRevision=true, $revert=false)
	Record a file upload in the upload log and the image table. More...

	releaseFileLock ()

	resetHistory ()
	Reset the history pointer to the first element of the history. More...

	restore ( $versions=[], $unsuppress=false)
	Restore all or specified deleted revisions to the given file. More...

	setProps ( $info)
	Set properties in this object to be equal to those given in the associative array $info. More...

	unlock ()
	Decrement the lock reference count and end the atomic section if it reaches zero. More...

	upgradeRow ()
	Fix assorted version-related problems with the image row by reloading it from the file. More...

	upload ( $src, $comment, $pageText, $flags=0, $props=false, $timestamp=false, $user=null, $tags=[], $createNullRevision=true, $revert=false)
	getHashPath inherited More...

Public Member Functions inherited from File
	__get ( $name)

	allowInlineDisplay ()
	Alias for canRender() More...

	canAnimateThumbIfAppropriate ()
	Will the thumbnail be animated if one would expect it to be. More...

	canRender ()
	Checks if the output of transform() for this file is likely to be valid. More...

	convertMetadataVersion ( $metadata, $version)
	get versioned metadata More...

	createThumb ( $width, $height=-1)
	Create a thumbnail of the image having the specified width/height. More...

	formatMetadata ( $context=false)

	generateAndSaveThumb ( $tmpFile, $transformParams, $flags)
	Generates a thumbnail according to the given parameters and saves it to storage. More...

	generateThumbName ( $name, $params)
	Generate a thumbnail file name from a name and specified parameters. More...

	getArchivePath ( $suffix=false)
	Get the path of the archived file. More...

	getArchiveRel ( $suffix=false)
	Get the path of an archived file relative to the public zone root. More...

	getArchiveThumbPath ( $archiveName, $suffix=false)
	Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified. More...

	getArchiveThumbRel ( $archiveName, $suffix=false)
	Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory or a specific thumb if the $suffix is given. More...

	getArchiveThumbUrl ( $archiveName, $suffix=false)
	Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified. More...

	getArchiveUrl ( $suffix=false)
	Get the URL of the archive directory, or a particular file if $suffix is specified. More...

	getArchiveVirtualUrl ( $suffix=false)
	Get the public zone virtual URL for an archived version source file. More...

	getAvailableLanguages ()
	Gives a (possibly empty) list of languages to render the file in. More...

	getCanonicalUrl ()

	getCommonMetaArray ()
	Like getMetadata but returns a handler independent array of common values. More...

	getContentHeaders ()

	getDefaultRenderLanguage ()
	In files that support multiple language, what is the default language to use if none specified. More...

	getDimensionsString ()

	getExtension ()
	Get the file extension, e.g. More...

	getFullUrl ()
	Return a fully-qualified URL to the file. More...

	getHandler ()
	Get a MediaHandler instance for this file. More...

	getHashPath ()
	Get the filename hash component of the directory including trailing slash, e.g. More...

	getImageSize ( $filePath)
	Get an image size array like that returned by getImageSize(), or false if it can't be determined. More...

	getLastError ()
	Get last thumbnailing error. More...

	getLength ()
	Get the duration of a media file in seconds. More...

	getLocalRefPath ()
	Get an FS copy or original of this file and return the path. More...

	getLongDesc ()

	getMatchedLanguage ( $userPreferredLanguage)
	Get the language code from the available languages for this file that matches the language requested by the user. More...

	getName ()
	Return the name of this file. More...

	getOriginalTitle ()
	Return the title used to find this file. More...

	getPath ()
	Return the storage path to the file. More...

	getRedirected ()

	getRedirectedTitle ()

	getRel ()
	Get the path of the file relative to the public zone root. More...

	getRepo ()
	Returns the repository. More...

	getRepoName ()
	Returns the name of the repository. More...

	getShortDesc ()

	getStorageKey ()
	Get the deletion archive key, "<sha1>.<ext>". More...

	getThumbDisposition ( $thumbName, $dispositionType='inline')

	getThumbnailBucket ( $desiredWidth, $page=1)
	Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistance larger than $desiredWidth. More...

	getThumbnails ()
	Get all thumbnail names previously generated for this file STUB Overridden by LocalFile. More...

	getThumbnailSource ( $params)
	Returns the most appropriate source image for the thumbnail, given a target thumbnail size. More...

	getThumbPath ( $suffix=false)
	Get the path of the thumbnail directory, or a particular file if $suffix is specified. More...

	getThumbRel ( $suffix=false)
	Get the path, relative to the thumbnail zone root, of the thumbnail directory or a particular file if $suffix is specified. More...

	getThumbUrl ( $suffix=false)
	Get the URL of the thumbnail directory, or a particular file if $suffix is specified. More...

	getThumbVirtualUrl ( $suffix=false)
	Get the virtual URL for a thumbnail file or directory. More...

	getTitle ()
	Return the associated title object. More...

	getTranscodedPath ( $suffix=false)
	Get the path of the transcoded directory, or a particular file if $suffix is specified. More...

	getTranscodedUrl ( $suffix=false)
	Get the URL of the transcoded directory, or a particular file if $suffix is specified. More...

	getTransformScript ()

	getUnscaledThumb ( $handlerParams=[])
	Get a ThumbnailImage which is the same size as the source. More...

	getUrl ()
	Return the URL of the file. More...

	getUrlRel ()
	Get urlencoded path of the file relative to the public zone root. More...

	getViewURL ()

	getVirtualUrl ( $suffix=false)
	Get the public zone virtual URL for a current version source file. More...

	getVisibility ()
	Return the deletion bitfield STUB. More...

	getZoneUrl ( $zone, $suffix=false)
	Get the URL of the zone directory, or a particular file if $suffix is specified. More...

	iconThumb ()
	Get a ThumbnailImage representing a file type icon. More...

	isDeleted ( $field)
	Is this file a "deleted" file in a private archive? STUB. More...

	isExpensiveToThumbnail ()
	True if creating thumbnails from the file is large or otherwise resource-intensive. More...

	isHashed ()

	isLocal ()
	Returns true if the file comes from the local file repository. More...

	isMultipage ()
	Returns 'true' if this file is a type which supports multiple pages, e.g. More...

	isOld ()
	Returns true if the image is an old version STUB. More...

	isSafeFile ()
	Determines if this media file is in a format that is unlikely to contain viruses or malicious content. More...

	isTransformedLocally ()
	Whether the thumbnails created on the same server as this code is running. More...

	isTrustedFile ()
	Returns true if the file is flagged as trusted. More...

	isVectorized ()
	Return true if the file is vectorized. More...

	isVisible ()
	Returns true if file exists in the repository and can be included in a page. More...

	migrateThumbFile ( $thumbName)
	Hook into transform() to allow migration of thumbnail files STUB Overridden by LocalFile. More...

	mustRender ()
	Return true if the file is of a type that can't be directly rendered by typical browsers and needs to be re-rasterized. More...

	pageCount ()
	Returns the number of pages of a multipage document, or false for documents which aren't multipage documents. More...

	purgeDescription ()
	Purge the file description page, but don't go after pages using the file. More...

	purgeEverything ()
	Purge metadata and all affected pages when the file is created, deleted, or majorly updated. More...

	readOnlyError ()

	redirectedFrom ( $from)

	thumbName ( $params, $flags=0)
	Return the file name of a thumbnail with the specified parameters. More...

	transform ( $params, $flags=0)
	Transform a media file. More...

	userCan ( $field, User $user=null)
	Determine if the current user is allowed to view a particular field of this file, if it's marked as deleted. More...

	wasDeleted ()
	Was this file ever deleted from the wiki? More...

Static Public Member Functions
static	getQueryInfo (array $options=[])
	Return the tables, fields, and join conditions to be selected to create a new localfile object. More...

static	newFromKey ( $sha1, $repo, $timestamp=false)
	Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class. More...

static	newFromRow ( $row, $repo)
	Create a LocalFile from a title Do not call this except from inside a repo class. More...

static	newFromTitle ( $title, $repo, $unused=null)
	Create a LocalFile from a title Do not call this except from inside a repo class. More...

Static Public Member Functions inherited from File
static	checkExtensionCompatibility (File $old, $new)
	Checks if file extensions are compatible. More...

static	compare (File $a, File $b)
	Callback for usort() to do file sorts by name. More...

static	normalizeExtension ( $extension)
	Normalize a file extension to the common form, making it lowercase and checking some synonyms, and ensure it's clean. More...

static	normalizeTitle ( $title, $exception=false)
	Given a string or Title object return either a valid Title object with namespace NS_FILE or null. More...

static	scaleHeight ( $srcWidth, $srcHeight, $dstWidth)
	Calculate the height of a thumbnail using the source and destination width. More...

static	splitMime ( $mime)
	Split an internet media type into its two components; if not a two-part name, set the minor type to 'unknown'. More...

Public Attributes
const	ATOMIC_SECTION_LOCK = 'LocalFile::lockingTransaction'

const	CACHE_FIELD_MAX_LEN = 1000

const	LOAD_ALL = 16

const	VERSION = 11

Public Attributes inherited from File
FileRepo LocalRepo ForeignAPIRepo bool	$repo
	Some member variables can be lazy-initialised using __get(). More...

const	DELETE_SOURCE = 1

const	DELETED_COMMENT = 2

const	DELETED_FILE = 1

const	DELETED_RESTRICTED = 8

const	DELETED_USER = 4

const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

const	RAW = 3

const	RENDER_FORCE = 2
	Force rendering even if thumbnail already exist and using RENDER_NOW I.e. More...

const	RENDER_NOW = 1
	Force rendering in the current process. More...

const	THUMB_FULL_NAME = 1

Public Attributes inherited from IDBAccessObject
const	READ_LOCKING = self::READ_LATEST \| 2
	Constants for object loading bitfield flags (higher => higher QoS) More...

const	READ_NONE = -1

Protected Member Functions
	getCacheFields ( $prefix='img_')
	Returns the list of object properties that are included as-is in the cache. More...

	getLazyCacheFields ( $prefix='img_')
	Returns the list of object properties that are included as-is in the cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB(). More...

	loadExtraFromDB ()
	Load lazy file metadata from the DB. More...

	maybeUpgradeRow ()
	Upgrade a row if it needs it. More...

	purgeThumbList ( $dir, $files)
	Delete a list of thumbnails visible at urls. More...

	readOnlyFatalStatus ()

	unprefixRow ( $row, $prefix='img_')

Protected Member Functions inherited from File
	assertRepoDefined ()
	Assert that $this->repo is set to a valid FileRepo instance. More...

	assertTitleDefined ()
	Assert that $this->title is set to a Title. More...

	generateBucketsIfNeeded ( $params, $flags=0)
	Generates chained bucketed thumbnails if needed. More...

	getBucketThumbName ( $bucket)
	Returns the name of the thumb for a given bucket. More...

	getBucketThumbPath ( $bucket)
	Returns the repo path of the thumb for a given bucket. More...

	getCanRender ()
	Accessor for __get() More...

	getIsSafeFile ()
	Accessor for __get() More...

	getIsSafeFileUncached ()
	Uncached accessor. More...

	makeTransformTmpFile ( $thumbPath)
	Creates a temp FS file with the same extension and the thumbnail. More...

	transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags)
	Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors) More...

Protected Attributes
int	$bits
	Returned by getimagesize (loadFromXxx) More...

bool	$dataLoaded
	Whether or not core data has been loaded from the database (loadFromXxx) More...

int	$deleted
	Bitfield akin to rev_deleted. More...

bool	$extraDataLoaded
	Whether or not lazy-loaded data has been loaded from the database. More...

bool	$fileExists
	Does the file exist on disk? (loadFromXxx) More...

int	$height
	Image height. More...

string	$media_type
	MEDIATYPE_xxx (bitmap, drawing, audio...) More...

string	$metadata
	Handler-specific metadata. More...

string	$mime
	MIME type, determined by MimeAnalyzer::guessMimeType. More...

string	$repoClass = LocalRepo::class

string	$sha1
	SHA-1 base 36 content hash. More...

int	$size
	Size in bytes (loadFromXxx) More...

int	$width
	Image width. More...

Protected Attributes inherited from File
bool	$canRender
	Whether the output of transform() for this file is likely to be valid. More...

string	$extension
	File extension. More...

FSFile bool	$fsFile
	False if undefined. More...

MediaHandler	$handler

string	$hashPath
	Relative path including trailing slash. More...

bool	$isSafeFile
	Whether this media file is in a format that is unlikely to contain viruses or malicious content. More...

string	$lastError
	Text of last error. More...

string	$name
	The name of a file from its title object. More...

string false	$pageCount
	Number of pages of a multipage document, or false for documents which aren't multipage documents. More...

string	$path
	The storage path corresponding to one of the zones. More...

string	$redirected
	Main part of the title, with underscores (Title::getDBkey) More...

Title	$redirectedTitle

Title	$redirectTitle

string	$repoClass = FileRepo::class
	Required Repository class type. More...

Title string bool	$title

array	$tmpBucketedThumbCache = []
	Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width. More...

string	$transformScript
	URL of transformscript (for example thumb.php) More...

string	$url
	The URL corresponding to one of the four basic zones. More...

Private Member Functions
	loadExtraFieldsWithTimestamp ( $dbr, $fname)

	loadFromCache ()
	Try to load file metadata from memcached, falling back to the database. More...

Private Attributes
string	$description
	Description of current revision of the file. More...

string	$descriptionTouched
	TS_MW timestamp of the last change of the file description. More...

int	$historyLine
	Number of line to return by nextHistoryLine() (constructor) More...

IResultWrapper null	$historyRes
	Result of the query for the file's history (nextHistoryLine) More...

bool	$locked
	True if the image row is locked. More...

bool	$lockedOwnTrx
	True if the image row is locked with a lock initiated transaction. More...

string	$major_mime
	Major MIME type. More...

string	$minor_mime
	Minor MIME type. More...

bool	$missing
	True if file is not present in file system. More...

string	$timestamp
	Upload timestamp. More...

bool	$upgraded
	Whether the row was upgraded on load. More...

bool	$upgrading
	Whether the row was scheduled to upgrade on load. More...

User	$user
	Uploader. More...

Detailed Description

Class to represent a local file in the wiki's own database.

Provides methods to retrieve paths (physical, logical, URL), to generate image thumbnails or for uploading.

Note that only the repo object knows what its file class is called. You should never name a file class explictly outside of the repo class. Instead use the repo's factory functions to generate file objects, for example:

RepoGroup::singleton()->getLocalRepo()->newFile( $title );

Consider the services container below;

$services = MediaWikiServices::getInstance();

The convenience services $services->getRepoGroup()->getLocalRepo()->newFile() and $services->getRepoGroup()->findFile() should be sufficient in most cases.

@TODO: DI - Instead of using MediaWikiServices::getInstance(), a service should ideally accept a RepoGroup in its constructor and then, use $this->repoGroup->findFile() and $this->repoGroup->getLocalRepo()->newFile().

Definition at line 56 of file LocalFile.php.

Constructor & Destructor Documentation

◆ __construct()

LocalFile::__construct	(	$title,
		$repo
	)

Do not call this except from inside a repo class.

Parameters

Title	$title
FileRepo	$repo

Reimplemented from File.

Definition at line 254 of file LocalFile.php.

References File\$repo, File\$title, File\assertRepoDefined(), and File\assertTitleDefined().

◆ __destruct()

LocalFile::__destruct ( )

Clean up any dangling locks.

Definition at line 2280 of file LocalFile.php.

References unlock().

Member Function Documentation

◆ acquireFileLock()

LocalFile::acquireFileLock ( )

Returns: Status

Since: 1.28

Definition at line 2188 of file LocalFile.php.

References File\getPath(), File\getRepo(), LockManager\LOCK_EX, and Status\wrap().

Referenced by lock().

◆ decodeRow()

LocalFile::decodeRow	(	$row,
		$prefix = `'img_'`
	)

Decode a row from the database (either object or array) to an array with timestamps and MIME types decoded, and the field prefix removed.

Parameters

object	$row
string	$prefix

Exceptions

MWException

Returns: array

Definition at line 557 of file LocalFile.php.

References User\newFromAnyId(), unprefixRow(), and wfTimestamp().

Referenced by loadFromRow().

◆ delete()

LocalFile::delete	(	$reason,
		$suppress = `false`,
		$user = `null`
	)

Delete all versions of the file.

Moves the files into an archive directory (or deletes them) and removes the database rows.

Cache purging is done; logging is caller's responsibility.

Parameters

string	$reason
bool	$suppress
User \| null	$user

Returns: Status

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1931 of file LocalFile.php.

References $user, DeferredUpdates\addUpdate(), SiteStatsUpdate\factory(), File\getArchiveUrl(), File\getRepo(), lock(), DeferredUpdates\PRESEND, File\purgeEverything(), purgeOldThumbnails(), readOnlyFatalStatus(), and unlock().

Referenced by FileDeleteForm\doDelete().

◆ deleteOld()

LocalFile::deleteOld	(	$archiveName,
		$reason,
		$suppress = `false`,
		$user = `null`
	)

Delete an old version of the file.

Moves the file into an archive directory (or deletes it) and removes the database row.

Cache purging is done; logging is caller's responsibility.

Parameters

string	$archiveName
string	$reason
bool	$suppress
User \| null	$user

Exceptions

MWException Exception on database or file store failure

Returns: Status

Definition at line 1989 of file LocalFile.php.

References $user, DeferredUpdates\addUpdate(), File\getArchiveUrl(), File\getRepo(), lock(), DeferredUpdates\PRESEND, File\purgeDescription(), purgeOldThumbnails(), readOnlyFatalStatus(), and unlock().

Referenced by FileDeleteForm\doDelete().

◆ exists()

LocalFile::exists ( )

canRender inherited

mustRender inherited allowInlineDisplay inherited isSafeFile inherited isTrustedFile inherited Returns true if the file exists on disk.

Returns: bool Whether file exist on disk.

Reimplemented from File.

Reimplemented in OldLocalFile.

Definition at line 969 of file LocalFile.php.

References $fileExists, and load().

Referenced by UploadBase\checkLocalFileWasDeleted(), getDescriptionTouched(), getHistory(), FileDeleteForm\haveDeletableFile(), nextHistoryLine(), and publishTo().

◆ getBitDepth()

LocalFile::getBitDepth ( )

Returns: int

Reimplemented from File.

Definition at line 922 of file LocalFile.php.

References $bits, and load().

◆ getCacheFields()

LocalFile::getCacheFields ( $prefix = 'img_' )

protected

Returns the list of object properties that are included as-is in the cache.

Parameters

string $prefix Must be the empty string

Returns: string[]

Since: 1.31 No longer accepts a non-empty $prefix

Reimplemented in OldLocalFile.

Definition at line 385 of file LocalFile.php.

Referenced by loadFromCache(), and setProps().

◆ getCacheKey()

LocalFile::getCacheKey ( )

Get the memcached key for the main data for this file, or false if there is no access to the shared cache.

Returns: string|bool

Reimplemented in OldLocalFile.

Definition at line 272 of file LocalFile.php.

References File\getName().

Referenced by getMutableCacheKeys(), invalidateCache(), and loadFromCache().

◆ getDescription()

LocalFile::getDescription	(		$audience = `self::FOR_PUBLIC`,
		User	$user = `null`
	)

Parameters

int	$audience
User \| null	$user

Returns: string

Reimplemented from File.

Definition at line 2103 of file LocalFile.php.

References $description, $user, File\isDeleted(), load(), and File\userCan().

◆ getDescriptionShortUrl()

LocalFile::getDescriptionShortUrl ( )

Get short description URL for a file based on the page ID.

Returns: string|null

Exceptions

MWException

Since: 1.27

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 894 of file LocalFile.php.

References File\$url.

◆ getDescriptionText()

LocalFile::getDescriptionText ( Language $lang = null )

Get the HTML text of the description page This is not used by ImagePage for local files, since (among other things) it skips the parser cache.

Parameters

Language | null $lang What language to get description in (Optional)

Returns: string|false

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 2075 of file LocalFile.php.

References $lang.

◆ getDescriptionTouched()

LocalFile::getDescriptionTouched ( )

Returns: bool|string

Reimplemented from File.

Definition at line 2128 of file LocalFile.php.

References $descriptionTouched, exists(), and wfTimestamp().

◆ getDescriptionUrl()

LocalFile::getDescriptionUrl ( )

isMultipage inherited

pageCount inherited scaleHeight inherited getImageSize inherited Get the URL of the file description page.

Returns: string|bool

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 2059 of file LocalFile.php.

◆ getHeight()

LocalFile::getHeight ( $page = 1 )

Return the height of the image.

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 828 of file LocalFile.php.

References File\$handler, $height, File\getHandler(), MediaHandler\getPageDimensions(), File\isMultipage(), and load().

Referenced by RevDelArchivedFileItem\getApiData(), and RevDelFileItem\getApiData().

◆ getHistory()

LocalFile::getHistory	(	$limit = `null`,
		$start = `null`,
		$end = `null`,
		$inc = `true`
	)

purgeDescription inherited

purgeEverything inherited

Parameters

int \| null	$limit	Optional: Limit to number of results
string \| int \| null	$start	Optional: Timestamp, start from
string \| int \| null	$end	Optional: Timestamp, end at
bool	$inc

Returns: OldLocalFile[]

Reimplemented from File.

Definition at line 1167 of file LocalFile.php.

References $dbr, $res, exists(), OldLocalFile\getQueryInfo(), and Hooks\run().

Referenced by UploadBase\checkLocalFileExists().

◆ getLazyCacheFields()

LocalFile::getLazyCacheFields ( $prefix = 'img_' )

protected

Returns the list of object properties that are included as-is in the cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB().

Parameters

string $prefix Must be the empty string

Returns: string[]

Since: 1.31 No longer accepts a non-empty $prefix

Definition at line 407 of file LocalFile.php.

Referenced by loadFromCache().

◆ getMediaType()

LocalFile::getMediaType ( )

Returns the type of the media in the file.

Use the value returned by this function with the MEDIATYPE_xxx constants.

Returns: string

Reimplemented from File.

Definition at line 953 of file LocalFile.php.

References $media_type, and load().

◆ getMetadata()

LocalFile::getMetadata ( )

Get handler-specific metadata.

Returns: string

Reimplemented from File.

Definition at line 914 of file LocalFile.php.

References $metadata, and load().

Referenced by maybeUpgradeRow().

◆ getMimeType()

LocalFile::getMimeType ( )

Returns the MIME type of the file.

Returns: string

Reimplemented from File.

Definition at line 942 of file LocalFile.php.

References $mime, and load().

◆ getMutableCacheKeys()

LocalFile::getMutableCacheKeys ( WANObjectCache $cache )

Parameters

WANObjectCache $cache

Returns: string[]

Since: 1.28

Definition at line 281 of file LocalFile.php.

References getCacheKey().

◆ getQueryInfo()

static LocalFile::getQueryInfo ( array $options = [] )

static

Return the tables, fields, and join conditions to be selected to create a new localfile object.

Since: 1.31

Parameters

string[]

$options

omit-lazy: Omit fields that are lazily cached.

Returns

array[] With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
fields: (string[]) to include in the $vars to IDatabase->select()
joins: (array) to include in the $join_conds to IDatabase->select()

Reimplemented in OldLocalFile.

Definition at line 216 of file LocalFile.php.

References ActorMigration\newMigration().

Referenced by ImageBuilder\buildImage(), CheckImages\execute(), RefreshFileHeaders\execute(), RefreshImageMetadata\execute(), LocalRepo\findBySha1(), LocalRepo\findBySha1s(), LocalRepo\findFiles(), LocalRepo\findFilesByPrefix(), SpecialMIMESearch\getQueryInfo(), SpecialFileDuplicateSearch\getQueryInfo(), loadExtraFieldsWithTimestamp(), nextHistoryLine(), and ApiQueryAllImages\run().

◆ getSha1()

LocalFile::getSha1 ( )

Returns: string

Reimplemented from File.

Definition at line 2151 of file LocalFile.php.

References $sha1, File\getName(), File\getPath(), invalidateCache(), load(), lock(), unlock(), and wfReadOnly().

Referenced by UploadBase\checkLocalFileExists(), RevertAction\onSubmit(), and purgeThumbList().

◆ getSize()

LocalFile::getSize ( )

Returns the size of the image file, in bytes.

Returns: int

Reimplemented from File.

Definition at line 932 of file LocalFile.php.

References $size, and load().

Referenced by RevDelArchivedFileItem\getApiData(), and RevDelFileItem\getApiData().

◆ getThumbnails()

LocalFile::getThumbnails ( $archiveName = false )

getTransformScript inherited

getUnscaledThumb inherited thumbName inherited createThumb inherited transform inherited getHandler inherited iconThumb inherited getLastError inherited Get all thumbnail names previously generated for this file

Parameters

string | bool $archiveName Name of an archive file, default false

Returns: array First element is the base dir, then files in that base dir.

Definition at line 990 of file LocalFile.php.

References $file, File\getArchiveThumbPath(), and File\getThumbPath().

◆ getTimestamp()

LocalFile::getTimestamp ( )

Returns: bool|string

Reimplemented from File.

Definition at line 2119 of file LocalFile.php.

References $timestamp, and load().

Referenced by RevDelArchivedFileItem\getApiData(), and RevDelFileItem\getApiData().

◆ getUpgraded()

LocalFile::getUpgraded ( )

Returns: bool Whether upgradeRow() ran for this object

Definition at line 677 of file LocalFile.php.

References $upgraded.

◆ getUser()

LocalFile::getUser ( $type = 'text' )

Returns user who uploaded the file.

Parameters

string $type 'text', 'id', or 'object'

Returns: int|string|User

Since: 1.31 Added 'object'

Reimplemented from File.

Definition at line 861 of file LocalFile.php.

References $type, $user, User\getName(), load(), and User\newFromName().

Referenced by RevDelArchivedFileItem\getApiData(), and RevDelFileItem\getApiData().

◆ getWidth()

LocalFile::getWidth ( $page = 1 )

Return the width of the image.

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 796 of file LocalFile.php.

References File\$handler, $width, File\getHandler(), MediaHandler\getPageDimensions(), File\isMultipage(), and load().

Referenced by RevDelArchivedFileItem\getApiData(), RevDelFileItem\getApiData(), and prerenderThumbnails().

◆ invalidateCache()

LocalFile::invalidateCache ( )

Purge the file object/metadata cache.

Definition at line 357 of file LocalFile.php.

References getCacheKey().

Referenced by getSha1(), purgeMetadataCache(), recordUpload2(), and upgradeRow().

◆ isCacheable()

LocalFile::isCacheable ( )

Returns: bool Whether to cache in RepoGroup (this avoids OOMs)

Reimplemented from File.

Definition at line 2176 of file LocalFile.php.

References CACHE_FIELD_MAX_LEN, load(), and serialize().

◆ isMissing()

LocalFile::isMissing ( )

splitMime inherited

getName inherited getTitle inherited getURL inherited getViewURL inherited getPath inherited isVisible inherited Checks if this file exists in its parent repo, as referenced by its virtual URL.

Returns: bool

Reimplemented from File.

Definition at line 781 of file LocalFile.php.

References $fileExists, $missing, and File\getVirtualUrl().

◆ load()

LocalFile::load ( $flags = 0 )

Load file metadata from cache or DB, unless already loaded.

Parameters

int $flags

Reimplemented from File.

Definition at line 620 of file LocalFile.php.

References loadExtraFromDB(), loadFromCache(), and loadFromDB().

Referenced by exists(), OldLocalFile\getArchiveName(), getBitDepth(), getDescription(), getHeight(), getMediaType(), getMetadata(), getMimeType(), getSha1(), getSize(), getTimestamp(), getUser(), OldLocalFile\getVisibility(), getWidth(), isCacheable(), OldLocalFile\isDeleted(), and OldLocalFile\userCan().

◆ loadExtraFieldsWithTimestamp()

LocalFile::loadExtraFieldsWithTimestamp	(	$dbr,
		$fname
	)

private

Parameters

IDatabase	$dbr
string	$fname

Returns: string[]|bool

Definition at line 483 of file LocalFile.php.

References $dbr, File\getName(), OldLocalFile\getQueryInfo(), getQueryInfo(), and unprefixRow().

Referenced by loadExtraFromDB().

◆ loadExtraFromDB()

LocalFile::loadExtraFromDB ( )

protected

Load lazy file metadata from the DB.

This covers fields that are sometimes not cached.

Reimplemented in OldLocalFile.

Definition at line 454 of file LocalFile.php.

References File\$name, and loadExtraFieldsWithTimestamp().

Referenced by load().

◆ loadFromCache()

LocalFile::loadFromCache ( )

private

Try to load file metadata from memcached, falling back to the database.

Definition at line 288 of file LocalFile.php.

References $cache, $fileExists, getCacheFields(), getCacheKey(), getLazyCacheFields(), loadFromDB(), setProps(), VERSION, and wfTimestamp().

Referenced by load().

◆ loadFromDB()

LocalFile::loadFromDB ( $flags = 0 )

Load file metadata from the DB.

Parameters

int $flags

Reimplemented in OldLocalFile.

Definition at line 422 of file LocalFile.php.

References $dbr, File\getName(), and loadFromRow().

Referenced by load(), and loadFromCache().

◆ loadFromFile()

LocalFile::loadFromFile ( )

Load metadata from the file itself.

Definition at line 374 of file LocalFile.php.

References File\getVirtualUrl(), and setProps().

Referenced by OldLocalFile\upgradeRow(), and upgradeRow().

◆ loadFromRow()

LocalFile::loadFromRow	(	$row,
		$prefix = `'img_'`
	)

Load file metadata from a DB result row.

Parameters

object	$row
string	$prefix

Definition at line 603 of file LocalFile.php.

References File\$name, and decodeRow().

Referenced by OldLocalFile\loadFromDB(), and loadFromDB().

◆ lock()

LocalFile::lock ( )

Start an atomic DB section and lock the image for update or increments a reference counter if the lock is already held.

This method should not be used outside of LocalFile/LocalFile*Batch

Exceptions

LocalFileLockError Throws an error if the lock was not acquired

Returns: bool Whether the file lock owns/spawned the DB transaction

Definition at line 2213 of file LocalFile.php.

References $lockedOwnTrx, acquireFileLock(), and releaseFileLock().

Referenced by delete(), deleteOld(), getSha1(), move(), publishTo(), restore(), upgradeRow(), upload(), and OldLocalFile\uploadOld().

◆ maybeUpgradeRow()

LocalFile::maybeUpgradeRow ( )

protected

Upgrade a row if it needs it.

Definition at line 638 of file LocalFile.php.

References File\$handler, $wgUpdateCompatibleMetadata, DeferredUpdates\addCallableUpdate(), File\getHandler(), getMetadata(), MediaHandler\isMetadataValid(), MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, upgradeRow(), and wfReadOnly().

Referenced by purgeCache().

◆ move()

LocalFile::move ( $target )

getLinksTo inherited

getExifData inherited isLocal inherited wasDeleted inherited Move file to the new title

Move current, old version and all thumbnails to the new filename. Old file is deleted.

Cache purging is done; checks for validity and logging are caller's responsibility

Parameters

Title $target New file name

Returns: Status

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1870 of file LocalFile.php.

References DeferredUpdates\addUpdate(), File\getRepo(), lock(), DeferredUpdates\PRESEND, readOnlyFatalStatus(), unlock(), and wfDebugLog().

◆ newFromKey()

static LocalFile::newFromKey	(	$sha1,
		$repo,
		$timestamp = `false`
	)

static

Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class.

Parameters

string	$sha1	Base-36 SHA-1
LocalRepo	$repo
string \| bool	$timestamp	MW_timestamp (optional)

Returns: bool|LocalFile

Reimplemented in OldLocalFile.

Definition at line 186 of file LocalFile.php.

References $dbr, File\$repo, $sha1, and $timestamp.

◆ newFromRow()

static LocalFile::newFromRow	(	$row,
		$repo
	)

static

Create a LocalFile from a title Do not call this except from inside a repo class.

Parameters

stdClass	$row
FileRepo	$repo

Returns: static

Reimplemented in OldLocalFile.

Definition at line 169 of file LocalFile.php.

References $file, File\$repo, File\$title, Title\makeTitle(), and NS_FILE.

◆ newFromTitle()

static LocalFile::newFromTitle	(	$title,
		$repo,
		$unused = `null`
	)

static

Create a LocalFile from a title Do not call this except from inside a repo class.

Note: $unused param is only here to avoid an E_STRICT

Parameters

Title	$title
FileRepo	$repo
null	$unused

Returns: static

Reimplemented in OldLocalFile.

Definition at line 156 of file LocalFile.php.

References File\$repo, and File\$title.

◆ nextHistoryLine()

LocalFile::nextHistoryLine ( )

Returns the history of this file, line by line.

starts with current version, then old versions. uses $this->historyLine to check which line to return: 0 return line for current version 1 query for old versions, return first one 2, ... return next old version from above query

Returns: stdClass|bool

Reimplemented from File.

Definition at line 1227 of file LocalFile.php.

References $dbr, exists(), OldLocalFile\getQueryInfo(), and getQueryInfo().

◆ prerenderThumbnails()

LocalFile::prerenderThumbnails ( )

Prerenders a configurable set of thumbnails.

Since: 1.28

Definition at line 1100 of file LocalFile.php.

References $size, $wgUploadThumbnailRenderMap, File\getTitle(), getWidth(), File\isVectorized(), and JobQueueGroup\singleton().

Referenced by recordUpload2().

◆ publish()

LocalFile::publish	(		$src,
			$flags = `0`,
		array	$options = `[]`
	)

Move or copy a file to its public location.

If a file exists at the destination, move it to an archive. Returns a Status object with the archive name in the "value" member on success.

The archive name should be passed through to recordUpload for database registration.

Parameters

string \| FSFile	$src	Local filesystem path or virtual URL to the source image
int	$flags	A bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
array	$options	Optional additional parameters

Returns: Status On success, the value member contains the archive name, or an empty string if it was a new file.

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1785 of file LocalFile.php.

References File\getRel(), and publishTo().

Referenced by upload().

◆ publishTo()

LocalFile::publishTo	(		$src,
			$dstRel,
			$flags = `0`,
		array	$options = `[]`
	)

Move or copy a file to a specified location.

Returns a Status object with the archive name in the "value" member on success.

The archive name should be passed through to recordUpload for database registration.

Parameters

string \| FSFile	$src	Local filesystem path or virtual URL to the source image
string	$dstRel	Target relative path
int	$flags	A bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
array	$options	Optional additional parameters

Returns: Status On success, the value member contains the archive name, or an empty string if it was a new file.

Definition at line 1804 of file LocalFile.php.

References File\$repo, $sha1, FileRepo\DELETE_SOURCE, File\DELETE_SOURCE, exists(), File\getArchiveRel(), FileRepo\getBackend(), FileRepo\getFileSha1(), File\getName(), FileRepo\getReadOnlyReason(), File\getRepo(), FSFile\getSha1Base36FromPath(), FileRepo\hasSha1Storage(), File\isOld(), FileRepo\isVirtualUrl(), lock(), FileRepo\publish(), FileRepo\quickImport(), readOnlyFatalStatus(), unlock(), and wfTimestamp().

Referenced by publish(), and OldLocalFile\uploadOld().

◆ purgeCache()

LocalFile::purgeCache ( $options = [] )

Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.

Parameters

array $options An array potentially with the key forThumbRefresh.

Note: This used to purge old thumbnails by default as well, but doesn't anymore.

Reimplemented from File.

Definition at line 1024 of file LocalFile.php.

References DeferredUpdates\addUpdate(), File\getUrl(), maybeUpgradeRow(), DeferredUpdates\PRESEND, purgeMetadataCache(), and purgeThumbnails().

◆ purgeMetadataCache()

LocalFile::purgeMetadataCache ( )

Refresh metadata in memcached, but don't touch thumbnails or CDN.

Definition at line 1013 of file LocalFile.php.

References invalidateCache().

Referenced by purgeCache().

◆ purgeOldThumbnails()

LocalFile::purgeOldThumbnails ( $archiveName )

Delete cached transformed files for an archived version only.

Parameters

string $archiveName Name of the archived file

Definition at line 1043 of file LocalFile.php.

References $file, $urls, DeferredUpdates\addUpdate(), File\getArchiveThumbUrl(), File\getThumbnails(), DeferredUpdates\PRESEND, purgeThumbList(), and Hooks\run().

Referenced by delete(), deleteOld(), and PurgeChangedFiles\purgeFromArchiveTable().

◆ purgeThumbList()

LocalFile::purgeThumbList	(	$dir,
		$files
	)

protected

Delete a list of thumbnails visible at urls.

Parameters

string	$dir	Base dir of the files.
array	$files	Array of strings: relative filenames (to $dir)

Definition at line 1127 of file LocalFile.php.

References $file, File\getName(), getSha1(), and wfDebug().

Referenced by purgeOldThumbnails(), and purgeThumbnails().

◆ purgeThumbnails()

LocalFile::purgeThumbnails ( $options = [] )

Delete cached transformed files for the current version only.

Parameters

array $options -param array{forThumbRefresh?:bool} $options

Definition at line 1067 of file LocalFile.php.

References $file, File\$handler, $urls, DeferredUpdates\addUpdate(), MediaHandler\filterThumbnailPurgeList(), File\getHandler(), File\getThumbnails(), File\getThumbUrl(), DeferredUpdates\PRESEND, purgeThumbList(), and Hooks\run().

Referenced by purgeCache(), and recordUpload2().

◆ readOnlyFatalStatus()

LocalFile::readOnlyFatalStatus ( )

protected

Returns: Status

Definition at line 2272 of file LocalFile.php.

References File\getName(), and File\getRepo().

Referenced by delete(), deleteOld(), move(), publishTo(), restore(), and upload().

◆ recordUpload()

LocalFile::recordUpload	(		$oldver,
			$desc,
			$license = `''`,
			$copyStatus = `''`,
			$source = `''`,
			$watch = `false`,
			$timestamp = `false`,
		User	$user = `null`
	)

Record a file upload in the upload log and the image table.

Parameters

string	$oldver
string	$desc
string	$license
string	$copyStatus
string	$source
bool	$watch
string \| bool	$timestamp
User \| null	$user	User object or null to use $wgUser

Returns: bool

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1404 of file LocalFile.php.

References $source, $timestamp, $user, User\addWatch(), SpecialUpload\getInitialPageText(), File\getTitle(), and recordUpload2().

◆ recordUpload2()

LocalFile::recordUpload2	(	$oldver,
		$comment,
		$pageText,
		$props = `false`,
		$timestamp = `false`,
		$user = `null`,
		$tags = `[]`,
		$createNullRevision = `true`,
		$revert = `false`
	)

Record a file upload in the upload log and the image table.

Parameters

string	$oldver
string	$comment
string	$pageText
bool \| array	$props
string \| bool	$timestamp
null \| User	$user
string[]	$tags
bool	$createNullRevision	Set to false to avoid creation of a null revision on file upload, see T193621
bool	$revert	If this file upload is a revert

Returns: Status

Definition at line 1438 of file LocalFile.php.

References $timestamp, File\$title, $user, DeferredUpdates\addUpdate(), EDIT_NEW, EDIT_SUPPRESS_RC, SiteStatsUpdate\factory(), User\getActorId(), User\getId(), File\getName(), User\getName(), Title\getPrefixedText(), File\getRel(), File\getRepo(), File\getTitle(), File\getUrl(), File\getVirtualUrl(), invalidateCache(), ContentHandler\makeContent(), LogEntryBase\makeParamBlob(), RequestContext\newExtraneousContext(), StatusValue\newFatal(), LogFormatter\newFromEntry(), Title\newFromText(), StatusValue\newGood(), ActorMigration\newMigration(), Revision\newNullRevision(), NS_FILE, prerenderThumbnails(), DeferredUpdates\PRESEND, Article\purgePatrolFooterCache(), purgeThumbnails(), LinksUpdate\queueRecursiveJobsForTable(), Hooks\run(), setProps(), wfDebug(), and wfTimestamp().

Referenced by recordUpload(), and upload().

◆ releaseFileLock()

LocalFile::releaseFileLock ( )

Returns: Status

Since: 1.28

Definition at line 2198 of file LocalFile.php.

References File\getPath(), File\getRepo(), LockManager\LOCK_EX, and Status\wrap().

Referenced by lock().

◆ resetHistory()

LocalFile::resetHistory ( )

Reset the history pointer to the first element of the history.

Reimplemented from File.

Definition at line 1274 of file LocalFile.php.

◆ restore()

LocalFile::restore	(	$versions = `[]`,
		$unsuppress = `false`
	)

Restore all or specified deleted revisions to the given file.

Permissions and logging are left to the caller.

May throw database exceptions on error.

Parameters

array	$versions	Set of record ids of deleted items to restore, or empty to restore all revisions.
bool	$unsuppress

Returns: Status

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 2025 of file LocalFile.php.

References File\getRepo(), lock(), readOnlyFatalStatus(), and unlock().

◆ setProps()

LocalFile::setProps ( $info )

Set properties in this object to be equal to those given in the associative array $info.

Only cacheable fields can be set. All fields must be set in $info except for getLazyCacheFields().

If 'mime' is given, it will be split into major_mime/minor_mime. If major_mime/minor_mime are given, $this->mime will also be set.

Parameters

array $info

Definition at line 739 of file LocalFile.php.

References getCacheFields(), User\newFromAnyId(), and File\splitMime().

Referenced by loadFromCache(), loadFromFile(), and recordUpload2().

◆ unlock()

LocalFile::unlock ( )

Decrement the lock reference count and end the atomic section if it reaches zero.

This method should not be used outside of LocalFile/LocalFile*Batch

The commit and loc release will happen when no atomic sections are active, which may happen immediately or at some point after calling this

Definition at line 2258 of file LocalFile.php.

References $locked.

Referenced by __destruct(), delete(), deleteOld(), getSha1(), move(), publishTo(), restore(), upgradeRow(), upload(), and OldLocalFile\uploadOld().

◆ unprefixRow()

LocalFile::unprefixRow	(	$row,
		$prefix = `'img_'`
	)

protected

Parameters

array \| object	$row
string	$prefix

Exceptions

MWException

Returns: array

Definition at line 532 of file LocalFile.php.

References File\$name.

Referenced by decodeRow(), loadExtraFieldsWithTimestamp(), and OldLocalFile\loadExtraFromDB().

◆ upgradeRow()

LocalFile::upgradeRow ( )

Fix assorted version-related problems with the image row by reloading it from the file.

Reimplemented from File.

Reimplemented in OldLocalFile.

Definition at line 684 of file LocalFile.php.

References File\getName(), invalidateCache(), loadFromFile(), lock(), File\splitMime(), unlock(), wfDebug(), and wfReadOnly().

Referenced by maybeUpgradeRow().

◆ upload()

LocalFile::upload	(	$src,
		$comment,
		$pageText,
		$flags = `0`,
		$props = `false`,
		$timestamp = `false`,
		$user = `null`,
		$tags = `[]`,
		$createNullRevision = `true`,
		$revert = `false`
	)

getHashPath inherited

getRel inherited getUrlRel inherited getArchiveRel inherited getArchivePath inherited getThumbPath inherited getArchiveUrl inherited getThumbUrl inherited getArchiveVirtualUrl inherited getThumbVirtualUrl inherited isHashed inherited Upload a file and record it in the DB

Parameters

string \| FSFile	$src	Source storage path, virtual URL, or filesystem path
string	$comment	Upload description
string	$pageText	Text to use for the new description page, if a new description page is created
int \| bool	$flags	Flags for publish()
array \| bool	$props	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
string \| bool	$timestamp	Timestamp for img_timestamp, or false to use the current time
User \| null	$user	User object or null to use $wgUser
string[]	$tags	Change tags to add to the log entry and page revision. (This doesn't check $user's permissions.)
bool	$createNullRevision	Set to false to avoid creation of a null revision on file upload, see T193621
bool	$revert	If this file upload is a revert

Returns: Status On success, the value member contains the archive name, or an empty string if it was a new file.

Definition at line 1315 of file LocalFile.php.

References File\$handler, $metadata, $timestamp, $user, MediaHandler\getContentHeaders(), MediaHandler\getHandler(), File\getRepo(), FileBackend\isStoragePath(), FileRepo\isVirtualUrl(), lock(), publish(), readOnlyFatalStatus(), recordUpload2(), and unlock().

Member Data Documentation

◆ $bits

int LocalFile::$bits

protected

Returned by getimagesize (loadFromXxx)

Definition at line 71 of file LocalFile.php.

Referenced by getBitDepth().

◆ $dataLoaded

bool LocalFile::$dataLoaded

protected

Whether or not core data has been loaded from the database (loadFromXxx)

Definition at line 89 of file LocalFile.php.

◆ $deleted

int LocalFile::$deleted

protected

Bitfield akin to rev_deleted.

Definition at line 95 of file LocalFile.php.

Referenced by OldLocalFile\getVisibility().

◆ $description

string LocalFile::$description

private

Description of current revision of the file.

Definition at line 119 of file LocalFile.php.

Referenced by getDescription().

◆ $descriptionTouched

string LocalFile::$descriptionTouched

private

TS_MW timestamp of the last change of the file description.

Definition at line 122 of file LocalFile.php.

Referenced by getDescriptionTouched().

◆ $extraDataLoaded

bool LocalFile::$extraDataLoaded

protected

Whether or not lazy-loaded data has been loaded from the database.

Definition at line 92 of file LocalFile.php.

◆ $fileExists

bool LocalFile::$fileExists

protected

Does the file exist on disk? (loadFromXxx)

Definition at line 62 of file LocalFile.php.

Referenced by exists(), isMissing(), and loadFromCache().

◆ $height

int LocalFile::$height

protected

Image height.

Definition at line 68 of file LocalFile.php.

Referenced by getHeight().

◆ $historyLine

int LocalFile::$historyLine

private

Number of line to return by nextHistoryLine() (constructor)

Definition at line 101 of file LocalFile.php.

◆ $historyRes

IResultWrapper null LocalFile::$historyRes

private

Result of the query for the file's history (nextHistoryLine)

Definition at line 104 of file LocalFile.php.

◆ $locked

bool LocalFile::$locked

private

True if the image row is locked.

Definition at line 131 of file LocalFile.php.

Referenced by unlock().

◆ $lockedOwnTrx

bool LocalFile::$lockedOwnTrx

private

True if the image row is locked with a lock initiated transaction.

Definition at line 134 of file LocalFile.php.

Referenced by lock().

◆ $major_mime

string LocalFile::$major_mime

private

Major MIME type.

Definition at line 107 of file LocalFile.php.

◆ $media_type

string LocalFile::$media_type

protected

MEDIATYPE_xxx (bitmap, drawing, audio...)

Definition at line 74 of file LocalFile.php.

Referenced by getMediaType().

◆ $metadata

string LocalFile::$metadata

protected

Handler-specific metadata.

Definition at line 83 of file LocalFile.php.

Referenced by getMetadata(), and upload().

◆ $mime

string LocalFile::$mime

protected

MIME type, determined by MimeAnalyzer::guessMimeType.

Definition at line 77 of file LocalFile.php.

Referenced by getMimeType().

◆ $minor_mime

string LocalFile::$minor_mime

private

Minor MIME type.

Definition at line 110 of file LocalFile.php.

◆ $missing

bool LocalFile::$missing

private

True if file is not present in file system.

Not to be cached in memcached

Definition at line 137 of file LocalFile.php.

Referenced by isMissing().

◆ $repoClass

string LocalFile::$repoClass = LocalRepo::class

protected

Definition at line 98 of file LocalFile.php.

◆ $sha1

string LocalFile::$sha1

protected

SHA-1 base 36 content hash.

Definition at line 86 of file LocalFile.php.

Referenced by getSha1(), OldLocalFile\newFromKey(), newFromKey(), and publishTo().

◆ $size

int LocalFile::$size

protected

Size in bytes (loadFromXxx)

Definition at line 80 of file LocalFile.php.

Referenced by getSize(), and prerenderThumbnails().

◆ $timestamp

string LocalFile::$timestamp

private

Upload timestamp.

Definition at line 113 of file LocalFile.php.

Referenced by getTimestamp(), OldLocalFile\newFromKey(), newFromKey(), OldLocalFile\recordOldUpload(), recordUpload(), recordUpload2(), upload(), and OldLocalFile\uploadOld().

◆ $upgraded

bool LocalFile::$upgraded

private

Whether the row was upgraded on load.

Definition at line 125 of file LocalFile.php.

Referenced by getUpgraded().

◆ $upgrading

bool LocalFile::$upgrading

private

Whether the row was scheduled to upgrade on load.

Definition at line 128 of file LocalFile.php.

◆ $user

User LocalFile::$user

private

Uploader.

Definition at line 116 of file LocalFile.php.

Referenced by delete(), deleteOld(), getDescription(), getUser(), OldLocalFile\recordOldUpload(), recordUpload(), recordUpload2(), upload(), OldLocalFile\uploadOld(), and OldLocalFile\userCan().

◆ $width

int LocalFile::$width

protected

Image width.

Definition at line 65 of file LocalFile.php.

Referenced by getWidth().

◆ ATOMIC_SECTION_LOCK

const LocalFile::ATOMIC_SECTION_LOCK = 'LocalFile::lockingTransaction'

Definition at line 142 of file LocalFile.php.

◆ CACHE_FIELD_MAX_LEN

const LocalFile::CACHE_FIELD_MAX_LEN = 1000

Definition at line 59 of file LocalFile.php.

Referenced by isCacheable().

◆ LOAD_ALL

const LocalFile::LOAD_ALL = 16

Definition at line 140 of file LocalFile.php.

◆ VERSION

const LocalFile::VERSION = 11

Definition at line 57 of file LocalFile.php.

Referenced by loadFromCache().

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

includes/filerepo/file/LocalFile.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ acquireFileLock()

◆ decodeRow()

◆ delete()

◆ deleteOld()

◆ exists()

◆ getBitDepth()

◆ getCacheFields()

◆ getCacheKey()

◆ getDescription()

◆ getDescriptionShortUrl()

◆ getDescriptionText()

◆ getDescriptionTouched()

◆ getDescriptionUrl()

◆ getHeight()

◆ getHistory()

◆ getLazyCacheFields()

◆ getMediaType()

◆ getMetadata()

◆ getMimeType()

◆ getMutableCacheKeys()

◆ getQueryInfo()

◆ getSha1()

◆ getSize()

◆ getThumbnails()

◆ getTimestamp()

◆ getUpgraded()

◆ getUser()

◆ getWidth()

◆ invalidateCache()

◆ isCacheable()

◆ isMissing()

◆ load()

◆ loadExtraFieldsWithTimestamp()

◆ loadExtraFromDB()

◆ loadFromCache()

◆ loadFromDB()

◆ loadFromFile()

◆ loadFromRow()

◆ lock()

◆ maybeUpgradeRow()

◆ move()

◆ newFromKey()

◆ newFromRow()

◆ newFromTitle()

◆ nextHistoryLine()

◆ prerenderThumbnails()

◆ publish()

◆ publishTo()

◆ purgeCache()

◆ purgeMetadataCache()

◆ purgeOldThumbnails()

◆ purgeThumbList()

◆ purgeThumbnails()

◆ readOnlyFatalStatus()

◆ recordUpload()

◆ recordUpload2()

◆ releaseFileLock()

◆ resetHistory()

◆ restore()

◆ setProps()

◆ unlock()

◆ unprefixRow()

◆ upgradeRow()

◆ upload()

Member Data Documentation

◆ $bits

◆ $dataLoaded

◆ $deleted