LocalFile Class Reference

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

Inheritance diagram for LocalFile:

Collaboration diagram for LocalFile:

Public Member Functions
	__construct ($title, $repo)
	Constructor. More...
	__destruct ()
	Clean up any dangling locks. More...
	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 ()
	getCacheFields ($prefix= 'img_')
	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 ($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...
	getLazyCacheFields ($prefix= 'img_')
	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...
	getSha1 ()
	getSize ()
	Returns the size of the image file, in bytes. More...
	getThumbnails ($archiveName=false)
	getTransformScript inherited More...
	getTimestamp ()
	getUpgraded ()
	getUser ($type= 'text')
	Returns ID or name of 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 a transaction and lock the image for update Increments a reference counter if the lock is already held. More...
	maybeUpgradeRow ()
	Upgrade a row if it needs it. More...
	move ($target)
	getLinksTo inherited More...
	nextHistoryLine ()
	Returns the history of this file, line by line. 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=[])
	Record a file upload in the upload log and the image table. More...
	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. More...
	unlockAndRollback ()
	Roll back the DB transaction and mark the image unlocked. 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=[])
	getHashPath inherited More...
Public Member Functions inherited from File
	__construct ($title, $repo)
	Call this constructor from child classes. More...
	__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...
	delete ($reason, $suppress=false, $user=null)
	Delete all versions of the file. More...
	exists ()
	Returns true if file exists in the repository. 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...
	getBitDepth ()
	Return the bit depth of the file Overridden by LocalFile STUB. More...
	getCanonicalUrl ()
	getCommonMetaArray ()
	Like getMetadata but returns a handler independent array of common values. More...
	getDefaultRenderLanguage ()
	In files that support multiple language, what is the default language to use if none specified. More...
	getDescription ($audience=self::FOR_PUBLIC, User $user=null)
	Get description of file revision STUB. More...
	getDescriptionShortUrl ()
	getDescriptionText ($lang=false)
	Get the HTML text of the description page, if available. More...
	getDescriptionTouched ()
	Returns the timestamp (in TS_MW format) of the last change of the description page. More...
	getDescriptionUrl ()
	Get the URL of the image description page. 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...
	getHeight ($page=1)
	Return the height of the image. More...
	getHistory ($limit=null, $start=null, $end=null, $inc=true)
	Return a fragment of the history of file. 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 ()
	getMediaType ()
	Return the type of the media in the file. More...
	getMetadata ()
	Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB. More...
	getMimeType ()
	Returns the MIME type of the file. 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...
	getSha1 ()
	Get the SHA-1 base 36 hash of the file. More...
	getShortDesc ()
	getSize ()
	Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB. More...
	getStorageKey ()
	Get the deletion archive key, "<sha1>.<ext>". More...
	getStreamHeaders ()
	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...
	getTimestamp ()
	Get the 14-character timestamp of the file upload. 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...
	getUser ($type= 'text')
	Returns ID or name of user who uploaded the file STUB. 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...
	getWidth ($page=1)
	Return the width of the image. 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...
	isCacheable ()
	Check if this file object is small and can be cached. 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...
	isMissing ()
	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...
	load ($flags=0)
	Load any lazy-loaded file object fields from source. More...
	migrateThumbFile ($thumbName)
	Hook into transform() to allow migration of thumbnail files STUB Overridden by LocalFile. More...
	move ($target)
	Move file to the new title. 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...
	nextHistoryLine ()
	Return the history of this file, line by line. More...
	pageCount ()
	Returns the number of pages of a multipage document, or false for documents which aren't multipage documents. More...
	publish ($src, $flags=0, array $options=[])
	Move or copy a file to its public location. More...
	purgeCache ($options=[])
	Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile. 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 ()
	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 STUB Overridden by LocalFile. More...
	redirectedFrom ($from)
	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...
	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...
	upgradeRow ()
	Upgrade the database row if there is one Called by ImagePage STUB. 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	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	selectFields ()
	Fields in the image table. 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	CACHE_FIELD_MAX_LEN = 1000
const	LOAD_ALL = 16
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_EXCLUSIVE = 7
const	READ_LATEST = 1
const	READ_LOCKING = 3
const	READ_NONE = -1
const	READ_NORMAL = 0

Protected Member Functions
	loadExtraFromDB ()
	Load lazy file metadata from the DB. 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 MimeMagic::guessMimeType. More...
string	$repoClass = 'LocalRepo'
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	$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'
	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
	loadFieldsWithTimestamp ($dbr, $fname)
	loadFromCache ()
	Try to load file metadata from memcached. More...
	saveToCache ()
	Save the file metadata to memcached. 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...
int	$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...
int	$user
	User ID of uploader. More...
string	$user_text
	User name of 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 );

The convenience functions wfLocalFile() and wfFindFile() should be sufficient in most cases.

Definition at line 46 of file LocalFile.php.

Constructor & Destructor Documentation

LocalFile::__construct	(		$title,
			$repo
	)

Constructor.

Do not call this except from inside a repo class.

Parameters

Title	$title
FileRepo	$repo

Definition at line 217 of file LocalFile.php.

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

LocalFile::__destruct

(

)

Clean up any dangling locks.

Definition at line 1978 of file LocalFile.php.

References unlock().

Member Function Documentation

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

References as, TS_MW, unprefixRow(), and wfTimestamp().

Referenced by loadFromRow().

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

FileRepoStatus

Definition at line 1674 of file LocalFile.php.

References $batch, $status, DeferredUpdates\addUpdate(), as, SiteStatsUpdate\factory(), false, File\getArchiveUrl(), File\getRepo(), lock(), DeferredUpdates\PRESEND, readOnlyFatalStatus(), unlock(), and use.

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

FileRepoStatus

Definition at line 1729 of file LocalFile.php.

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

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.

Definition at line 839 of file LocalFile.php.

References $fileExists, and load().

Referenced by publishTo(), and PurgeChangedFiles\purgeFromArchiveTable().

LocalFile::getBitDepth

(

)

Returns

int

Definition at line 792 of file LocalFile.php.

References $bits, and load().

LocalFile::getCacheFields

(

$prefix = 'img_'

)

Parameters

string

$prefix

Returns

array

Definition at line 335 of file LocalFile.php.

References as.

Referenced by loadFromDB(), saveToCache(), and setProps().

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

Definition at line 235 of file LocalFile.php.

References File\getName().

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

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

Parameters

int	$audience
User	$user

Returns

string

Definition at line 1830 of file LocalFile.php.

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

LocalFile::getDescriptionShortUrl

(

)

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

Returns

string|null

Exceptions

MWException

Since

1.27

Definition at line 768 of file LocalFile.php.

References File\$url, and title.

LocalFile::getDescriptionText

(

$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

$lang

What language to get description in (Optional)

Returns

bool|mixed

Definition at line 1811 of file LocalFile.php.

References $content, $lang, Revision\newFromTitle(), IDBAccessObject\READ_NORMAL, and title.

LocalFile::getDescriptionTouched

(

)

Returns

bool|string

Definition at line 1855 of file LocalFile.php.

References $descriptionTouched, title, TS_MW, and wfTimestamp().

LocalFile::getDescriptionUrl

(

)

isMultipage inherited

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

Returns

string

Definition at line 1799 of file LocalFile.php.

References title.

LocalFile::getHeight

(

$page = 1

)

Return the height of the image.

Parameters

int

$page

Returns

int

Definition at line 724 of file LocalFile.php.

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

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

purgeDescription inherited

purgeEverything inherited

Parameters

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

Returns

OldLocalFile[]

Definition at line 1002 of file LocalFile.php.

References $dbr, $limit, $res, $tables, as, Hooks\run(), OldLocalFile\selectFields(), and title.

LocalFile::getLazyCacheFields

(

$prefix = 'img_'

)

Parameters

string

$prefix

Returns

array

Definition at line 360 of file LocalFile.php.

References as.

Referenced by OldLocalFile\loadExtraFromDB(), loadFieldsWithTimestamp(), loadFromCache(), and saveToCache().

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

Definition at line 823 of file LocalFile.php.

References $media_type, and load().

LocalFile::getMetadata

(

)

Get handler-specific metadata.

Returns

string

Definition at line 784 of file LocalFile.php.

References $metadata, and load().

Referenced by maybeUpgradeRow().

LocalFile::getMimeType

(

)

Returns the MIME type of the file.

Returns

string

Definition at line 812 of file LocalFile.php.

References $mime, and load().

LocalFile::getSha1

(

)

Returns

string

Definition at line 1874 of file LocalFile.php.

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

LocalFile::getSize

(

)

Returns the size of the image file, in bytes.

Returns

int

Definition at line 802 of file LocalFile.php.

References $size, and load().

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

References $dir, $e, $files, as, File\getArchiveThumbPath(), and File\getThumbPath().

LocalFile::getTimestamp

(

)

Returns

bool|string

Definition at line 1846 of file LocalFile.php.

References $timestamp, and load().

Referenced by loadFieldsWithTimestamp().

LocalFile::getUpgraded

(

)

Definition at line 589 of file LocalFile.php.

References $upgraded.

LocalFile::getUser

(

$type = 'text'

)

Returns ID or name of user who uploaded the file.

Parameters

string

$type

'text' or 'id'

Returns

int|string

Definition at line 751 of file LocalFile.php.

References $type, $user, $user_text, and load().

LocalFile::getWidth

(

$page = 1

)

Return the width of the image.

Parameters

int

$page

Returns

int

Definition at line 697 of file LocalFile.php.

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

LocalFile::invalidateCache

(

)

Purge the file object/metadata cache.

Definition at line 312 of file LocalFile.php.

References $key, getCacheKey(), ObjectCache\getMainWANInstance(), and use.

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

LocalFile::isCacheable

(

)

Returns

bool Whether to cache in RepoGroup (this avoids OOMs)

Definition at line 1899 of file LocalFile.php.

References load(), and serialize().

LocalFile::isMissing

(

)

splitMime inherited

getName inherited getTitle inherited getURL inherited getViewURL inherited getPath inherited isVisible inherited

Returns

bool

Definition at line 682 of file LocalFile.php.

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

LocalFile::load

(

$flags = 0

)

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

Parameters

int

$flags

Definition at line 539 of file LocalFile.php.

References $flags, loadExtraFromDB(), loadFromCache(), loadFromDB(), and saveToCache().

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

LocalFile::loadExtraFromDB ( )

protected

Load lazy file metadata from the DB.

This covers fields that are sometimes not cached.

Definition at line 408 of file LocalFile.php.

References $fname, File\$name, $value, as, and loadFieldsWithTimestamp().

Referenced by load().

LocalFile::loadFieldsWithTimestamp (   $dbr,   $fname  )

private

Parameters

IDatabase	$dbr
string	$fname

Returns

array|bool

Definition at line 433 of file LocalFile.php.

References $dbr, $fname, getLazyCacheFields(), File\getName(), getTimestamp(), and unprefixRow().

Referenced by loadExtraFromDB().

LocalFile::loadFromCache ( )

private

Try to load file metadata from memcached.

Returns true on success.

Returns

bool

Definition at line 245 of file LocalFile.php.

References $cache, $dataLoaded, $key, as, getCacheKey(), getLazyCacheFields(), ObjectCache\getMainWANInstance(), MW_FILE_VERSION, and setProps().

Referenced by load().

LocalFile::loadFromDB

(

$flags = 0

)

Load file metadata from the DB.

Parameters

int

$flags

Definition at line 383 of file LocalFile.php.

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

Referenced by load().

LocalFile::loadFromFile

(

)

Load metadata from the file itself.

Definition at line 326 of file LocalFile.php.

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

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

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

Load file metadata from a DB result row.

Parameters

object	$row
string	$prefix

Definition at line 521 of file LocalFile.php.

References File\$name, $value, as, decodeRow(), and maybeUpgradeRow().

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

LocalFile::lock

(

)

Start a transaction and lock the image for update Increments a reference counter if the lock is already held.

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

References $lockedOwnTrx, $status, File\getPath(), File\getRepo(), LockManager\LOCK_EX, and use.

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

LocalFile::maybeUpgradeRow

(

)

Upgrade a row if it needs it.

Definition at line 556 of file LocalFile.php.

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

Referenced by loadFromRow().

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

FileRepoStatus

Definition at line 1619 of file LocalFile.php.

References $batch, $status, as, File\getRepo(), lock(), name, readOnlyFatalStatus(), title, unlock(), use, wfDebugLog(), and wfLocalFile().

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

Definition at line 172 of file LocalFile.php.

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

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

LocalFile

Definition at line 155 of file LocalFile.php.

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

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

LocalFile

Definition at line 142 of file LocalFile.php.

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

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

bool

Definition at line 1055 of file LocalFile.php.

References $dbr, $fname, and title.

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 FileRepoStatus 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

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

Definition at line 1541 of file LocalFile.php.

References $flags, $options, File\getRel(), and publishTo().

Referenced by upload().

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

Move or copy a file to a specified location.

Returns a FileRepoStatus 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

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

Definition at line 1560 of file LocalFile.php.

References $flags, $options, File\$repo, $status, FileRepo\DELETE_SOURCE, File\DELETE_SOURCE, exists(), false, FileRepo\getBackend(), FileRepo\getFileSha1(), File\getHashPath(), File\getName(), FileRepo\getReadOnlyReason(), File\getRepo(), FSFile\getSha1Base36FromPath(), FileRepo\hasSha1Storage(), FileRepo\isVirtualUrl(), lock(), FileRepo\publish(), FileRepo\quickImport(), readOnlyFatalStatus(), TS_MW, unlock(), and wfTimestamp().

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

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.

Definition at line 894 of file LocalFile.php.

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

LocalFile::purgeMetadataCache

(

)

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

Definition at line 883 of file LocalFile.php.

References invalidateCache().

Referenced by purgeCache().

LocalFile::purgeOldThumbnails

(

$archiveName

)

Delete cached transformed files for an archived version only.

Parameters

string

$archiveName

Name of the archived file

Definition at line 912 of file LocalFile.php.

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

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

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

References $dir, $files, as, File\getName(), and wfDebug().

Referenced by purgeOldThumbnails(), and purgeThumbnails().

LocalFile::purgeThumbnails

(

$options = []

)

Delete cached transformed files for the current version only.

Parameters

array

$options

Definition at line 935 of file LocalFile.php.

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

Referenced by purgeCache().

LocalFile::readOnlyFatalStatus ( )

protected

Returns

Status

Definition at line 1970 of file LocalFile.php.

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

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

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

Definition at line 1198 of file LocalFile.php.

References $license, $source, $wgUser, SpecialUpload\getInitialPageText(), File\getTitle(), global, and recordUpload2().

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

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

Returns

bool

Definition at line 1229 of file LocalFile.php.

References $comment, $rev, $sha1, $status, $user, $wgUser, DeferredUpdates\addUpdate(), EDIT_NEW, EDIT_SUPPRESS_RC, SiteStatsUpdate\factory(), File\getName(), File\getRel(), File\getTitle(), File\getVirtualUrl(), global, ContentHandler\makeContent(), LogEntryBase\makeParamBlob(), RequestContext\newExtraneousContext(), LogFormatter\newFromEntry(), Revision\newNullRevision(), DeferredUpdates\PRESEND, Article\purgePatrolFooterCache(), LinksUpdate\queueRecursiveJobsForTable(), Hooks\run(), setProps(), TS_MW, TS_UNIX, use, wfDebug(), wfTimestamp(), and width.

Referenced by recordUpload(), and upload().

LocalFile::resetHistory

(

)

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

Definition at line 1093 of file LocalFile.php.

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

FileRepoStatus

Definition at line 1765 of file LocalFile.php.

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

LocalFile::saveToCache ( )

private

Save the file metadata to memcached.

Definition at line 276 of file LocalFile.php.

References $fileExists, $key, as, getCacheFields(), getCacheKey(), DatabaseBase\getCacheSetOptions(), getLazyCacheFields(), ObjectCache\getMainWANInstance(), load(), and MW_FILE_VERSION.

Referenced by load().

static LocalFile::selectFields ( )

static

Fields in the image table.

Returns

array

Definition at line 192 of file LocalFile.php.

Referenced by LocalRepo\findBySha1(), LocalRepo\findBySha1s(), LocalRepo\findFiles(), LocalRepo\findFilesByPrefix(), and ApiQueryAllImages\run().

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

References as, getCacheFields(), and list.

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

LocalFile::unlock

(

)

Decrement the lock reference count.

If the reference count is reduced to zero, commits the transaction and thereby releases the image lock.

Definition at line 1946 of file LocalFile.php.

References $locked.

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

LocalFile::unlockAndRollback

(

)

Roll back the DB transaction and mark the image unlocked.

Definition at line 1960 of file LocalFile.php.

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

protected

Parameters

array | object	$row
string	$prefix

Exceptions

MWException

Returns

array

Definition at line 460 of file LocalFile.php.

References File\$name, $value, array(), as, and key.

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

LocalFile::upgradeRow

(

)

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

Definition at line 596 of file LocalFile.php.

References $sha1, File\getName(), invalidateCache(), list, loadFromFile(), lock(), unlock(), wfDebug(), wfReadOnly(), and width.

Referenced by maybeUpgradeRow().

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

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

Returns

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

Definition at line 1131 of file LocalFile.php.

References $comment, $flags, File\$handler, $options, $status, $wgContLang, MediaHandler\getHandler(), FSFile\getPropsFromPath(), File\getRepo(), MediaHandler\getStreamHeaders(), global, FileBackend\isStoragePath(), lock(), publish(), readOnlyFatalStatus(), recordUpload2(), and unlock().

Member Data Documentation

int LocalFile::$bits

protected

Returned by getimagesize (loadFromXxx)

Definition at line 59 of file LocalFile.php.

Referenced by getBitDepth().

bool LocalFile::$dataLoaded

protected

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

Definition at line 77 of file LocalFile.php.

Referenced by loadFromCache().

int LocalFile::$deleted

protected

Bitfield akin to rev_deleted.

Definition at line 83 of file LocalFile.php.

Referenced by OldLocalFile\getVisibility().

string LocalFile::$description

private

Description of current revision of the file.

Definition at line 110 of file LocalFile.php.

Referenced by getDescription().

string LocalFile::$descriptionTouched

private

TS_MW timestamp of the last change of the file description.

Definition at line 113 of file LocalFile.php.

Referenced by getDescriptionTouched().

bool LocalFile::$extraDataLoaded

protected

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

Definition at line 80 of file LocalFile.php.

bool LocalFile::$fileExists

protected

Does the file exist on disk? (loadFromXxx)

Definition at line 50 of file LocalFile.php.

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

int LocalFile::$height

protected

Image height.

Definition at line 56 of file LocalFile.php.

Referenced by getHeight().

int LocalFile::$historyLine

private

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

Definition at line 89 of file LocalFile.php.

int LocalFile::$historyRes

private

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

Definition at line 92 of file LocalFile.php.

bool LocalFile::$locked

private

True if the image row is locked.

Definition at line 119 of file LocalFile.php.

Referenced by unlock().

bool LocalFile::$lockedOwnTrx

private

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

Definition at line 122 of file LocalFile.php.

Referenced by lock().

string LocalFile::$major_mime

private

Major MIME type.

Definition at line 95 of file LocalFile.php.

string LocalFile::$media_type

protected

MEDIATYPE_xxx (bitmap, drawing, audio...)

Definition at line 62 of file LocalFile.php.

Referenced by getMediaType().

string LocalFile::$metadata

protected

Handler-specific metadata.

Definition at line 71 of file LocalFile.php.

Referenced by getMetadata().

string LocalFile::$mime

protected

MIME type, determined by MimeMagic::guessMimeType.

Definition at line 65 of file LocalFile.php.

Referenced by getMimeType().

string LocalFile::$minor_mime

private

Minor MIME type.

Definition at line 98 of file LocalFile.php.

bool LocalFile::$missing

private

True if file is not present in file system.

Not to be cached in memcached

Definition at line 125 of file LocalFile.php.

Referenced by isMissing().

string LocalFile::$repoClass = 'LocalRepo'

protected

Definition at line 86 of file LocalFile.php.

string LocalFile::$sha1

protected

SHA-1 base 36 content hash.

Definition at line 74 of file LocalFile.php.

Referenced by getSha1(), OldLocalFile\newFromKey(), newFromKey(), recordUpload2(), and upgradeRow().

int LocalFile::$size

protected

Size in bytes (loadFromXxx)

Definition at line 68 of file LocalFile.php.

Referenced by getSize().

string LocalFile::$timestamp

private

Upload timestamp.

Definition at line 101 of file LocalFile.php.

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

bool LocalFile::$upgraded

private

Whether the row was upgraded on load.

Definition at line 116 of file LocalFile.php.

Referenced by getUpgraded().

int LocalFile::$user

private

User ID of uploader.

Definition at line 104 of file LocalFile.php.

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

string LocalFile::$user_text

private

User name of uploader.

Definition at line 107 of file LocalFile.php.

Referenced by getUser().

int LocalFile::$width

protected

Image width.

Definition at line 53 of file LocalFile.php.

Referenced by getWidth().

const LocalFile::CACHE_FIELD_MAX_LEN = 1000

Definition at line 47 of file LocalFile.php.

const LocalFile::LOAD_ALL = 16

Definition at line 128 of file LocalFile.php.

---

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

• includes/filerepo/file/LocalFile.php