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.

	__destruct ()
	Clean up any dangling locks.

	acquireFileLock ()

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

	deleteFile ( $reason, User $user, $suppress=false)
	Delete all versions of the file.

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

	deleteOldFile ( $archiveName, $reason, User $user, $suppress=false)
	Delete an old version of the file.

	exists ()
	canRender inherited

	getBitDepth ()
	Stable to override.

	getDescription ( $audience=self::FOR_PUBLIC, User $user=null)
	Stable to override.

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

	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.

	getDescriptionTouched ()
	Stable to override.

	getDescriptionUrl ()
	isMultipage inherited

	getHeight ( $page=1)
	Return the height of the image Stable to override.

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

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

	getMetadata ()
	Get handler-specific metadata Stable to override.

	getMimeType ()
	Returns the MIME type of the file.

	getMutableCacheKeys (WANObjectCache $cache)

	getRepo ()

	getSha1 ()
	Stable to override.

	getSize ()
	Returns the size of the image file, in bytes Stable to override.

	getTimestamp ()
	Stable to override.

	getUpgraded ()

	getUser ( $type='text')
	Returns user who uploaded the file Stable to override.

	getWidth ( $page=1)
	Return the width of the image Stable to override.

	invalidateCache ()
	Purge the file object/metadata cache.

	isCacheable ()

	isMissing ()
	splitMime inherited

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

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

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

	move ( $target)
	getLinksTo inherited

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

	prerenderThumbnails ()
	Prerenders a configurable set of thumbnails Stable to override.

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

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

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

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

	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.

	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.

	recordUpload3 (string $oldver, string $comment, string $pageText, User $user, $props=false, $timestamp=false, $tags=[], bool $createNullRevision=true, bool $revert=false)
	Record a file upload in the upload log and the image table (version 3)

	releaseFileLock ()

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

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

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

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

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

Public Member Functions inherited from File
	__get ( $name)

	allowInlineDisplay ()
	Alias for canRender()

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

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

	convertMetadataVersion ( $metadata, $version)
	get versioned metadata

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

	formatMetadata ( $context=false)

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

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

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

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

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

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

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

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

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

	getCanonicalUrl ()
	Stable to override.

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

	getContentHeaders ()

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

	getDimensionsString ()

	getDisplayWidthHeight ( $maxWidth, $maxHeight, $page=1)
	Get the width and height to display image at.

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

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

	getHandler ()
	Get a MediaHandler instance for this file.

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

	getLastError ()
	Get last thumbnailing error.

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

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

	getLongDesc ()

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

	getName ()
	Return the name of this file.

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

	getPath ()
	Return the storage path to the file.

	getRedirected ()

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

	getRepoName ()
	Returns the name of the repository.

	getShortDesc ()

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

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

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

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

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

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

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

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

	getTitle ()
	Return the associated title object.

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

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

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

	getUrl ()
	Return the URL of the file Stable to override.

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

	getViewURL ()

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

	getVisibility ()
	Return the deletion bitfield STUB Stable to override.

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

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

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

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

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

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

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

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

	isVectorized ()
	Return true if the file is vectorized.

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

	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.

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

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

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

	redirectedFrom ( $from)

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

	transform ( $params, $flags=0)
	Transform a media file Stable to override.

	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.

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

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

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

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

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

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

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

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

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

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

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

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

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

	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().

	getThumbnails ( $archiveName=false)
	getTransformScript inherited

	loadExtraFromDB ()
	Load lazy file metadata from the DB.

	loadFromDB ( $flags=0)
	Load file metadata from the DB Stable to override.

	loadFromFile ()
	Load metadata from the file itself.

	maybeUpgradeRow ()
	Upgrade a row if it needs it.

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

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

	readOnlyFatalStatus ()

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

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

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

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

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

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

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

	getCanRender ()
	Accessor for __get()

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

	getIsSafeFile ()
	Accessor for __get()

	getIsSafeFileUncached ()
	Uncached accessor.

	getRedirectedTitle ()

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

	isHashed ()

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

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

	migrateThumbFile ( $thumbName)
	Hook into transform() to allow migration of thumbnail files STUB Stable to override.

	readOnlyError ()

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

Protected Attributes
int	$bits
	Returned by getimagesize (loadFromXxx)

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

int	$deleted
	Bitfield akin to rev_deleted.

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

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

int	$height
	Image height.

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

string	$metadata
	Handler-specific metadata.

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

string	$repoClass = LocalRepo::class

string	$sha1
	SHA-1 base 36 content hash.

int	$size
	Size in bytes (loadFromXxx)

int	$width
	Image width.

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

string	$extension
	File extension.

FSFile bool	$fsFile
	False if undefined.

MediaHandler	$handler

string	$hashPath
	Relative path including trailing slash.

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

string	$lastError
	Text of last error.

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

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

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

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

Title	$redirectedTitle

Title	$redirectTitle

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

Title string bool	$title

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

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

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

Private Member Functions
	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.

	loadExtraFieldsWithTimestamp ( $dbr, $fname)

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

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

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

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

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

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

bool	$locked
	True if the image row is locked.

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

string	$major_mime
	Major MIME type.

string	$minor_mime
	Minor MIME type.

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

string	$timestamp
	Upload timestamp.

bool	$upgraded
	Whether the row was upgraded on load.

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

User	$user
	Uploader.

const	ATOMIC_SECTION_LOCK = 'LocalFile::lockingTransaction'

const	CACHE_FIELD_MAX_LEN = 1000

const	LOAD_ALL = 16

const	VERSION = 12

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

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.

const	RENDER_NOW = 1
	Force rendering in the current process.

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)

const	READ_NONE = -1

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().

Stable to extend

Definition at line 59 of file LocalFile.php.

Constructor & Destructor Documentation

◆ __construct()

LocalFile::__construct	(	$title,
		$repo
	)

Do not call this except from inside a repo class.

Stable to call

Parameters

Title	$title
FileRepo	$repo

Reimplemented from File.

Definition at line 267 of file LocalFile.php.

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

◆ __destruct()

LocalFile::__destruct ( )

Clean up any dangling locks.

Definition at line 2468 of file LocalFile.php.

Member Function Documentation

◆ acquireFileLock()

LocalFile::acquireFileLock ( )

Returns: Status

Since: 1.28

Definition at line 2376 of file LocalFile.php.

◆ decodeRow()

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

private

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 581 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.

Deprecated:: since 1.35, use deleteFile

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

References wfDeprecated().

◆ deleteFile()

LocalFile::deleteFile	(		$reason,
		User	$user,
			$suppress = `false`
	)

Delete all versions of the file.

Since: 1.35

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

Cache purging is done; logging is caller's responsibility. Stable to override

Parameters

string	$reason
User	$user
bool	$suppress

Returns: Status

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 2082 of file LocalFile.php.

Referenced by FileDeleteForm\doDelete().

◆ deleteOld()

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

Delete an old version of the file.

Deprecated:: since 1.35, use deleteOldFile

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

References wfDeprecated().

◆ deleteOldFile()

LocalFile::deleteOldFile	(		$archiveName,
			$reason,
		User	$user,
			$suppress = `false`
	)

Delete an old version of the file.

Since: 1.35 Stable to override

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
User	$user
bool	$suppress

Exceptions

MWException Exception on database or file store failure

Returns: Status

Definition at line 2171 of file LocalFile.php.

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. Stable to override

Returns: bool Whether file exist on disk.

Reimplemented from File.

Reimplemented in OldLocalFile.

Definition at line 1007 of file LocalFile.php.

References load().

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

◆ getBitDepth()

LocalFile::getBitDepth ( )

Stable to override.

Returns: int

Reimplemented from File.

Definition at line 956 of file LocalFile.php.

References load().

◆ getCacheFields()

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

protected

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

Stable to override

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

Referenced by loadFromCache(), and setProps().

◆ getCacheKey()

LocalFile::getCacheKey ( )

protected

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

Stable to override

Returns: string|bool

Reimplemented in OldLocalFile.

Definition at line 293 of file LocalFile.php.

References File\getName().

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

◆ getDescription()

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

Stable to override.

Parameters

int	$audience
User \| null	$user

Returns: string

Reimplemented from File.

Definition at line 2288 of file LocalFile.php.

Referenced by RevDelFileItem\getApiData().

◆ getDescriptionShortUrl()

LocalFile::getDescriptionShortUrl ( )

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

Stable to override

Returns: string|null

Since: 1.27

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 926 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.

Stable to override

Parameters

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

Returns: string|false

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 2259 of file LocalFile.php.

References $lang.

◆ getDescriptionTouched()

LocalFile::getDescriptionTouched ( )

Stable to override.

Returns: bool|string

Reimplemented from File.

Definition at line 2315 of file LocalFile.php.

References wfTimestamp().

◆ getDescriptionUrl()

LocalFile::getDescriptionUrl ( )

isMultipage inherited

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

Returns: string|bool

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 2242 of file LocalFile.php.

◆ getHeight()

LocalFile::getHeight ( $page = 1 )

Return the height of the image Stable to override.

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 859 of file LocalFile.php.

References File\$handler, 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 Stable to override

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

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

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 429 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. Stable to override

Returns: string

Reimplemented from File.

Definition at line 990 of file LocalFile.php.

References load().

◆ getMetadata()

LocalFile::getMetadata ( )

Get handler-specific metadata Stable to override.

Returns: string

Reimplemented from File.

Definition at line 947 of file LocalFile.php.

References load().

Referenced by maybeUpgradeRow().

◆ getMimeType()

LocalFile::getMimeType ( )

Returns the MIME type of the file.

Stable to override

Returns: string

Reimplemented from File.

Definition at line 978 of file LocalFile.php.

References $mime, and load().

◆ getMutableCacheKeys()

LocalFile::getMutableCacheKeys ( WANObjectCache $cache )

Parameters

WANObjectCache $cache

Returns: string[]

Since: 1.28

Definition at line 302 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 Stable to override

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

◆ getRepo()

LocalFile::getRepo ( )

Returns: LocalRepo|bool

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 283 of file LocalFile.php.

Referenced by LocalFileMoveBatch\__construct(), and upload().

◆ getSha1()

LocalFile::getSha1 ( )

Stable to override.

Returns: string

Reimplemented from File.

Definition at line 2339 of file LocalFile.php.

References wfReadOnly().

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

◆ getSize()

LocalFile::getSize ( )

Returns the size of the image file, in bytes Stable to override.

Returns: int

Reimplemented from File.

Definition at line 967 of file LocalFile.php.

References load().

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

◆ getThumbnails()

LocalFile::getThumbnails ( $archiveName = false )

protected

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 Stable to override

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

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

Referenced by purgeOldThumbnails(), and purgeThumbnails().

◆ getTimestamp()

LocalFile::getTimestamp ( )

Stable to override.

Returns: bool|string

Reimplemented from File.

Definition at line 2305 of file LocalFile.php.

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

◆ getUpgraded()

LocalFile::getUpgraded ( )

Returns: bool Whether upgradeRow() ran for this object

Definition at line 703 of file LocalFile.php.

◆ getUser()

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

Returns user who uploaded the file Stable to override.

Parameters

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

Returns: int|string|User

Since: 1.31 Added 'object'

Reimplemented from File.

Definition at line 893 of file LocalFile.php.

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

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

◆ getWidth()

LocalFile::getWidth ( $page = 1 )

Return the width of the image Stable to override.

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 826 of file LocalFile.php.

References File\$handler, 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 378 of file LocalFile.php.

References getCacheKey().

Referenced by purgeMetadataCache(), and upgradeRow().

◆ isCacheable()

LocalFile::isCacheable ( )

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

Reimplemented from File.

Definition at line 2364 of file LocalFile.php.

References 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. Stable to override

Returns: bool

Reimplemented from File.

Definition at line 810 of file LocalFile.php.

References File\getVirtualUrl().

◆ load()

LocalFile::load ( $flags = 0 )

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

Parameters

int $flags

Reimplemented from File.

Definition at line 646 of file LocalFile.php.

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

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

◆ loadExtraFieldsWithTimestamp()

LocalFile::loadExtraFieldsWithTimestamp	(	$dbr,
		$fname
	)

private

Parameters

IDatabase	$dbr
string	$fname

Returns: string[]|bool

Definition at line 507 of file LocalFile.php.

References $dbr, File\getName(), OldLocalFile\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. Stable to override

Reimplemented in OldLocalFile.

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

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

Referenced by load().

◆ loadFromDB()

LocalFile::loadFromDB ( $flags = 0 )

protected

Load file metadata from the DB Stable to override.

Parameters

int $flags

Reimplemented in OldLocalFile.

Definition at line 445 of file LocalFile.php.

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

Referenced by load(), and loadFromCache().

◆ loadFromFile()

LocalFile::loadFromFile ( )

protected

Load metadata from the file itself.

Definition at line 395 of file LocalFile.php.

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

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

◆ loadFromRow()

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

Load file metadata from a DB result row Stable to override.

Parameters

object	$row
string	$prefix

Definition at line 628 of file LocalFile.php.

References File\$name, and decodeRow().

Referenced by loadFromDB(), and OldLocalFile\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 2401 of file LocalFile.php.

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

◆ maybeUpgradeRow()

LocalFile::maybeUpgradeRow ( )

protected

Upgrade a row if it needs it.

Definition at line 664 of file LocalFile.php.

References File\$handler, $wgUpdateCompatibleMetadata, 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

Stable to override

Parameters

Title $target New file name

Returns: Status

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1994 of file LocalFile.php.

References 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.

Stable to override

Parameters

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

Returns: bool|LocalFile

Reimplemented in OldLocalFile.

Definition at line 195 of file LocalFile.php.

References $dbr, and File\$repo.

◆ newFromRow()

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

static

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

Stable to override

Parameters

stdClass	$row
FileRepo	$repo

Returns: static

Reimplemented in OldLocalFile.

Definition at line 176 of file LocalFile.php.

References $file, File\$repo, $title, 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

Stable to override

Parameters

Title	$title
FileRepo	$repo
null	$unused

Returns: static

Reimplemented in OldLocalFile.

Definition at line 161 of file LocalFile.php.

References File\$repo, and $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 Stable to override

Returns: stdClass|bool

Reimplemented from File.

Definition at line 1284 of file LocalFile.php.

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

◆ prerenderThumbnails()

LocalFile::prerenderThumbnails ( )

Prerenders a configurable set of thumbnails Stable to override.

Since: 1.28

Definition at line 1156 of file LocalFile.php.

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

◆ 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.

Stable to override

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

Referenced by upload().

◆ publishTo()

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

protected

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.

Stable to override

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

References File\DELETE_SOURCE, FileRepo\DELETE_SOURCE, FSFile\getSha1Base36FromPath(), FileRepo\isVirtualUrl(), and wfTimestamp().

Referenced by OldLocalFile\uploadOld().

◆ purgeCache()

LocalFile::purgeCache ( $options = [] )

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

Stable to override

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

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

◆ purgeMetadataCache()

LocalFile::purgeMetadataCache ( )

private

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

Definition at line 1054 of file LocalFile.php.

References invalidateCache().

Referenced by purgeCache().

◆ purgeOldThumbnails()

LocalFile::purgeOldThumbnails ( $archiveName )

Delete cached transformed files for an archived version only.

Stable to override

Parameters

string $archiveName Name of the archived file

Definition at line 1089 of file LocalFile.php.

References File\getArchiveThumbUrl(), getThumbnails(), and purgeThumbList().

Referenced by PurgeChangedFiles\purgeFromArchiveTable().

◆ purgeThumbList()

LocalFile::purgeThumbList	(	$dir,
		$files
	)

protected

Delete a list of thumbnails visible at urls Stable to override.

Parameters

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

Definition at line 1184 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.

Stable to override

Parameters

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

Definition at line 1116 of file LocalFile.php.

References File\$handler, MediaHandler\filterThumbnailPurgeList(), File\getHandler(), getThumbnails(), File\getThumbUrl(), and purgeThumbList().

Referenced by purgeCache().

◆ readOnlyFatalStatus()

LocalFile::readOnlyFatalStatus ( )

protected

Returns: Status

Definition at line 2460 of file LocalFile.php.

Referenced by 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.

Deprecated:: since 1.35

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

References $source, User\addWatch(), getTitle(), recordUpload2(), and wfDeprecated().

◆ 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.

Deprecated:: since 1.35

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

References recordUpload3().

Referenced by recordUpload(), and upload().

◆ recordUpload3()

LocalFile::recordUpload3	(	string	$oldver,
		string	$comment,
		string	$pageText,
		User	$user,
			$props = `false`,
			$timestamp = `false`,
			$tags = `[]`,
		bool	$createNullRevision = `true`,
		bool	$revert = `false`
	)

Record a file upload in the upload log and the image table (version 3)

Since: 1.35 Stable to override

Parameters

string	$oldver
string	$comment
string	$pageText
User	$user
bool \| array	$props
string \| bool	$timestamp
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 1531 of file LocalFile.php.

Referenced by recordUpload2().

◆ releaseFileLock()

LocalFile::releaseFileLock ( )

Returns: Status

Since: 1.28

Definition at line 2386 of file LocalFile.php.

◆ resetHistory()

LocalFile::resetHistory ( )

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

Reimplemented from File.

Definition at line 1332 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. Stable to override

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

◆ setProps()

LocalFile::setProps ( $info )

protected

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.

Stable to override

Parameters

array $info

Definition at line 767 of file LocalFile.php.

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

Referenced by loadFromCache(), and loadFromFile().

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

Referenced by 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 556 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 Stable to override.

Reimplemented from File.

Reimplemented in OldLocalFile.

Definition at line 711 of file LocalFile.php.

References File\getName(), invalidateCache(), loadFromFile(), lock(), 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 1373 of file LocalFile.php.

References File\$handler, MediaHandler\getContentHeaders(), MediaHandler\getHandler(), 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 74 of file LocalFile.php.

◆ $dataLoaded

bool LocalFile::$dataLoaded

protected

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

Definition at line 92 of file LocalFile.php.

◆ $deleted

int LocalFile::$deleted

◆ $repoClass

string LocalFile::$repoClass = LocalRepo::class

protected

Definition at line 101 of file LocalFile.php.

◆ $sha1

string LocalFile::$sha1

protected

SHA-1 base 36 content hash.

Definition at line 89 of file LocalFile.php.

Referenced by OldLocalFile\newFromKey().

◆ $size

int LocalFile::$size

protected

Size in bytes (loadFromXxx)

Definition at line 83 of file LocalFile.php.

◆ $timestamp

string LocalFile::$timestamp

private

Upload timestamp.

Definition at line 116 of file LocalFile.php.

Referenced by OldLocalFile\newFromKey(), OldLocalFile\recordOldUpload(), and OldLocalFile\uploadOld().

◆ $upgraded

bool LocalFile::$upgraded

private

Whether the row was upgraded on load.

Definition at line 128 of file LocalFile.php.

◆ $upgrading

bool LocalFile::$upgrading

private

Whether the row was scheduled to upgrade on load.

Definition at line 131 of file LocalFile.php.

◆ $user

User LocalFile::$user

private

Uploader.

Definition at line 119 of file LocalFile.php.

Referenced by OldLocalFile\recordOldUpload(), OldLocalFile\uploadOld(), and OldLocalFile\userCan().

◆ $width

int LocalFile::$width

protected

Image width.

Definition at line 68 of file LocalFile.php.

◆ ATOMIC_SECTION_LOCK

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

private

Definition at line 145 of file LocalFile.php.

◆ CACHE_FIELD_MAX_LEN

const LocalFile::CACHE_FIELD_MAX_LEN = 1000

private

Definition at line 62 of file LocalFile.php.

◆ LOAD_ALL

const LocalFile::LOAD_ALL = 16

private

Definition at line 143 of file LocalFile.php.

◆ VERSION

const LocalFile::VERSION = 12

private

Definition at line 60 of file LocalFile.php.

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

includes/filerepo/file/LocalFile.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ acquireFileLock()

◆ decodeRow()

◆ delete()

◆ deleteFile()

◆ deleteOld()

◆ deleteOldFile()

◆ exists()

◆ getBitDepth()

◆ getCacheFields()

◆ getCacheKey()

◆ getDescription()

◆ getDescriptionShortUrl()

◆ getDescriptionText()

◆ getDescriptionTouched()

◆ getDescriptionUrl()

◆ getHeight()

◆ getHistory()

◆ getLazyCacheFields()

◆ getMediaType()

◆ getMetadata()

◆ getMimeType()

◆ getMutableCacheKeys()

◆ getQueryInfo()

◆ getRepo()

◆ 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()

◆ recordUpload3()

◆ releaseFileLock()

◆ resetHistory()

◆ restore()

◆ setProps()

◆ unlock()

◆ unprefixRow()

◆ upgradeRow()

◆ upload()