A file object referring to either a standalone local file, or a file in a local repository with no database, for example an FileRepo repository. More...

Inheritance diagram for UnregisteredLocalFile:

[legend]

Collaboration diagram for UnregisteredLocalFile:

[legend]

Public Member Functions
	__construct ( $title=false, $repo=false, $path=false, $mime=false)
	Create an UnregisteredLocalFile based on a path or a (title,repo) pair.

	getBitDepth ()

	getHeight ( $page=1)

	getMetadata ()

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

	getMimeType ()

	getSize ()

	getURL ()

	getWidth ( $page=1)

	setLocalReference (FSFile $fsFile)
	Optimize getLocalRefPath() by using an existing local reference.

Public Member Functions inherited from File
	__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 languages to render the file in.

	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.

	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.

	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.

	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.

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

	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.

	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.

	getVisibility ()
	Return the deletion bitfield STUB.

	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 ( $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	newFromPath ( $path, $mime)

static	newFromTitle ( $title, $repo)

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

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

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

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

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

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

Public Attributes
MediaHandler	$handler

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

const	DELETE_SOURCE = 1

const	DELETED_COMMENT = 2

const	DELETED_FILE = 1

const	DELETED_RESTRICTED = 8

const	DELETED_USER = 4

const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

const	RAW = 3

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

const	RENDER_NOW = 1
	Force rendering in the current process.

const	THUMB_FULL_NAME = 1

Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS)

Protected Attributes
bool string	$mime

array[] bool[]	$pageDims
	Dimension data.

string	$path

array null	$sizeAndMetadata

Title	$title

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

string	$extension
	File extension.

FSFile bool	$fsFile
	False if undefined.

MediaHandler	$handler

string	$hashPath
	Relative path including trailing slash.

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

string	$lastError
	Text of last error.

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

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

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

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

Title	$redirectedTitle

Title	$redirectTitle

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

Title string bool	$title

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

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

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

Private Member Functions
	cachePageDimensions ( $page=1)

	getSizeAndMetadata ()

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

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

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

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

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

	getCanRender ()
	Accessor for __get()

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

	getIsSafeFile ()
	Accessor for __get()

	getIsSafeFileUncached ()
	Uncached accessor.

	getRedirectedTitle ()

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

	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)

Detailed Description

A file object referring to either a standalone local file, or a file in a local repository with no database, for example an FileRepo repository.

Read-only.

Todo:: Currently it doesn't really work in the repository role, there are lots of functions missing. It is used by the WebStore extension in the standalone role.

Definition at line 36 of file UnregisteredLocalFile.php.

Constructor & Destructor Documentation

◆ __construct()

UnregisteredLocalFile::__construct	(	$title = `false`,
		$repo = `false`,
		$path = `false`,
		$mime = `false`
	)

Create an UnregisteredLocalFile based on a path or a (title,repo) pair.

A FileRepo object is not required here, unlike most other File classes.

Exceptions

MWException

Parameters

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

Definition at line 83 of file UnregisteredLocalFile.php.

References $mime, File\$name, $path, File\$repo, $title, File\assertRepoDefined(), FileRepo\getHashPath(), FileRepo\getNameFromTitle(), FileRepo\getRootDirectory(), and File\normalizeTitle().

Member Function Documentation

◆ cachePageDimensions()

UnregisteredLocalFile::cachePageDimensions ( $page = 1 )

private

Parameters

int $page

Returns: array|bool

Definition at line 113 of file UnregisteredLocalFile.php.

References File\getHandler(), and getSizeAndMetadata().

Referenced by getHeight(), and getWidth().

◆ getBitDepth()

UnregisteredLocalFile::getBitDepth ( )

Returns: int

Reimplemented from File.

Definition at line 172 of file UnregisteredLocalFile.php.

References getSizeAndMetadata().

◆ getHeight()

UnregisteredLocalFile::getHeight ( $page = 1 )

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 151 of file UnregisteredLocalFile.php.

References cachePageDimensions().

◆ getMetadata()

UnregisteredLocalFile::getMetadata ( )

Returns: string|false

Reimplemented from File.

Definition at line 180 of file UnregisteredLocalFile.php.

References getSizeAndMetadata(), and serialize().

◆ getMetadataArray()

UnregisteredLocalFile::getMetadataArray ( )

Get the unserialized handler-specific metadata STUB.

Since: 1.37

Returns: array

Reimplemented from File.

Definition at line 185 of file UnregisteredLocalFile.php.

◆ getMimeType()

UnregisteredLocalFile::getMimeType ( )

Returns: bool|string

Reimplemented from File.

Definition at line 160 of file UnregisteredLocalFile.php.

References $mime, and File\getLocalRefPath().

◆ getSize()

UnregisteredLocalFile::getSize ( )

Returns: false|int

Reimplemented from File.

Definition at line 218 of file UnregisteredLocalFile.php.

◆ getSizeAndMetadata()

UnregisteredLocalFile::getSizeAndMetadata ( )

private

Definition at line 190 of file UnregisteredLocalFile.php.

Referenced by cachePageDimensions(), getBitDepth(), and getMetadata().

◆ getURL()

UnregisteredLocalFile::getURL ( )

Returns: bool|string

Definition at line 206 of file UnregisteredLocalFile.php.

◆ getWidth()

UnregisteredLocalFile::getWidth ( $page = 1 )

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 141 of file UnregisteredLocalFile.php.

References cachePageDimensions().

◆ newFromPath()

static UnregisteredLocalFile::newFromPath	(	$path,
		$mime
	)

static

Parameters

string	$path	Storage path
string	$mime

Returns: static

Definition at line 60 of file UnregisteredLocalFile.php.

References $mime, and $path.

◆ newFromTitle()

static UnregisteredLocalFile::newFromTitle	(	$title,
		$repo
	)

static

Parameters

Title	$title
FileRepo	$repo

Returns: static

Definition at line 69 of file UnregisteredLocalFile.php.

References File\$repo, and $title.

◆ setLocalReference()

UnregisteredLocalFile::setLocalReference ( FSFile $fsFile )

Optimize getLocalRefPath() by using an existing local reference.

The file at the path of $fsFile should not be deleted (or at least not until the end of the request). This is mostly a performance hack.

Parameters

FSFile $fsFile

Returns: void

Definition at line 232 of file UnregisteredLocalFile.php.

Member Data Documentation

◆ $handler

MediaHandler UnregisteredLocalFile::$handler

Definition at line 53 of file UnregisteredLocalFile.php.

◆ $mime

bool string UnregisteredLocalFile::$mime

protected

Definition at line 44 of file UnregisteredLocalFile.php.

Referenced by __construct(), getMimeType(), and newFromPath().

◆ $pageDims

array [] bool [] UnregisteredLocalFile::$pageDims

protected

Dimension data.

Definition at line 47 of file UnregisteredLocalFile.php.

◆ $path

string UnregisteredLocalFile::$path

protected

Definition at line 41 of file UnregisteredLocalFile.php.

Referenced by UploadStashFile\__construct(), __construct(), UploadStashFile\getThumbPath(), and newFromPath().

◆ $sizeAndMetadata

array null UnregisteredLocalFile::$sizeAndMetadata

protected

Definition at line 50 of file UnregisteredLocalFile.php.

◆ $title

Title UnregisteredLocalFile::$title

protected

Definition at line 38 of file UnregisteredLocalFile.php.

Referenced by __construct(), and newFromTitle().

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

includes/filerepo/file/UnregisteredLocalFile.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cachePageDimensions()

◆ getBitDepth()

◆ getHeight()

◆ getMetadata()

◆ getMetadataArray()

◆ getMimeType()

◆ getSize()

◆ getSizeAndMetadata()

◆ getURL()

◆ getWidth()

◆ newFromPath()

◆ newFromTitle()

◆ setLocalReference()

Member Data Documentation

◆ $handler

◆ $mime

◆ $pageDims

◆ $path

◆ $sizeAndMetadata

◆ $title