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

Inherits MediaHandlerState.

Inherited by ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

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.

	deleteFile ( $reason, UserIdentity $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.

	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.

	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.

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

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

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

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

	getCanonicalUrl ()

	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, Authority $performer=null)
	Get description of file revision STUB.

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

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

	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.

	getFilePageThumbUrl ( $url)
	Append a version parameter to the end of a file URL Only to be used on File pages.

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

	getHandler ()
	Get a MediaHandler instance for this file.

	getHandlerState (string $key)
	Get a value, or null if it does not exist.

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

	getMetadataArray ()
	Get the unserialized handler-specific metadata STUB.

	getMetadataItem (string $itemName)
	Get a specific element of the unserialized handler-specific metadata.

	getMetadataItems (array $itemNames)
	Get multiple elements of the unserialized handler-specific metadata.

	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.

	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.

	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.

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

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

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

	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.

	getUploader (int $audience=self::FOR_PUBLIC, Authority $performer=null)
	Get the identity of the file uploader.

	getUrl ()
	Return the URL of the file.

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

	getViewURL ()

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

	getVisibility ()
	Return the deletion bitfield STUB.

	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.

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

	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.

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

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

	redirectedFrom (string $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.

	setHandlerState (string $key, $value)
	Set a value.

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

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

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

	userCan ( $field, Authority $performer)
	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 (?string $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 false	$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

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

	getIsSafeFile ()
	Accessor for __get()

	getIsSafeFileUncached ()
	Uncached accessor.

	getRedirectedTitle ()

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

	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.

	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 false	$fsFile
	False if undefined.

MediaHandler	$handler

string null	$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 null	$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
	The name that was used to access the file, before resolving redirects.

Title	$redirectedTitle

Title	$redirectTitle

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

Title string false	$title

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

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

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

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

Stability: stable: to extend

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

Stability: stable: to call

Parameters

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

Reimplemented in LocalFile.

Definition at line 197 of file File.php.

References $repo, and $title.

Member Function Documentation

◆ __get()

File::__get ( $name )

Definition at line 244 of file File.php.

References $name.

◆ allowInlineDisplay()

File::allowInlineDisplay ( )

Alias for canRender()

Returns: bool

Definition at line 905 of file File.php.

Referenced by canAnimateThumbIfAppropriate().

◆ assertRepoDefined()

File::assertRepoDefined ( )

protected

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

Definition at line 2466 of file File.php.

Referenced by LocalFile\__construct(), ForeignAPIFile\__construct(), UnregisteredLocalFile\__construct(), getLocalRefPath(), getName(), getPath(), and getUrl().

◆ assertTitleDefined()

File::assertTitleDefined ( )

protected

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

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

In other words, this will return true if a thumbnail can be provided for this image (e.g. if [[File:...|thumb]] produces a result on a wikitext page).

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

Returns: bool

Definition at line 869 of file File.php.

Referenced by getViewURL(), 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 288 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 331 of file File.php.

References getName().

◆ convertMetadataVersion()

File::convertMetadataVersion	(		$metadata,
			$version )

get versioned metadata

Parameters

array	$metadata	Array of unserialized metadata
int \| string	$version	Version number.

Returns: array Array containing metadata, or what was passed to it on fail

Definition at line 804 of file File.php.

References MediaHandler\convertMetadataVersion().

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

References $params.

Referenced by getViewURL().

◆ deleteFile()

File::deleteFile	(		$reason,
		UserIdentity	$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
UserIdentity	$user
bool	$suppress	Hide content from sysops?

Returns: Status STUB Overridden by LocalFile

Stability: stable: to override

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2133 of file File.php.

◆ exists()

File::exists ( )

Returns true if file exists in the repository.

Overridden by LocalFile to avoid unnecessary stat calls.

Stability: stable: to override

Returns: bool Whether file exists in the repository.

Reimplemented in ForeignAPIFile, LocalFile, OldLocalFile, and UploadStashFile.

Definition at line 1015 of file File.php.

Referenced by ApiDelete\canDeleteFile(), LocalRepo\findFiles(), MediaWiki\Rest\Handler\MediaFileHandler\hasRepresentation(), and MediaWiki\Output\OutputPage\setFileVersion().

◆ formatMetadata()

File::formatMetadata ( $context = false )

Parameters

IContextSource | false $context

Returns: array[]|false

Definition at line 2021 of file File.php.

References MediaHandler\formatMetadata().

◆ 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: MediaTransformOutput|false

Definition at line 1282 of file File.php.

References MediaHandler\doTransform(), MediaHandler\getTransform(), MediaHandler\normaliseParams(), MediaHandler\supportsBucketing(), and wfMessage().

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

References $params.

◆ generateThumbName()

File::generateThumbName	(		$name,
			$params )

Generate a thumbnail file name from a name and specified parameters.

Stability: stable: to override

Parameters

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

Returns: string|null

Definition at line 1094 of file File.php.

References $params.

Referenced by UploadStashFile\thumbName().

◆ getArchivePath()

File::getArchivePath ( $suffix = false )

Get the path of the archived file.

Parameters

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

Returns: string

Definition at line 1782 of file File.php.

◆ getArchiveRel()

File::getArchiveRel ( $suffix = false )

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

Stability: stable: to override

Parameters

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

Returns: string

Definition at line 1720 of file File.php.

References $path.

◆ 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
string \| false	$suffix	If not false, the name of a thumbnail file

Returns: string

Definition at line 1795 of file File.php.

◆ getArchiveThumbUrl()

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

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

Stability: stable: to override

Parameters

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

Returns: string

Definition at line 1855 of file File.php.

References $path.

◆ getArchiveUrl()

File::getArchiveUrl ( $suffix = false )

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

Stability: stable: to override

Parameters

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

Returns: string

Definition at line 1834 of file File.php.

References $path.

◆ getArchiveVirtualUrl()

File::getArchiveVirtualUrl ( $suffix = false )

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

Stability: stable: to override

Parameters

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

Returns: string

Definition at line 1946 of file File.php.

References $path.

◆ getAvailableLanguages()

File::getAvailableLanguages ( )

Gives a (possibly empty) list of IETF 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 660 of file File.php.

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

◆ getBitDepth()

File::getBitDepth ( )

Return the bit depth of the file Overridden by LocalFile STUB.

Stability: stable: to override

Returns: int

Reimplemented in LocalFile, and UnregisteredLocalFile.

Definition at line 820 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 1503 of file File.php.

◆ getBucketThumbPath()

File::getBucketThumbPath ( $bucket )

protected

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

Parameters

int $bucket

Returns: string

Definition at line 1493 of file File.php.

◆ getCanonicalUrl()

File::getCanonicalUrl ( )

Stability: stable: to override

Returns: string

Definition at line 432 of file File.php.

References getUrl(), and PROTO_CANONICAL.

◆ getCanRender()

File::getCanRender ( )

protected

Accessor for __get()

Returns: bool

Definition at line 881 of file File.php.

◆ getCommonMetaArray()

File::getCommonMetaArray ( )

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

See also: MediaHandler::getCommonMetaArray()

Returns: array|false Array or false if not supported

Since: 1.23

Definition at line 792 of file File.php.

References MediaHandler\getCommonMetaArray().

◆ getContentHeaders()

File::getContentHeaders ( )

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

Since: 1.30

Definition at line 2370 of file File.php.

References MediaHandler\getContentHeaders().

◆ getDefaultRenderLanguage()

File::getDefaultRenderLanguage ( )

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

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

Since: 1.23

Definition at line 695 of file File.php.

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

◆ getDescription()

File::getDescription	(		$audience = self::FOR_PUBLIC,
		Authority	$performer = null )

Get description of file revision STUB.

Stability: 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
Authority \| null	$performer	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 2297 of file File.php.

◆ getDescriptionShortUrl()

File::getDescriptionShortUrl ( )

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

Stability: stable: to override

Returns: string|null

Since: 1.27

Reimplemented in ForeignAPIFile, ForeignDBFile, and LocalFile.

Definition at line 411 of file File.php.

◆ getDescriptionText()

File::getDescriptionText ( Language $lang = null )

Get the HTML text of the description page, if available.

Stability: stable: to override

Parameters

Language | null $lang Optional language to fetch description in

Returns: string|false HTML

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2227 of file File.php.

References $wgLang, 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

Stability: stable: to override

Returns: string|false

Reimplemented in LocalFile.

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

Stability: stable: to override

Returns: string|false

Reimplemented in ForeignAPIFile, ForeignDBFile, LocalFile, and UploadStashFile.

Definition at line 2211 of file File.php.

Referenced by ForeignDBFile\getDescriptionUrl(), and ImagePage\imageDupes().

◆ getDimensionsString()

File::getDimensionsString ( )

Returns: string

Definition at line 2406 of file File.php.

References MediaHandler\getDimensionsString().

◆ 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

Returns: array Array (width, height)

Since: 1.35

Definition at line 590 of file File.php.

References getHeight(), and getWidth().

◆ getExtension()

File::getExtension ( )

Get the file extension, e.g.

"svg"

Stability: stable: to override

Returns: string

Definition at line 356 of file File.php.

References getName().

Referenced by getUrl().

◆ getFilePageThumbUrl()

File::getFilePageThumbUrl ( $url )

Append a version parameter to the end of a file URL Only to be used on File pages.

Access: internal

Parameters

string $url Unversioned URL

Returns: string

Definition at line 1904 of file File.php.

References getTimestamp(), and wfAppendQuery().

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

Stability: stable: to override

Returns: string

Reimplemented in UploadStashFile.

Definition at line 423 of file File.php.

References getUrl(), and PROTO_RELATIVE.

◆ getHandler()

File::getHandler ( )

Get a MediaHandler instance for this file.

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

Definition at line 1548 of file File.php.

Referenced by canAnimateThumbIfAppropriate(), getAvailableLanguages(), getDefaultRenderLanguage(), LocalFile\getHeight(), getLength(), getMatchedLanguage(), LocalFile\getWidth(), ThumbnailRenderJob\hitThumbUrl(), isVectorized(), LocalFile\maybeUpgradeRow(), and wfThumbIsStandard().

◆ getHandlerState()

File::getHandlerState ( string $key )

Get a value, or null if it does not exist.

Parameters

string $key

Returns: mixed|null

Implements MediaHandlerState.

Definition at line 743 of file File.php.

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

◆ 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

Stability: stable: to override

Parameters

int $page

Returns: int|false False on failure

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 531 of file File.php.

Referenced by getDisplayWidthHeight().

◆ getHistory()

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

Return a fragment of the history of file.

STUB

Stability: 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 1657 of file File.php.

◆ getIsSafeFile()

File::getIsSafeFile ( )

protected

Accessor for __get()

Returns: bool

Definition at line 935 of file File.php.

◆ getIsSafeFileUncached()

File::getIsSafeFileUncached ( )

protected

Uncached accessor.

Returns: bool

Definition at line 944 of file File.php.

References MEDIATYPE_UNKNOWN.

◆ getLastError()

File::getLastError ( )

Get last thumbnailing error.

Largely obsolete.

Returns: string

Definition at line 1585 of file File.php.

◆ getLength()

File::getLength ( )

Get the duration of a media file in seconds.

Stability: stable: to override

Returns: float|int

Definition at line 626 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|false False on failure

Definition at line 485 of file File.php.

References assertRepoDefined(), and getPath().

Referenced by UnregisteredLocalFile\getMimeType().

◆ getLongDesc()

File::getLongDesc ( )

Returns: string

Definition at line 2382 of file File.php.

References MediaHandler\getLongDesc().

◆ getMatchedLanguage()

File::getMatchedLanguage ( $userPreferredLanguage )

Get the IETF 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 676 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

Stability: stable: to override

Returns: string

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 855 of file File.php.

References MEDIATYPE_UNKNOWN.

◆ getMetadata()

File::getMetadata ( )

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

Deprecated: since 1.37 use getMetadataArray() or getMetadataItem()

Returns: string|false

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 739 of file File.php.

◆ getMetadataArray()

File::getMetadataArray ( )

Get the unserialized handler-specific metadata STUB.

Since: 1.37

Returns: array

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 757 of file File.php.

Referenced by SvgHandler\getAvailableLanguages(), ExifBitmapHandler\getCommonMetaArray(), SvgHandler\getCommonMetaArray(), GIFHandler\getCommonMetaArray(), and PNGHandler\getCommonMetaArray().

◆ getMetadataItem()

File::getMetadataItem ( string $itemName )

Get a specific element of the unserialized handler-specific metadata.

Since: 1.37

Parameters

string $itemName

Returns: mixed

Definition at line 768 of file File.php.

◆ getMetadataItems()

File::getMetadataItems ( array $itemNames )

Get multiple elements of the unserialized handler-specific metadata.

Since: 1.37

Parameters

string[] $itemNames

Returns: array

Reimplemented in LocalFile.

Definition at line 780 of file File.php.

◆ getMimeType()

File::getMimeType ( )

Returns the MIME type of the file.

Overridden by LocalFile, UnregisteredLocalFile STUB

Stability: stable: to override

Returns: string

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 843 of file File.php.

Referenced by checkExtensionCompatibility(), and getViewURL().

◆ getName()

File::getName ( )

Return the name of this file.

Stability: stable: to override

Returns: string

Definition at line 341 of file File.php.

References assertRepoDefined().

Referenced by compare(), LocalRepo\findFiles(), MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail(), LocalFile\getCacheKey(), ForeignDBFile\getDescriptionText(), getExtension(), getViewURL(), ImageHistoryList\imageHistoryLine(), LocalFile\loadFromDB(), PurgeChangedFiles\purgeFromArchiveTable(), ForeignAPIFile\transform(), and LocalFile\upgradeRow().

◆ getOriginalTitle()

File::getOriginalTitle ( )

Return the title used to find this file.

Returns: Title

Definition at line 380 of file File.php.

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

Stability: stable: to override

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

Reimplemented in ForeignAPIFile.

Definition at line 469 of file File.php.

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

Referenced by PurgeChangedFiles\getDeletedPath(), and getLocalRefPath().

◆ getRedirected()

File::getRedirected ( )

Returns: ?string The name that was used to access the file, before resolving redirects.

Definition at line 2419 of file File.php.

Referenced by ApiDelete\canDeleteFile().

◆ getRedirectedTitle()

File::getRedirectedTitle ( )

protected

Returns: Title|null

Definition at line 2426 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().

Stability: stable: to override

Returns: string

Reimplemented in OldLocalFile.

Definition at line 1708 of file File.php.

Referenced by getPath().

◆ getRepo()

File::getRepo ( )

Returns the repository.

Stability: stable: to override

Returns: FileRepo|false

Reimplemented in ForeignAPIFile, ForeignDBFile, and LocalFile.

Definition at line 2050 of file File.php.

Referenced by MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail(), and ImagePage\imageDupes().

◆ getRepoName()

File::getRepoName ( )

Returns the name of the repository.

Returns: string

Definition at line 2040 of file File.php.

◆ getSha1()

File::getSha1 ( )

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

Stability: stable: to override

Returns: string|false

Reimplemented in ForeignAPIFile, LocalFile, and UploadStashFile.

Definition at line 2331 of file File.php.

Referenced by FormatMetadata\fetchExtendedMetadata(), MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail(), and DjVuHandler\getDimensionInfo().

◆ getShortDesc()

File::getShortDesc ( )

Returns: string

Definition at line 2394 of file File.php.

References MediaHandler\getShortDesc().

◆ getSize()

File::getSize ( )

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

Stability: stable: to override

Returns: int|false

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 831 of file File.php.

◆ getStorageKey()

File::getStorageKey ( )

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

Returns: string|false

Definition at line 2342 of file File.php.

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

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

◆ 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: int|false

Definition at line 544 of file File.php.

References getWidth().

◆ getThumbnails()

File::getThumbnails ( )

protected

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

Stability: stable: to override

Returns: string[]

Reimplemented in ForeignAPIFile.

Definition at line 1596 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 1425 of file File.php.

References $params, and MediaWiki\PoolCounter\PoolCounterWork\execute().

◆ getThumbPath()

File::getThumbPath ( $suffix = false )

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

Stability: stable: to override

Parameters

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

Returns: string

Reimplemented in ForeignAPIFile, and UploadStashFile.

Definition at line 1809 of file File.php.

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

Stability: stable: to override

Parameters

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

Returns: string

Definition at line 1739 of file File.php.

References $path.

◆ getThumbUrl()

File::getThumbUrl ( $suffix = false )

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

Stability: stable: to override

Parameters

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

Returns: string Path

Reimplemented in UploadStashFile.

Definition at line 1892 of file File.php.

Referenced by ThumbnailRenderJob\hitThumbUrl().

◆ getThumbVirtualUrl()

File::getThumbVirtualUrl ( $suffix = false )

Get the virtual URL for a thumbnail file or directory.

Stability: stable: to override

Parameters

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

Returns: string

Definition at line 1965 of file File.php.

References $path.

◆ getTimestamp()

File::getTimestamp ( )

Get the 14-character timestamp of the file upload.

Stability: stable: to override

Returns: string|false TS_MW timestamp or false on failure

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 2307 of file File.php.

Referenced by LocalRepo\findFiles(), FormatMetadata\getExtendedMetadataFromFile(), and getTimestamp().

◆ getTitle()

File::getTitle ( )

Return the associated title object.

Returns: Title

Definition at line 371 of file File.php.

Referenced by LocalRepo\findFiles(), FormatMetadata\getExtendedMetadataFromFile(), ImagePage\imageDupes(), and PurgeChangedFiles\purgeFromArchiveTable().

◆ getTranscodedPath()

File::getTranscodedPath ( $suffix = false )

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

Parameters

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

Returns: string

Definition at line 1821 of file File.php.

◆ getTranscodedUrl()

File::getTranscodedUrl ( $suffix = false )

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

Parameters

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

Returns: string Path

Definition at line 1918 of file File.php.

◆ getUnscaledThumb()

File::getUnscaledThumb ( $handlerParams = [] )

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

Parameters

array $handlerParams

Returns: ThumbnailImage|MediaTransformOutput|false False on failure

Definition at line 1054 of file File.php.

◆ getUploader()

File::getUploader	(	int	$audience = self::FOR_PUBLIC,
		Authority	$performer = null )

Get the identity of the file uploader.

Note: if the file does not exist, this will return null regardless of the permissions.

Stability: stable: to override

Since: 1.37

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
Authority \| null	$performer	to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: UserIdentity|null

Reimplemented in ForeignAPIFile, and LocalFile.

Definition at line 2280 of file File.php.

◆ getUrl()

File::getUrl ( )

Return the URL of the file.

Stability: stable: to override

Returns: string

Reimplemented in ForeignAPIFile, and UploadStashFile.

Definition at line 394 of file File.php.

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

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

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

Stability: stable: to override

Returns: string

Reimplemented in OldLocalFile.

Definition at line 1755 of file File.php.

Referenced by getUrl().

◆ getViewURL()

File::getViewURL ( )

Returns: string

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

Stability: stable: to override

Parameters

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

Returns: string

Definition at line 1929 of file File.php.

References $path.

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

◆ getVisibility()

File::getVisibility ( )

Return the deletion bitfield STUB.

Stability: stable: to override

Returns: int

Reimplemented in OldLocalFile.

Definition at line 2083 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

Stability: stable: to override

Parameters

int $page

Returns: int|false

Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.

Definition at line 516 of file File.php.

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

◆ iconThumb()

File::iconThumb ( )

Get a ThumbnailImage representing a file type icon.

Returns: ThumbnailImage|null

Definition at line 1561 of file File.php.

References $IP, and $params.

◆ isCacheable()

File::isCacheable ( )

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

Stability: stable: to override

Returns: bool

Reimplemented in LocalFile.

Definition at line 2459 of file File.php.

◆ isDeleted()

File::isDeleted ( $field )

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

Stability: stable: to override

Parameters

int $field One of DELETED_* bitfield constants

Returns: bool

Reimplemented in OldLocalFile.

Definition at line 2073 of file File.php.

Referenced by FormatMetadata\fetchExtendedMetadata(), and LocalRepo\findFiles().

◆ isExpensiveToThumbnail()

File::isExpensiveToThumbnail ( )

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

Returns: bool

Definition at line 2485 of file File.php.

References MediaHandler\isExpensiveToThumbnail().

Referenced by MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail().

◆ isHashed()

File::isHashed ( )

protected

Returns: bool

Definition at line 1978 of file File.php.

◆ isLocal()

File::isLocal ( )

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

Returns: bool

Definition at line 2031 of file File.php.

Referenced by ApiDelete\canDeleteFile(), and ImagePage\imageDupes().

◆ isMissing()

File::isMissing ( )

Stability: stable: to override

Returns: bool

Reimplemented in LocalFile.

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

Stability: stable: to override

Returns: bool

Definition at line 2163 of file File.php.

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

◆ isOld()

File::isOld ( )

Returns true if the image is an old version STUB.

Stability: stable: to override

Returns: bool

Reimplemented in OldLocalFile.

Definition at line 2061 of file File.php.

Referenced by LocalRepo\findFiles().

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

◆ isTransformedLocally()

File::isTransformedLocally ( )

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

Since: 1.25

Stability: stable: to override

Returns: bool

Reimplemented in ForeignAPIFile.

Definition at line 2496 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 cryptographic signatures or such.

Returns: bool

Definition at line 988 of file File.php.

◆ isVectorized()

File::isVectorized ( )

Return true if the file is vectorized.

Returns: bool

Definition at line 640 of file File.php.

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

◆ 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

Stability: stable: to override

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

Reimplemented in OldLocalFile.

Definition at line 1026 of file File.php.

◆ 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

Stability: stable: to override

Parameters

int $flags Bitfield of IDBAccessObject::READ_* constants

Reimplemented in LocalFile.

Definition at line 1004 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 1512 of file File.php.

References FileBackend\extensionFromPath().

◆ migrateThumbFile()

File::migrateThumbFile ( $thumbName )

protected

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

Stability: stable: to override

Parameters

string $thumbName

Definition at line 1539 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

Stability: stable: to override

Parameters

Title $target New file name

Returns: Status

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2111 of file File.php.

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

Stability: stable: to override

Returns: bool

Definition at line 896 of file File.php.

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

Stability: stable: to override Overridden in LocalFile

Returns: bool

Reimplemented in LocalFile.

Definition at line 1671 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 263 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

PageIdentity \| LinkTarget \| string	$title
string \| false	$exception	Use 'exception' to throw an error on bad titles

Returns: Title|null

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

Stability: stable: to override

Returns: int|false

Definition at line 2174 of file File.php.

Referenced by MediaHandler\getEntireText().

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

Stability: stable: to override

Reimplemented in LocalFile, and ForeignDBFile.

Definition at line 2013 of file File.php.

◆ purgeCache()

File::purgeCache ( $options = [] )

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

Stability: 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 1608 of file File.php.

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

References getTitle().

◆ purgeEverything()

File::purgeEverything ( )

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

Definition at line 1629 of file File.php.

References $job, and getTitle().

◆ readOnlyError()

File::readOnlyError ( )

protected

Returns: never

Definition at line 1987 of file File.php.

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

◆ redirectedFrom()

File::redirectedFrom ( string $from )

Parameters

string $from The name that was used to access the file, before resolving redirects.

Definition at line 2442 of file File.php.

Referenced by LocalRepo\findFiles().

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

Stability: stable: to override

Reimplemented in LocalFile.

Definition at line 1682 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

int[]	$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

Stability: stable: to override

Reimplemented in ForeignDBFile, and LocalFile.

Definition at line 2151 of file File.php.

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

◆ setHandlerState()

File::setHandlerState	(	string	$key,
			$value )

Set a value.

Parameters

string	$key
mixed	$value

Implements MediaHandlerState.

Definition at line 747 of file File.php.

◆ splitMime()

static File::splitMime ( ?string $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 314 of file File.php.

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

Stability: 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 1078 of file File.php.

References $params.

Referenced by ThumbnailRenderJob\hitThumbUrl().

◆ transform()

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

Transform a media file.

Stability: 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|false False on failure

Reimplemented in ForeignAPIFile.

Definition at line 1177 of file File.php.

References $params, MediaHandler\getScriptedTransform(), MediaHandler\getTransform(), MediaHandler\normaliseParams(), PROTO_CANONICAL, wfDebug(), and wfMessage().

Referenced by MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail().

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

References $params, MediaHandler\getTransform(), and wfMessage().

◆ upgradeRow()

File::upgradeRow ( )

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

Stability: stable: to override

Reimplemented in LocalFile, and OldLocalFile.

Definition at line 304 of file File.php.

◆ userCan()

File::userCan	(		$field,
		Authority	$performer )

Determine if the current user is allowed to view a particular field of this file, if it's marked as deleted.

STUB

Stability: stable: to override

Parameters

int	$field
Authority	$performer	user object to check

Returns: bool

Reimplemented in OldLocalFile.

Definition at line 2362 of file File.php.

Referenced by LocalRepo\findFiles().

◆ wasDeleted()

File::wasDeleted ( )

Was this file ever deleted from the wiki?

Returns: bool

Definition at line 2092 of file File.php.

References getTitle().

Member Data Documentation

◆ $canRender

bool File::$canRender

protected

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

Definition at line 170 of file File.php.

◆ $extension

string File::$extension

protected

File extension.

Definition at line 147 of file File.php.

◆ $fsFile

FSFile false File::$fsFile

protected

False if undefined.

Definition at line 138 of file File.php.

◆ $handler

MediaHandler File::$handler

protected

Definition at line 141 of file File.php.

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

◆ $hashPath

string null File::$hashPath

protected

Relative path including trailing slash.

Definition at line 156 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 175 of file File.php.

◆ $lastError

string File::$lastError

protected

Text of last error.

Definition at line 126 of file File.php.

◆ $name

string null File::$name

protected

The name of a file from its title object.

Definition at line 150 of file File.php.

Referenced by __get(), 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 161 of file File.php.

◆ $path

string File::$path

protected

The storage path corresponding to one of the zones.

Definition at line 153 of file File.php.

◆ $redirected

string File::$redirected

protected

The name that was used to access the file, before resolving redirects.

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

Definition at line 132 of file File.php.

◆ $redirectedTitle

Title File::$redirectedTitle

protected

Definition at line 135 of file File.php.

◆ $redirectTitle

Title File::$redirectTitle

protected

Definition at line 167 of file File.php.

◆ $repo

FileRepo LocalRepo ForeignAPIRepo false 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 120 of file File.php.

Referenced by UploadStashFile\__construct(), __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 178 of file File.php.

◆ $title

Title string false File::$title

protected

Definition at line 123 of file File.php.

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

◆ $tmpBucketedThumbCache

array File::$tmpBucketedThumbCache = []

protected

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

Definition at line 181 of file File.php.

◆ $transformScript

string false File::$transformScript

protected

URL of transformscript (for example thumb.php)

Definition at line 164 of file File.php.

◆ $url

string File::$url

protected

The URL corresponding to one of the four basic zones.

Definition at line 144 of file File.php.

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

◆ DELETE_SOURCE

const File::DELETE_SOURCE = 1

Definition at line 90 of file File.php.

Referenced by LocalFile\publishTo().

◆ DELETED_COMMENT

const File::DELETED_COMMENT = 2

Definition at line 78 of file File.php.

◆ DELETED_FILE

const File::DELETED_FILE = 1

Definition at line 77 of file File.php.

Referenced by OldLocalFile\isVisible().

◆ DELETED_RESTRICTED

const File::DELETED_RESTRICTED = 8

Definition at line 80 of file File.php.

◆ DELETED_USER

const File::DELETED_USER = 4

Definition at line 79 of file File.php.

◆ FOR_PUBLIC

const File::FOR_PUBLIC = 1

Definition at line 93 of file File.php.

◆ FOR_THIS_USER

const File::FOR_THIS_USER = 2

Definition at line 94 of file File.php.

◆ RAW

const File::RAW = 3

Definition at line 95 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 88 of file File.php.

◆ RENDER_NOW

const File::RENDER_NOW = 1

Force rendering in the current process.

Definition at line 83 of file File.php.

◆ THUMB_FULL_NAME

const File::THUMB_FULL_NAME = 1

Definition at line 98 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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ allowInlineDisplay()

◆ assertRepoDefined()

◆ assertTitleDefined()

◆ canAnimateThumbIfAppropriate()

◆ canRender()

◆ checkExtensionCompatibility()

◆ compare()

◆ convertMetadataVersion()

◆ createThumb()

◆ deleteFile()

◆ exists()

◆ formatMetadata()

◆ generateAndSaveThumb()

◆ generateBucketsIfNeeded()

◆ generateThumbName()

◆ getArchivePath()

◆ getArchiveRel()

◆ getArchiveThumbPath()

◆ getArchiveThumbUrl()

◆ getArchiveUrl()

◆ getArchiveVirtualUrl()

◆ getAvailableLanguages()

◆ getBitDepth()

◆ getBucketThumbName()

◆ getBucketThumbPath()

◆ getCanonicalUrl()

◆ getCanRender()

◆ getCommonMetaArray()

◆ getContentHeaders()

◆ getDefaultRenderLanguage()

◆ getDescription()

◆ getDescriptionShortUrl()

◆ getDescriptionText()

◆ getDescriptionTouched()

◆ getDescriptionUrl()

◆ getDimensionsString()

◆ getDisplayWidthHeight()

◆ getExtension()

◆ getFilePageThumbUrl()

◆ getFullUrl()

◆ getHandler()

◆ getHandlerState()

◆ getHashPath()

◆ getHeight()

◆ getHistory()

◆ getIsSafeFile()

◆ getIsSafeFileUncached()

◆ getLastError()

◆ getLength()

◆ getLocalRefPath()

◆ getLongDesc()

◆ getMatchedLanguage()

◆ getMediaType()

◆ getMetadata()

◆ getMetadataArray()

◆ getMetadataItem()

◆ getMetadataItems()

◆ getMimeType()

◆ getName()

◆ getOriginalTitle()

◆ getPath()

◆ getRedirected()

◆ getRedirectedTitle()

◆ getRel()

◆ getRepo()

◆ getRepoName()

◆ getSha1()

◆ getShortDesc()

◆ getSize()

◆ getStorageKey()