Implements some public methods and some protected utility functions which are required by multiple child classes. More...

Inheritance diagram for File:

[legend]

Collaboration diagram for File:

[legend]

Public Member Functions
	__construct ( $title, $repo)
	Call this constructor from child classes.

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

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

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

	exists ()
	Returns true if file exists in the repository.

	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.

	getBitDepth ()
	Return the bit depth of the file Overridden by LocalFile STUB Stable to override.

	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.

	getDescription ( $audience=self::FOR_PUBLIC, User $user=null)
	Get description of file revision STUB.

	getDescriptionShortUrl ()
	Get short description URL for a files based on the page ID Stable to override.

	getDescriptionText (Language $lang=null)
	Get the HTML text of the description page, if available Stable to override.

	getDescriptionTouched ()
	Returns the timestamp (in TS_MW format) of the last change of the description page.

	getDescriptionUrl ()
	Get the URL of the image description page.

	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.

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

	getHistory ( $limit=null, $start=null, $end=null, $inc=true)
	Return a fragment of the history of file.

	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.

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

	getMetadata ()
	Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB Stable to override.

	getMimeType ()
	Returns the MIME type of the file.

	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.

	getRepo ()
	Returns the repository Stable to override.

	getRepoName ()
	Returns the name of the repository.

	getSha1 ()
	Get the SHA-1 base 36 hash of the file.

	getShortDesc ()

	getSize ()
	Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB Stable to override.

	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.

	getTimestamp ()
	Get the 14-character timestamp of the file upload.

	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.

	getUser ( $type='text')
	Returns ID or name of user who uploaded the file STUB.

	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.

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

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

	isCacheable ()
	Check if this file object is small and can be cached Stable to override.

	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.

	isMissing ()
	Stable to override.

	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.

	load ( $flags=0)
	Load any lazy-loaded file object fields from source.

	move ( $target)
	Move file to the new title.

	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.

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

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

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

	purgeCache ( $options=[])
	Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile Stable to override.

	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.

	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 Stable to override STUB Overridden by LocalFile.

	redirectedFrom ( $from)

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

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

	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.

	upgradeRow ()
	Upgrade the database row if there is one Called by ImagePage STUB.

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

Public Attributes
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

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

	getTransformScript ()

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

Detailed Description

Implements some public methods and some protected utility functions which are required by multiple child classes.

Contains stub functionality for unimplemented public methods.

Stub functions which should be overridden are marked with STUB. Some more concrete functions are also typically overridden by child classes.

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 63 of file File.php.

Constructor & Destructor Documentation

◆ __construct()

File::__construct	(	$title,
		$repo
	)

Call this constructor from child classes.

Both $title and $repo are optional, though some functions may return false or throw exceptions if they are not set. Most subclasses will want to call assertRepoDefined() here.

Stable to call

Parameters

Title \| string \| bool	$title
FileRepo \| bool	$repo

Reimplemented in LocalFile.

Definition at line 181 of file File.php.

References $title.

Member Function Documentation

◆ __get()

File::__get ( $name )

Definition at line 220 of file File.php.

◆ allowInlineDisplay()

File::allowInlineDisplay ( )

Alias for canRender()

Returns: bool

Definition at line 857 of file File.php.

References canRender().

Referenced by canAnimateThumbIfAppropriate(), and getIsSafeFileUncached().

◆ assertRepoDefined()

File::assertRepoDefined ( )

protected

Assert that $this->repo is set to a valid FileRepo instance.

Exceptions

MWException

Definition at line 2421 of file File.php.

Referenced by LocalFile\__construct(), ForeignAPIFile\__construct(), UnregisteredLocalFile\__construct(), getArchivePath(), getArchiveThumbPath(), getArchiveThumbUrl(), getArchiveUrl(), getArchiveVirtualUrl(), getHashPath(), getLocalRefPath(), getName(), getPath(), getSha1(), UnregisteredLocalFile\getSize(), getThumbPath(), getThumbVirtualUrl(), getTimestamp(), getTranscodedPath(), getUrl(), getVirtualUrl(), getZoneUrl(), and isHashed().

◆ assertTitleDefined()

File::assertTitleDefined ( )

protected

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

Exceptions

MWException

Definition at line 2431 of file File.php.

Referenced by LocalFile\__construct().

◆ canAnimateThumbIfAppropriate()

File::canAnimateThumbIfAppropriate ( )

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

Currently used to add a warning to the image description page

Returns: bool False if the main image is both animated and the thumbnail is not. In all other cases must return true. If image is not renderable whatsoever, should return true.

Definition at line 697 of file File.php.

References allowInlineDisplay(), MediaHandler\canAnimateThumbnail(), getHandler(), and MediaHandler\isAnimatedImage().

◆ canRender()

File::canRender ( )

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

If this is false, various user elements will display a placeholder instead.

Currently, this checks if the file is an image format that can be converted to a format supported by all browsers (namely GIF, PNG and JPEG), or if it is an SVG image and SVG conversion is enabled.

Returns: bool

Definition at line 821 of file File.php.

References canRender(), exists(), and getHandler().

Referenced by allowInlineDisplay(), canRender(), getCanRender(), getViewURL(), transform(), and ForeignAPIFile\transform().

◆ checkExtensionCompatibility()

static File::checkExtensionCompatibility	(	File	$old,
			$new
	)

static

Checks if file extensions are compatible.

Parameters

File	$old	Old file
string	$new	New name

Returns: bool|null

Definition at line 264 of file File.php.

References getMimeType().

◆ compare()

static File::compare	(	File	$a,
		File	$b
	)

static

Callback for usort() to do file sorts by name.

Parameters

File	$a
File	$b

Returns: int Result of name comparison

Definition at line 305 of file File.php.

References getName().

◆ convertMetadataVersion()

File::convertMetadataVersion	(	$metadata,
		$version
	)

get versioned metadata

Parameters

array \| string	$metadata	Array or string of (serialized) metadata
int	$version	Version number.

Returns: array Array containing metadata, or what was passed to it on fail (unserializing if not array)

Definition at line 750 of file File.php.

References MediaHandler\convertMetadataVersion(), getHandler(), and unserialize().

◆ createThumb()

File::createThumb	(	$width,
		$height = `-1`
	)

Create a thumbnail of the image having the specified width/height.

The thumbnail will not be created if the width is larger than the image's width. Let the browser do the scaling in this case. The thumbnail is stored on disk and is only computed if the thumbnail file does not exist OR if it is older than the image. Returns the URL.

Keeps aspect ratio of original image. If both width and height are specified, the generated image will be no bigger than width x height, and will also have correct aspect ratio.

Parameters

int	$width	Maximum width of the generated thumbnail
int	$height	Maximum height of the image (optional)

Returns: string

Definition at line 1084 of file File.php.

References transform().

Referenced by getViewURL().

◆ delete()

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

Delete all versions of the file.

Deprecated:: since 1.35, use deleteFile instead

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	Hide content from sysops?
User \| null	$user

Returns: Status STUB Overridden by LocalFile Stable to override

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2053 of file File.php.

References readOnlyError(), and wfDeprecated().

◆ deleteFile()

File::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.

Parameters

string	$reason
User	$user
bool	$suppress	Hide content from sysops?

Returns: Status STUB Overridden by LocalFile Stable to override

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2076 of file File.php.

References readOnlyError().

◆ exists()

File::exists ( )

Returns true if file exists in the repository.

Overridden by LocalFile to avoid unnecessary stat calls.

Stable to override

Returns: bool Whether file exists in the repository.

Reimplemented in ForeignAPIFile, LocalFile, OldLocalFile, and UploadStashFile.

Definition at line 966 of file File.php.

References getPath().

Referenced by canRender(), isVisible(), and OutputPage\setFileVersion().

◆ formatMetadata()

File::formatMetadata ( $context = false )

Parameters

bool | IContextSource $context Context to use (optional)

Returns: bool

Definition at line 1938 of file File.php.

References getHandler().

◆ generateAndSaveThumb()

File::generateAndSaveThumb	(	$tmpFile,
		$transformParams,
		$flags
	)

Generates a thumbnail according to the given parameters and saves it to storage.

Parameters

TempFSFile	$tmpFile	Temporary file where the rendered thumbnail will be saved
array	$transformParams
int	$flags

Returns: bool|MediaTransformOutput

Definition at line 1211 of file File.php.

References $wgIgnoreImageErrors, MediaHandler\doTransform(), generateBucketsIfNeeded(), getHandler(), getThumbDisposition(), getThumbPath(), getThumbUrl(), MediaHandler\getTransform(), MediaHandler\normaliseParams(), MediaHandler\supportsBucketing(), thumbName(), and transformErrorOutput().

Referenced by generateBucketsIfNeeded(), and transform().

◆ generateBucketsIfNeeded()

File::generateBucketsIfNeeded	(	$params,
		$flags = `0`
	)

protected

Generates chained bucketed thumbnails if needed.

Parameters

array	$params
int	$flags

Returns: bool Whether at least one bucket was generated

Definition at line 1279 of file File.php.

References generateAndSaveThumb(), getBucketThumbPath(), getHandler(), getThumbnailBucket(), and makeTransformTmpFile().

Referenced by generateAndSaveThumb().

◆ generateThumbName()

File::generateThumbName	(	$name,
		$params
	)

Generate a thumbnail file name from a name and specified parameters Stable to override.

Parameters

string	$name
array	$params	Parameters which will be passed to MediaHandler::makeParamString

Returns: string|null

Definition at line 1045 of file File.php.

References getExtension(), getHandler(), getMimeType(), and getSha1().

Referenced by thumbName(), and UploadStashFile\thumbName().

◆ getArchivePath()

File::getArchivePath ( $suffix = false )

Get the path of the archived file.

Parameters

bool | string $suffix If not false, the name of an archived file.

Returns: string

Definition at line 1691 of file File.php.

References assertRepoDefined(), and getArchiveRel().

◆ getArchiveRel()

File::getArchiveRel ( $suffix = false )

Get the path of an archived file relative to the public zone root Stable to override.

Parameters

bool | string $suffix If not false, the name of an archived thumbnail file

Returns: string

Definition at line 1629 of file File.php.

References $path, and getHashPath().

Referenced by getArchivePath(), getArchiveThumbRel(), OldLocalFile\getRel(), OldLocalFile\getUrlRel(), and OldLocalFile\uploadOld().

◆ getArchiveThumbPath()

File::getArchiveThumbPath	(	$archiveName,
		$suffix = `false`
	)

Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified.

Parameters

string	$archiveName	The timestamped name of an archived image
bool \| string	$suffix	If not false, the name of a thumbnail file

Returns: string

Definition at line 1704 of file File.php.

References assertRepoDefined(), and getArchiveThumbRel().

Referenced by LocalFile\getThumbnails().

◆ getArchiveThumbRel()

File::getArchiveThumbRel	(	$archiveName,
		$suffix = `false`
	)

private

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.

Parameters

string	$archiveName	The timestamped name of an archived image
bool \| string	$suffix	If not false, the name of a thumbnail file

Returns: string

Definition at line 1676 of file File.php.

References $path, and getArchiveRel().

Referenced by getArchiveThumbPath().

◆ getArchiveThumbUrl()

File::getArchiveThumbUrl	(	$archiveName,
		$suffix = `false`
	)

Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified Stable to override.

Parameters

string	$archiveName	The timestamped name of an archived image
bool \| string	$suffix	If not false, the name of a thumbnail file

Returns: string

Definition at line 1764 of file File.php.

References $ext, $path, assertRepoDefined(), getExtension(), and getHashPath().

Referenced by LocalFile\purgeOldThumbnails().

◆ getArchiveUrl()

File::getArchiveUrl ( $suffix = false )

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

Parameters

bool | string $suffix If not false, the name of an archived file

Returns: string

Definition at line 1743 of file File.php.

References $ext, $path, assertRepoDefined(), getExtension(), and getHashPath().

◆ getArchiveVirtualUrl()

File::getArchiveVirtualUrl ( $suffix = false )

Get the public zone virtual URL for an archived version source file Stable to override.

Parameters

bool | string $suffix If not false, the name of a thumbnail file

Returns: string

Definition at line 1839 of file File.php.

References $path, assertRepoDefined(), and getHashPath().

◆ getAvailableLanguages()

File::getAvailableLanguages ( )

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

If the file doesn't have translations, or if the file format does not support that sort of thing, returns an empty array.

Returns: string[]

Since: 1.23

Definition at line 643 of file File.php.

References MediaHandler\getAvailableLanguages(), and getHandler().

◆ getBitDepth()

File::getBitDepth ( )

Return the bit depth of the file Overridden by LocalFile STUB Stable to override.

Returns: int

Reimplemented in LocalFile, and UnregisteredLocalFile.

Definition at line 770 of file File.php.

◆ getBucketThumbName()

File::getBucketThumbName ( $bucket )

protected

Returns the name of the thumb for a given bucket.

Parameters

int $bucket

Returns: string

Definition at line 1414 of file File.php.

References thumbName().

Referenced by getBucketThumbPath().

◆ getBucketThumbPath()

File::getBucketThumbPath ( $bucket )

protected

Returns the repo path of the thumb for a given bucket.

Parameters

int $bucket

Returns: string

Definition at line 1404 of file File.php.

References getBucketThumbName(), and getThumbPath().

Referenced by generateBucketsIfNeeded(), and getThumbnailSource().

◆ getCanonicalUrl()

File::getCanonicalUrl ( )

Stable to override.

Returns: string

Definition at line 405 of file File.php.

References getUrl(), PROTO_CANONICAL, and wfExpandUrl().

◆ getCanRender()

File::getCanRender ( )

protected

Accessor for __get()

Returns: bool

Definition at line 833 of file File.php.

References canRender().

◆ getCommonMetaArray()

File::getCommonMetaArray ( )

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

See also: MediaHandler::getCommonMetaArray()

Returns: array|bool Array or false if not supported

Since: 1.23

Definition at line 732 of file File.php.

References MediaHandler\getCommonMetaArray(), and getHandler().

◆ getContentHeaders()

File::getContentHeaders ( )

Returns: string[] HTTP header name/value map to use for HEAD/GET request responses

Since: 1.30

Definition at line 2315 of file File.php.

References MediaHandler\getContentHeaders(), getHandler(), and getMetadata().

◆ getDefaultRenderLanguage()

File::getDefaultRenderLanguage ( )

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

Returns: string|null Lang code, or null if filetype doesn't support multiple languages.

Since: 1.23

Definition at line 678 of file File.php.

References MediaHandler\getDefaultRenderLanguage(), and getHandler().

◆ getDescription()

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

Get description of file revision STUB.

Stable to override

Parameters

int	$audience	One of: File::FOR_PUBLIC to be displayed to all users File::FOR_THIS_USER to be displayed to the given user File::RAW get the description regardless of permissions
User \| null	$user	User object to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: null|string

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 2239 of file File.php.

◆ getDescriptionShortUrl()

File::getDescriptionShortUrl ( )

Get short description URL for a files based on the page ID Stable to override.

Returns: string|null

Since: 1.27

Reimplemented in ForeignAPIFile, ForeignDBFile, and LocalFile.

Definition at line 385 of file File.php.

◆ getDescriptionText()

File::getDescriptionText ( Language $lang = null )

Get the HTML text of the description page, if available Stable to override.

Parameters

Language | null $lang Optional language to fetch description in

Returns: string|false

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2188 of file File.php.

References $cache, $lang, $res, $wgLang, getName(), and wfDebug().

◆ getDescriptionTouched()

File::getDescriptionTouched ( )

Returns the timestamp (in TS_MW format) of the last change of the description page.

Returns false if the file does not have a description page, or retrieving the timestamp would be expensive.

Since: 1.25 Stable to override

Returns: string|bool

Reimplemented in LocalFile.

Definition at line 2263 of file File.php.

◆ getDescriptionUrl()

File::getDescriptionUrl ( )

Get the URL of the image description page.

May return false if it is unknown or not applicable.

Stable to override

Returns: string|bool

Reimplemented in ForeignAPIFile, ForeignDBFile, LocalFile, and UploadStashFile.

Definition at line 2173 of file File.php.

References getName().

Referenced by ForeignDBFile\getDescriptionUrl(), and transform().

◆ getDimensionsString()

File::getDimensionsString ( )

Returns: string

Definition at line 2361 of file File.php.

References MediaHandler\getDimensionsString(), and getHandler().

◆ getDisplayWidthHeight()

File::getDisplayWidthHeight	(	$maxWidth,
		$maxHeight,
		$page = `1`
	)

Get the width and height to display image at.

Parameters

int	$maxWidth	Max width to display at
int	$maxHeight	Max height to display at
int	$page

Exceptions

MWException

Returns: array Array (width, height)

Since: 1.35

Definition at line 561 of file File.php.

References getHeight(), and getWidth().

◆ getExtension()

File::getExtension ( )

Get the file extension, e.g.

"svg"

Stable to override

Returns: string

Definition at line 330 of file File.php.

References getName().

Referenced by generateThumbName(), getArchiveThumbUrl(), getArchiveUrl(), ForeignAPIFile\getMimeType(), getStorageKey(), getThumbDisposition(), getUrl(), getZoneUrl(), and iconThumb().

◆ getFullUrl()

File::getFullUrl ( )

Return a fully-qualified URL to the file.

Upload URL paths may or may not be fully qualified, so we check. Local paths are assumed to belong on $wgServer. Stable to override

Returns: string

Reimplemented in UploadStashFile.

Definition at line 397 of file File.php.

References getUrl(), PROTO_RELATIVE, and wfExpandUrl().

◆ getHandler()

File::getHandler ( )

Get a MediaHandler instance for this file.

Returns: MediaHandler|bool Registered MediaHandler for file's MIME type or false if none found

Definition at line 1459 of file File.php.

References MediaHandler\getHandler(), and getMimeType().

Referenced by UnregisteredLocalFile\cachePageDimensions(), canAnimateThumbIfAppropriate(), canRender(), convertMetadataVersion(), formatMetadata(), generateAndSaveThumb(), generateBucketsIfNeeded(), generateThumbName(), getAvailableLanguages(), getCommonMetaArray(), getContentHeaders(), getDefaultRenderLanguage(), getDimensionsString(), LocalFile\getHeight(), UnregisteredLocalFile\getImageSize(), getImageSize(), getLength(), getLongDesc(), getMatchedLanguage(), UnregisteredLocalFile\getMetadata(), getShortDesc(), getThumbnailSource(), LocalFile\getWidth(), isExpensiveToThumbnail(), isMultipage(), isVectorized(), LocalFile\maybeUpgradeRow(), mustRender(), pageCount(), ForeignAPIFile\purgeThumbnails(), LocalFile\purgeThumbnails(), transform(), and transformErrorOutput().

◆ getHashPath()

File::getHashPath ( )

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

f/fa/ If the repository is not hashed, returns an empty string.

Returns: string

Definition at line 1601 of file File.php.

References assertRepoDefined(), and getName().

Referenced by getArchiveRel(), getArchiveThumbUrl(), getArchiveUrl(), getArchiveVirtualUrl(), getRel(), ForeignAPIFile\getThumbPath(), and getUrlRel().

◆ getHeight()

File::getHeight ( $page = 1 )

Return the height of the image.

Returns false if the height is unknown or undefined

STUB Overridden by LocalFile, UnregisteredLocalFile

Stable to override

Parameters

int $page

Returns: bool|int False on failure

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 503 of file File.php.

Referenced by getDisplayWidthHeight(), and getThumbnailSource().

◆ getHistory()

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

Return a fragment of the history of file.

STUB Stable to override

Parameters

int \| null	$limit	Limit of rows to return
string \| int \| null	$start	Only revisions older than $start will be returned
string \| int \| null	$end	Only revisions newer than $end will be returned
bool	$inc	Include the endpoints of the time range

Returns: File[]

Reimplemented in LocalFile.

Definition at line 1566 of file File.php.

◆ getImageSize()

File::getImageSize ( $filePath )

protected

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

Loads the image size directly from the file ignoring caches.

Note: Use getWidth()/getHeight() instead of this method unless you have a a good reason. This method skips all caches.

Stable to override

Parameters

string $filePath The path to the file (e.g. From getLocalRefPath() )

Returns: array|false The width, followed by height, with optionally more things after

Reimplemented in UnregisteredLocalFile.

Definition at line 2158 of file File.php.

References getHandler().

◆ getIsSafeFile()

File::getIsSafeFile ( )

protected

Accessor for __get()

Returns: bool

Definition at line 887 of file File.php.

References isSafeFile().

◆ getIsSafeFileUncached()

File::getIsSafeFileUncached ( )

protected

Uncached accessor.

Returns: bool

Definition at line 896 of file File.php.

References $mime, $type, $wgTrustedMediaFormats, allowInlineDisplay(), getMediaType(), getMimeType(), isTrustedFile(), and MEDIATYPE_UNKNOWN.

Referenced by isSafeFile().

◆ getLastError()

File::getLastError ( )

Get last thumbnailing error.

Largely obsolete.

Returns: string

Definition at line 1494 of file File.php.

◆ getLength()

File::getLength ( )

Get the duration of a media file in seconds.

Stable to override

Returns: float|int

Definition at line 609 of file File.php.

References getHandler(), and MediaHandler\getLength().

◆ getLocalRefPath()

File::getLocalRefPath ( )

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

Returns false on failure. Callers must not alter the file. Temporary files are cleared automatically.

Returns: string|bool False on failure

Definition at line 457 of file File.php.

References assertRepoDefined(), and getPath().

Referenced by UnregisteredLocalFile\getBitDepth(), UnregisteredLocalFile\getImageSize(), UnregisteredLocalFile\getMetadata(), UnregisteredLocalFile\getMimeType(), MediaHandler\getPageDimensions(), and getThumbnailSource().

◆ getLongDesc()

File::getLongDesc ( )

Returns: string

Definition at line 2337 of file File.php.

References MediaHandler\getGeneralLongDesc(), getHandler(), and MediaHandler\getLongDesc().

◆ getMatchedLanguage()

File::getMatchedLanguage ( $userPreferredLanguage )

Get the language code from the available languages for this file that matches the language requested by the user.

Parameters

string $userPreferredLanguage

Returns: string|null

Definition at line 659 of file File.php.

References MediaHandler\getAvailableLanguages(), getHandler(), and MediaHandler\getMatchedLanguage().

◆ getMediaType()

File::getMediaType ( )

Return the type of the media in the file.

Use the value returned by this function with the MEDIATYPE_xxx constants. Overridden by LocalFile, STUB Stable to override

Returns: string

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 805 of file File.php.

References MEDIATYPE_UNKNOWN.

Referenced by getIsSafeFileUncached().

◆ getMetadata()

File::getMetadata ( )

Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB Stable to override.

Returns: string|false

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 722 of file File.php.

Referenced by GIFHandler\getCommonMetaArray(), PNGHandler\getCommonMetaArray(), and getContentHeaders().

◆ getMimeType()

File::getMimeType ( )

Returns the MIME type of the file.

Overridden by LocalFile, UnregisteredLocalFile STUB

Stable to override

Returns: string

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 793 of file File.php.

Referenced by checkExtensionCompatibility(), generateThumbName(), getHandler(), getIsSafeFileUncached(), and getViewURL().

◆ getName()

File::getName ( )

Return the name of this file.

Stable to override

Returns: string

Definition at line 315 of file File.php.

References assertRepoDefined().

Referenced by compare(), LocalFile\getCacheKey(), getDescriptionText(), ForeignDBFile\getDescriptionText(), getDescriptionUrl(), getExtension(), getHashPath(), getRel(), ForeignAPIFile\getThumbnails(), getThumbnailSource(), getTransformScript(), getUrlRel(), getViewURL(), ImageHistoryList\imageHistoryLine(), LocalFile\loadExtraFieldsWithTimestamp(), OldLocalFile\loadExtraFromDB(), LocalFile\loadFromDB(), OldLocalFile\loadFromDB(), ForeignAPIFile\purgeDescriptionPage(), LocalFile\purgeThumbList(), ForeignAPIFile\purgeThumbnails(), OldLocalFile\recordOldUpload(), thumbName(), ForeignAPIFile\transform(), LocalFile\upgradeRow(), and OldLocalFile\upgradeRow().

◆ getOriginalTitle()

File::getOriginalTitle ( )

Return the title used to find this file.

Returns: Title

Definition at line 354 of file File.php.

References $title, and getRedirectedTitle().

◆ getPath()

File::getPath ( )

Return the storage path to the file.

Note that this does not mean that a file actually exists under that location.

This path depends on whether directory hashing is active or not, i.e. whether the files are all found in the same directory, or in hashed paths like /images/3/3c.

Most callers don't check the return value, but ForeignAPIFile::getPath returns false.

Stable to override

Returns: string|bool ForeignAPIFile::getPath can return false

Reimplemented in ForeignAPIFile.

Definition at line 441 of file File.php.

References $path, assertRepoDefined(), and getRel().

Referenced by exists(), getLocalRefPath(), getSha1(), and getTimestamp().

◆ getRedirected()

File::getRedirected ( )

Returns: string

Definition at line 2373 of file File.php.

◆ getRedirectedTitle()

File::getRedirectedTitle ( )

protected

Returns: Title|null

Definition at line 2380 of file File.php.

References NS_FILE.

Referenced by getOriginalTitle().

◆ getRel()

File::getRel ( )

Get the path of the file relative to the public zone root.

This function is overridden in OldLocalFile to be like getArchiveRel().

Stable to override

Returns: string

Reimplemented in OldLocalFile.

Definition at line 1617 of file File.php.

References getHashPath(), and getName().

Referenced by getPath(), and getThumbRel().

◆ getRepo()

File::getRepo ( )

Returns the repository Stable to override.

Returns: FileRepo|bool

Reimplemented in ForeignAPIFile, ForeignDBFile, and LocalFile.

Definition at line 1970 of file File.php.

◆ getRepoName()

File::getRepoName ( )

Returns the name of the repository.

Returns: string

Definition at line 1960 of file File.php.

◆ getSha1()

File::getSha1 ( )

Get the SHA-1 base 36 hash of the file.

Stable to override

Returns: string

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 2273 of file File.php.

References assertRepoDefined(), and getPath().

Referenced by generateThumbName(), getStorageKey(), and ApiQueryDuplicateFiles\run().

◆ getShortDesc()

File::getShortDesc ( )

Returns: string

Definition at line 2349 of file File.php.

References MediaHandler\getGeneralShortDesc(), getHandler(), and MediaHandler\getShortDesc().

◆ getSize()

File::getSize ( )

Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB Stable to override.

Returns: int|false

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 781 of file File.php.

Referenced by getThumbnailSource().

◆ getStorageKey()

File::getStorageKey ( )

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

Returns: string|false

Definition at line 2284 of file File.php.

References $ext, getExtension(), and getSha1().

◆ getThumbDisposition()

File::getThumbDisposition	(	$thumbName,
		$dispositionType = `'inline'`
	)

Parameters

string	$thumbName	Thumbnail name
string	$dispositionType	Type of disposition (either "attachment" or "inline")

Returns: string Content-Disposition header value

Definition at line 1434 of file File.php.

References FileBackend\extensionFromPath(), getExtension(), and FileBackend\makeContentDisposition().

Referenced by generateAndSaveThumb().

◆ getThumbnailBucket()

File::getThumbnailBucket	(	$desiredWidth,
		$page = `1`
	)

Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistance larger than $desiredWidth.

The returned bucket, if any, will always be bigger than $desiredWidth.

Parameters

int	$desiredWidth
int	$page

Returns: bool|int

Definition at line 516 of file File.php.

References $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance, and getWidth().

Referenced by generateBucketsIfNeeded(), and getThumbnailSource().

◆ getThumbnails()

File::getThumbnails ( )

protected

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

Returns: string[]

Reimplemented in ForeignAPIFile.

Definition at line 1505 of file File.php.

◆ getThumbnailSource()

File::getThumbnailSource ( $params )

Returns the most appropriate source image for the thumbnail, given a target thumbnail size.

Parameters

array $params

Returns: array Source path and width/height of the source

Definition at line 1336 of file File.php.

References PoolCounterWork\execute(), getBucketThumbPath(), getHandler(), getHeight(), getLocalRefPath(), getName(), getSize(), getThumbnailBucket(), and getWidth().

◆ getThumbPath()

File::getThumbPath ( $suffix = false )

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

Parameters

bool | string $suffix If not false, the name of a thumbnail file

Returns: string

Reimplemented in ForeignAPIFile, and UploadStashFile.

Definition at line 1718 of file File.php.

References assertRepoDefined(), and getThumbRel().

Referenced by generateAndSaveThumb(), getBucketThumbPath(), LocalFile\getThumbnails(), and transform().

◆ getThumbRel()

File::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.

Parameters

bool | string $suffix If not false, the name of a thumbnail file

Returns: string

Definition at line 1648 of file File.php.

References $path, and getRel().

Referenced by getThumbPath(), and getTranscodedPath().

◆ getThumbUrl()

File::getThumbUrl ( $suffix = false )

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

Parameters

bool | string $suffix If not false, the name of a thumbnail file

Returns: string Path

Reimplemented in UploadStashFile.

Definition at line 1801 of file File.php.

References getZoneUrl().

Referenced by generateAndSaveThumb(), LocalFile\purgeThumbnails(), and transform().

◆ getThumbVirtualUrl()

File::getThumbVirtualUrl ( $suffix = false )

Get the virtual URL for a thumbnail file or directory Stable to override.

Parameters

bool | string $suffix If not false, the name of a thumbnail file

Returns: string

Definition at line 1858 of file File.php.

References $path, assertRepoDefined(), and getUrlRel().

◆ getTimestamp()

File::getTimestamp ( )

Get the 14-character timestamp of the file upload.

Stable to override

Returns: string|bool TS_MW timestamp or false on failure

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 2249 of file File.php.

References assertRepoDefined(), and getPath().

Referenced by getTimestamp().

◆ getTitle()

File::getTitle ( )

Return the associated title object.

Returns: Title

Definition at line 345 of file File.php.

References $title.

Referenced by FileDeleteForm\__construct(), and SpecialFileDuplicateSearch\doBatchLookups().

◆ getTranscodedPath()

File::getTranscodedPath ( $suffix = false )

Get the path of the transcoded directory, or a particular file if $suffix is specified.

Parameters

bool | string $suffix If not false, the name of a media file

Returns: string

Definition at line 1730 of file File.php.

References assertRepoDefined(), and getThumbRel().

◆ getTranscodedUrl()

File::getTranscodedUrl ( $suffix = false )

Get the URL of the transcoded directory, or a particular file if $suffix is specified.

Parameters

bool | string $suffix If not false, the name of a media file

Returns: string Path

Definition at line 1811 of file File.php.

References getZoneUrl().

◆ getTransformScript()

File::getTransformScript ( )

private

Returns: string

Definition at line 984 of file File.php.

References getName(), and wfAppendQuery().

Referenced by transform().

◆ getUnscaledThumb()

File::getUnscaledThumb ( $handlerParams = [] )

Get a ThumbnailImage which is the same size as the source.

Parameters

array $handlerParams

Returns: ThumbnailImage|MediaTransformOutput|bool False on failure

Definition at line 1005 of file File.php.

References getWidth(), iconThumb(), and transform().

◆ getUrl()

File::getUrl ( )

Return the URL of the file Stable to override.

Returns: string

Reimplemented in ForeignAPIFile, and UploadStashFile.

Definition at line 368 of file File.php.

References $ext, assertRepoDefined(), getExtension(), and getUrlRel().

Referenced by RevDelFileItem\getApiData(), getCanonicalUrl(), getFullUrl(), getViewURL(), and LocalFile\purgeCache().

◆ getUrlRel()

File::getUrlRel ( )

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

This function is overridden in OldLocalFile to be like getArchiveUrl(). Stable to override

Returns: string

Reimplemented in OldLocalFile.

Definition at line 1664 of file File.php.

References getHashPath(), and getName().

Referenced by getThumbVirtualUrl(), getUrl(), getVirtualUrl(), and getZoneUrl().

◆ getUser()

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

Returns ID or name of user who uploaded the file STUB.

Stable to override

Parameters

string $type 'text' or 'id'

Returns: string|int

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 599 of file File.php.

Referenced by SpecialFileDuplicateSearch\doBatchLookups().

◆ getViewURL()

File::getViewURL ( )

Returns: string

Definition at line 412 of file File.php.

References canRender(), createThumb(), getMimeType(), getName(), getUrl(), getWidth(), mustRender(), and wfDebug().

◆ getVirtualUrl()

File::getVirtualUrl ( $suffix = false )

Get the public zone virtual URL for a current version source file Stable to override.

Parameters

bool | string $suffix If not false, the name of a thumbnail file

Returns: string

Definition at line 1822 of file File.php.

References $path, assertRepoDefined(), and getUrlRel().

Referenced by LocalFile\isMissing(), and LocalFile\loadFromFile().

◆ getVisibility()

File::getVisibility ( )

Return the deletion bitfield STUB Stable to override.

Returns: int

Reimplemented in OldLocalFile.

Definition at line 2003 of file File.php.

◆ getWidth()

File::getWidth ( $page = 1 )

Return the width of the image.

Returns false if the width is unknown or undefined.

STUB Overridden by LocalFile, UnregisteredLocalFile

Stable to override

Parameters

int $page

Returns: int|bool

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 488 of file File.php.

Referenced by getDisplayWidthHeight(), getThumbnailBucket(), getThumbnailSource(), getUnscaledThumb(), and getViewURL().

◆ getZoneUrl()

File::getZoneUrl	(	$zone,
		$suffix = `false`
	)

private

Get the URL of the zone directory, or a particular file if $suffix is specified.

Parameters

string	$zone	Name of requested zone
bool \| string	$suffix	If not false, the name of a file in zone

Returns: string Path

Definition at line 1783 of file File.php.

References $ext, $path, assertRepoDefined(), getExtension(), and getUrlRel().

Referenced by getThumbUrl(), and getTranscodedUrl().

◆ iconThumb()

File::iconThumb ( )

Get a ThumbnailImage representing a file type icon.

Returns: ThumbnailImage

Definition at line 1472 of file File.php.

References $IP, $wgResourceBasePath, and getExtension().

Referenced by getUnscaledThumb(), and transform().

◆ isCacheable()

File::isCacheable ( )

Check if this file object is small and can be cached Stable to override.

Returns: bool

Reimplemented in LocalFile.

Definition at line 2413 of file File.php.

◆ isDeleted()

File::isDeleted ( $field )

Is this file a "deleted" file in a private archive? STUB.

Stable to override

Parameters

int $field One of DELETED_* bitfield constants

Returns: bool

Reimplemented in OldLocalFile.

Definition at line 1993 of file File.php.

◆ isExpensiveToThumbnail()

File::isExpensiveToThumbnail ( )

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

Returns: bool

Definition at line 2441 of file File.php.

References getHandler(), and MediaHandler\isExpensiveToThumbnail().

◆ isHashed()

File::isHashed ( )

protected

Returns: bool

Definition at line 1871 of file File.php.

References assertRepoDefined().

◆ isLocal()

File::isLocal ( )

Returns true if the file comes from the local file repository.

Returns: bool

Definition at line 1951 of file File.php.

Referenced by SpecialFileDuplicateSearch\doBatchLookups(), and FileDeleteForm\haveDeletableFile().

◆ isMissing()

File::isMissing ( )

Stable to override.

Returns: bool

Reimplemented in LocalFile.

Definition at line 2404 of file File.php.

◆ isMultipage()

File::isMultipage ( )

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

DJVU or PDF. Note that this may be true even if the file in question only has a single page.

Stable to override

Returns: bool

Definition at line 2106 of file File.php.

References getHandler().

Referenced by LocalFile\getHeight(), and LocalFile\getWidth().

◆ isOld()

File::isOld ( )

Returns true if the image is an old version STUB.

Stable to override

Returns: bool

Reimplemented in OldLocalFile.

Definition at line 1981 of file File.php.

◆ isSafeFile()

File::isSafeFile ( )

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

It uses the global $wgTrustedMediaFormats list to determine if the file is safe.

This is used to show a warning on the description page of non-safe files. It may also be used to disallow direct [[media:...]] links to such files.

Note that this function will always return true if allowInlineDisplay() or isTrustedFile() is true for this file.

Returns: bool

Definition at line 874 of file File.php.

References getIsSafeFileUncached(), and isSafeFile().

Referenced by getIsSafeFile(), and isSafeFile().

◆ isTransformedLocally()

File::isTransformedLocally ( )

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

Since: 1.25 Stable to override

Returns: bool

Reimplemented in ForeignAPIFile.

Definition at line 2452 of file File.php.

◆ isTrustedFile()

File::isTrustedFile ( )

protected

Returns true if the file is flagged as trusted.

Files flagged that way can be linked to directly, even if that is not allowed for this type of file normally.

This is a dummy function right now and always returns false. It could be implemented to extract a flag from the database. The trusted flag could be set on upload, if the user has sufficient privileges, to bypass script- and html-filters. It may even be coupled with cryptographics signatures or such.

Returns: bool

Definition at line 939 of file File.php.

Referenced by getIsSafeFileUncached().

◆ isVectorized()

File::isVectorized ( )

Return true if the file is vectorized.

Returns: bool

Definition at line 623 of file File.php.

References getHandler(), and MediaHandler\isVectorized().

Referenced by LocalFile\prerenderThumbnails().

◆ isVisible()

File::isVisible ( )

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

It would be unsafe to include private images, making public thumbnails inadvertently

Stable to override

Returns: bool Whether file exists in the repository and is includable.

Reimplemented in OldLocalFile.

Definition at line 977 of file File.php.

References exists().

◆ load()

File::load ( $flags = 0 )

Load any lazy-loaded file object fields from source.

This is only useful when setting $flags

Overridden by LocalFile to actually query the DB

Stable to override

Parameters

int $flags Bitfield of File::READ_* constants

Reimplemented in LocalFile.

Definition at line 955 of file File.php.

◆ makeTransformTmpFile()

File::makeTransformTmpFile ( $thumbPath )

protected

Creates a temp FS file with the same extension and the thumbnail.

Parameters

string $thumbPath Thumbnail path

Returns: TempFSFile|null

Definition at line 1423 of file File.php.

References FileBackend\extensionFromPath().

Referenced by generateBucketsIfNeeded(), and transform().

◆ migrateThumbFile()

File::migrateThumbFile ( $thumbName )

protected

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

Parameters

string $thumbName

Definition at line 1450 of file File.php.

◆ move()

File::move ( $target )

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 in ForeignDBFile, and LocalFile.

Definition at line 2031 of file File.php.

References readOnlyError().

◆ mustRender()

File::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.

This returns true for everything but the bitmap types supported by all browsers, i.e. JPEG; GIF and PNG. It will also return true for any non-image formats.

Stable to override

Returns: bool

Definition at line 848 of file File.php.

References getHandler().

Referenced by getViewURL().

◆ nextHistoryLine()

File::nextHistoryLine ( )

Return the history of this file, line by line.

Starts with current version, then old versions. Should return an object similar to an image/oldimage database row.

STUB Stable to override Overridden in LocalFile

Returns: bool

Reimplemented in LocalFile.

Definition at line 1580 of file File.php.

◆ normalizeExtension()

static File::normalizeExtension ( $extension )

static

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

Extensions with non-alphanumeric characters will be discarded. Keep in sync with mw.Title.normalizeExtension() in JS.

Parameters

string $extension File extension (without the leading dot)

Returns: string File extension in canonical form

Definition at line 239 of file File.php.

◆ normalizeTitle()

static File::normalizeTitle	(	$title,
		$exception = `false`
	)

static

Given a string or Title object return either a valid Title object with namespace NS_FILE or null.

Parameters

Title \| string	$title
string \| bool	$exception	Use 'exception' to throw an error on bad titles

Exceptions

MWException

Returns: Title|null

Definition at line 199 of file File.php.

References $title, NS_FILE, and NS_MEDIA.

Referenced by UnregisteredLocalFile\__construct().

◆ pageCount()

File::pageCount ( )

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

Stable to override

Returns: int|false

Definition at line 2117 of file File.php.

References getHandler(), and pageCount().

Referenced by pageCount().

◆ publish()

File::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.

Options to $options include:

headers : name/value map of HTTP headers to use in response to GET/HEAD requests

Parameters

string \| FSFile	$src	Local filesystem path 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.

STUB Overridden by LocalFile Stable to override

Reimplemented in LocalFile, and ForeignDBFile.

Definition at line 1930 of file File.php.

References readOnlyError().

◆ purgeCache()

File::purgeCache ( $options = [] )

Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile Stable to override.

Parameters

array $options Options, which include: 'forThumbRefresh' : The purging is only to refresh thumbnails

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 1517 of file File.php.

Referenced by purgeEverything().

◆ purgeDescription()

File::purgeDescription ( )

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

Use when modifying file history but not the current data.

Definition at line 1525 of file File.php.

References $title, and getTitle().

Referenced by purgeEverything().

◆ purgeEverything()

File::purgeEverything ( )

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

Definition at line 1538 of file File.php.

References $job, $title, getTitle(), HTMLCacheUpdateJob\newForBacklinks(), purgeCache(), and purgeDescription().

◆ readOnlyError()

File::readOnlyError ( )

protected

Exceptions

MWException

Definition at line 1880 of file File.php.

Referenced by delete(), ForeignDBFile\delete(), deleteFile(), ForeignDBFile\deleteFile(), move(), ForeignDBFile\move(), publish(), ForeignDBFile\publish(), recordUpload(), ForeignDBFile\recordUpload(), restore(), and ForeignDBFile\restore().

◆ recordUpload()

File::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 Stable to override STUB Overridden by LocalFile.

Deprecated:: since 1.35

Parameters

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

Returns: bool

Exceptions

MWException

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 1901 of file File.php.

References readOnlyError(), and wfDeprecated().

◆ redirectedFrom()

File::redirectedFrom ( $from )

Parameters

string $from

Returns: void

Definition at line 2396 of file File.php.

◆ resetHistory()

File::resetHistory ( )

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

Always call this function after using nextHistoryLine() to free db resources STUB Overridden in LocalFile. Stable to override

Reimplemented in LocalFile.

Definition at line 1591 of file File.php.

◆ restore()

File::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	Remove restrictions on content upon restoration?

Returns: Status STUB Overridden by LocalFile Stable to override

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2094 of file File.php.

References readOnlyError().

◆ scaleHeight()

static File::scaleHeight	(	$srcWidth,
		$srcHeight,
		$dstWidth
	)

static

Calculate the height of a thumbnail using the source and destination width.

Parameters

int	$srcWidth
int	$srcHeight
int	$dstWidth

Returns: int

Definition at line 2138 of file File.php.

◆ splitMime()

static File::splitMime ( $mime )

static

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

Parameters

string $mime "text/html" etc

Returns: string[] ("text", "html") etc

Definition at line 290 of file File.php.

References $mime.

Referenced by OldLocalFile\upgradeRow().

◆ thumbName()

File::thumbName	(	$params,
		$flags = `0`
	)

Return the file name of a thumbnail with the specified parameters.

Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>". Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>". Stable to override

Parameters

array	$params	Handler-specific parameters
int	$flags	Bitfield that supports THUMB_* constants

Returns: string|null

Reimplemented in UploadStashFile.

Definition at line 1029 of file File.php.

References generateThumbName(), and getName().

Referenced by generateAndSaveThumb(), getBucketThumbName(), and transform().

◆ transform()

File::transform	(	$params,
		$flags = `0`
	)

Transform a media file Stable to override.

Parameters

array	$params	An associative array of handler-specific parameters. Typical keys are width, height and page.
int	$flags	A bitfield, may contain self::RENDER_NOW to force rendering

Returns: ThumbnailImage|MediaTransformOutput|bool False on failure

Reimplemented in ForeignAPIFile.

Definition at line 1127 of file File.php.

References $wgThumbnailEpoch, canRender(), generateAndSaveThumb(), getDescriptionUrl(), getHandler(), MediaHandler\getScriptedTransform(), getThumbPath(), getThumbUrl(), MediaHandler\getTransform(), getTransformScript(), iconThumb(), makeTransformTmpFile(), MediaHandler\normaliseParams(), PROTO_CANONICAL, thumbName(), transformErrorOutput(), wfDebug(), and wfExpandUrl().

Referenced by createThumb(), SpecialFileDuplicateSearch\execute(), and getUnscaledThumb().

◆ transformErrorOutput()

File::transformErrorOutput	(	$thumbPath,
		$thumbUrl,
		$params,
		$flags
	)

protected

Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)

Parameters

string	$thumbPath	Thumbnail storage path
string	$thumbUrl	Thumbnail URL
array	$params
int	$flags

Returns: MediaTransformOutput

Definition at line 1106 of file File.php.

References $wgIgnoreImageErrors, getHandler(), MediaHandler\getTransform(), and wfMessage().

Referenced by generateAndSaveThumb(), and transform().

◆ upgradeRow()

File::upgradeRow ( )

Upgrade the database row if there is one Called by ImagePage STUB.

Stable to override

Reimplemented in LocalFile, and OldLocalFile.

Definition at line 280 of file File.php.

◆ userCan()

File::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.

STUB Stable to override

Parameters

int	$field
User \| null	$user	User object to check, or null to use $wgUser (deprecated since 1.35)

Returns: bool

Reimplemented in OldLocalFile.

Definition at line 2304 of file File.php.

References wfDeprecated().

◆ wasDeleted()

File::wasDeleted ( )

Was this file ever deleted from the wiki?

Returns: bool

Definition at line 2012 of file File.php.

References $title, and getTitle().

Referenced by UploadBase\checkLocalFileWasDeleted().

Member Data Documentation

◆ $canRender

bool File::$canRender

protected

Whether the output of transform() for this file is likely to be valid.

Definition at line 157 of file File.php.

◆ $extension

string File::$extension

protected

File extension.

Definition at line 134 of file File.php.

◆ $fsFile

FSFile bool File::$fsFile

protected

False if undefined.

Definition at line 125 of file File.php.

Referenced by UnregisteredLocalFile\setLocalReference().

◆ $handler

MediaHandler File::$handler

protected

Definition at line 128 of file File.php.

Referenced by LocalFile\getHeight(), LocalFile\getWidth(), LocalFile\maybeUpgradeRow(), ForeignAPIFile\purgeThumbnails(), LocalFile\purgeThumbnails(), and LocalFile\upload().

◆ $hashPath

string File::$hashPath

protected

Relative path including trailing slash.

Definition at line 143 of file File.php.

◆ $isSafeFile

bool File::$isSafeFile

protected

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

Definition at line 162 of file File.php.

◆ $lastError

string File::$lastError

protected

Text of last error.

Definition at line 116 of file File.php.

◆ $name

string File::$name

protected

The name of a file from its title object.

Definition at line 137 of file File.php.

Referenced by UnregisteredLocalFile\__construct(), LocalFile\loadExtraFromDB(), OldLocalFile\loadExtraFromDB(), LocalFile\loadFromRow(), and LocalFile\unprefixRow().

◆ $pageCount

int false File::$pageCount

protected

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

Definition at line 148 of file File.php.

◆ $path

string File::$path

protected

The storage path corresponding to one of the zones.

Definition at line 140 of file File.php.

Referenced by ForeignAPIFile\getThumbPath().

◆ $redirected

string File::$redirected

protected

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

Definition at line 119 of file File.php.

◆ $redirectedTitle

Title File::$redirectedTitle

protected

Definition at line 122 of file File.php.

◆ $redirectTitle

Title File::$redirectTitle

protected

Definition at line 154 of file File.php.

◆ $repo

FileRepo LocalRepo ForeignAPIRepo bool File::$repo

Some member variables can be lazy-initialised using __get().

The initialisation function for these variables is always a function named like getVar(), where Var is the variable name with upper-case first letter.

The following variables are initialised in this way in this base class: name, extension, handler, path, canRender, isSafeFile, transformScript, hashPath, pageCount, url

Code within this class should generally use the accessor function directly, since __get() isn't re-entrant and therefore causes bugs that depend on initialisation order. The following member variables are not lazy-initialised

Definition at line 110 of file File.php.

Referenced by UploadStashFile\__construct(), LocalFile\__construct(), ForeignAPIFile\__construct(), OldLocalFile\__construct(), UnregisteredLocalFile\__construct(), ForeignAPIFile\getRepo(), ForeignDBFile\getRepo(), OldLocalFile\newFromArchiveName(), LocalFile\newFromKey(), OldLocalFile\newFromKey(), LocalFile\newFromRow(), OldLocalFile\newFromRow(), UnregisteredLocalFile\newFromTitle(), OldLocalFile\newFromTitle(), LocalFile\newFromTitle(), and ForeignAPIFile\newFromTitle().

◆ $repoClass

string File::$repoClass = FileRepo::class

protected

Required Repository class type.

Definition at line 165 of file File.php.

◆ $title

Title string bool File::$title

protected

Definition at line 113 of file File.php.

Referenced by ForeignAPIFile\__construct(), OldLocalFile\__construct(), OldLocalFile\newFromArchiveName(), OldLocalFile\newFromRow(), OldLocalFile\newFromTitle(), and ForeignAPIFile\newFromTitle().

◆ $tmpBucketedThumbCache

array File::$tmpBucketedThumbCache = []

protected

Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width.

Definition at line 168 of file File.php.

◆ $transformScript

string File::$transformScript

protected

URL of transformscript (for example thumb.php)

Definition at line 151 of file File.php.

◆ $url

string File::$url

protected

The URL corresponding to one of the four basic zones.

Definition at line 131 of file File.php.

Referenced by ForeignAPIFile\getDescriptionShortUrl(), ForeignDBFile\getDescriptionShortUrl(), LocalFile\getDescriptionShortUrl(), and ForeignAPIFile\purgeDescriptionPage().

◆ DELETE_SOURCE

const File::DELETE_SOURCE = 1

Definition at line 80 of file File.php.

Referenced by LocalFile\publishTo().

◆ DELETED_COMMENT

const File::DELETED_COMMENT = 2

Definition at line 68 of file File.php.

◆ DELETED_FILE

const File::DELETED_FILE = 1

Definition at line 67 of file File.php.

Referenced by OldLocalFile\isVisible().

◆ DELETED_RESTRICTED

const File::DELETED_RESTRICTED = 8

Definition at line 70 of file File.php.

◆ DELETED_USER

const File::DELETED_USER = 4

Definition at line 69 of file File.php.

◆ FOR_PUBLIC

const File::FOR_PUBLIC = 1

Definition at line 83 of file File.php.

◆ FOR_THIS_USER

const File::FOR_THIS_USER = 2

Definition at line 84 of file File.php.

◆ RAW

const File::RAW = 3

Definition at line 85 of file File.php.

◆ RENDER_FORCE

const File::RENDER_FORCE = 2

Force rendering even if thumbnail already exist and using RENDER_NOW I.e.

you have to pass both flags: File::RENDER_NOW | File::RENDER_FORCE

Definition at line 78 of file File.php.

◆ RENDER_NOW

const File::RENDER_NOW = 1

Force rendering in the current process.

Definition at line 73 of file File.php.

◆ THUMB_FULL_NAME

const File::THUMB_FULL_NAME = 1

Definition at line 88 of file File.php.

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

includes/filerepo/file/File.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ allowInlineDisplay()

◆ assertRepoDefined()

◆ assertTitleDefined()

◆ canAnimateThumbIfAppropriate()

◆ canRender()

◆ checkExtensionCompatibility()

◆ compare()

◆ convertMetadataVersion()

◆ createThumb()

◆ delete()

◆ deleteFile()

◆ exists()

◆ formatMetadata()

◆ generateAndSaveThumb()

◆ generateBucketsIfNeeded()

◆ generateThumbName()

◆ getArchivePath()

◆ getArchiveRel()

◆ getArchiveThumbPath()

◆ getArchiveThumbRel()

◆ getArchiveThumbUrl()

◆ getArchiveUrl()

◆ getArchiveVirtualUrl()

◆ getAvailableLanguages()

◆ getBitDepth()

◆ getBucketThumbName()

◆ getBucketThumbPath()

◆ getCanonicalUrl()

◆ getCanRender()

◆ getCommonMetaArray()

◆ getContentHeaders()

◆ getDefaultRenderLanguage()

◆ getDescription()

◆ getDescriptionShortUrl()

◆ getDescriptionText()

◆ getDescriptionTouched()

◆ getDescriptionUrl()

◆ getDimensionsString()

◆ getDisplayWidthHeight()

◆ getExtension()

◆ getFullUrl()

◆ getHandler()

◆ getHashPath()

◆ getHeight()

◆ getHistory()

◆ getImageSize()

◆ getIsSafeFile()

◆ getIsSafeFileUncached()

◆ getLastError()

◆ getLength()

◆ getLocalRefPath()

◆ getLongDesc()

◆ getMatchedLanguage()

◆ getMediaType()

◆ getMetadata()

◆ getMimeType()

◆ getName()

◆ getOriginalTitle()

◆ getPath()

◆ getRedirected()

◆ getRedirectedTitle()

◆ getRel()

◆ getRepo()

◆ getRepoName()

◆ getSha1()

◆ getShortDesc()

◆ getSize()

◆ getStorageKey()

◆ getThumbDisposition()