MediaWiki\FileRepo\File\ForeignDBFile Class Reference

Foreign file from a reachable database in the same wiki farm. More...

Inherits MediaWiki\FileRepo\File\LocalFile.

Collaboration diagram for MediaWiki\FileRepo\File\ForeignDBFile:

Public Member Functions
	deleteFile ( $reason, UserIdentity $user, $suppress=false)
	getDescriptionShortUrl ()
	Get short description URL for a file based on the page ID.
	getDescriptionText (?Language $lang=null)
	getDescriptionUrl ()
	getRepo ()
	move ( $target)
	publish ( $srcPath, $flags=0, array $options=[])
	restore ( $versions=[], $unsuppress=false)
Public Member Functions inherited from MediaWiki\FileRepo\File\LocalFile
	__construct ( $title, $repo)
	Do not call this except from inside a repo class.
	__destruct ()
	Clean up any dangling locks.
	acquireFileIdFromName ()
	This is mostly for the migration period.
	acquireFileLock ( $timeout=0)
	Acquire an exclusive lock on the file, indicating an intention to write to the file backend.
	deleteOldFile ( $archiveName, $reason, UserIdentity $user, $suppress=false)
	Delete an old version of the file.
	exists ()
	canRender inherited
	getBitDepth ()
	getDescription ( $audience=self::FOR_PUBLIC, ?Authority $performer=null)
	getDescriptionTouched ()
	getFileIdFromName ()
	This is mostly for the migration period.
	getHeight ( $page=1)
	Return the height of the image.
	getHistory ( $limit=null, $start=null, $end=null, $inc=true)
	purgeDescription inherited
	getMediaType ()
	Returns the type of the media in the file.
	getMetadata ()
	Get handler-specific metadata as a serialized string.
	getMetadataArray ()
	Get unserialized handler-specific metadata.
	getMetadataForDb (IReadableDatabase $db)
	Serialize the metadata array for insertion into img_metadata, oi_metadata or fa_metadata.
	getMetadataItems (array $itemNames)
	Get multiple elements of the unserialized handler-specific metadata.
	getMimeType ()
	Returns the MIME type of the file.
	getSha1 ()
	getSize ()
	Returns the size of the image file, in bytes.
	getTimestamp ()
	getUpgraded ()
	getUploader (int $audience=self::FOR_PUBLIC, ?Authority $performer=null)
	getWidth ( $page=1)
	Return the width of the image.
	invalidateCache ()
	Purge the file object/metadata cache.
	isCacheable ()
	isMissing ()
	splitMime inherited
	load ( $flags=0)
	Load file metadata from cache or DB, unless already loaded.
	loadFromFile ( $path=null)
	Load metadata from the file itself.
	loadFromRow ( $row, $prefix='img_')
	Load file metadata from a DB result row.
	lock ()
	Start an atomic DB section and lock the image for update or increments a reference counter if the lock is already held.
	maybeUpgradeRow ()
	Upgrade a row if it needs it.
	nextHistoryLine ()
	Returns the history of this file, line by line.
	prerenderThumbnails ()
	Prerenders a configurable set of thumbnails.
	purgeCache ( $options=[])
	Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
	purgeOldThumbnails ( $archiveName)
	Delete cached transformed files for an archived version only.
	purgeThumbnails ( $options=[])
	Delete cached transformed files for the current version only.
	recordUpload3 (string $oldver, string $comment, string $pageText, Authority $performer, $props=false, $timestamp=false, $tags=[], bool $createDummyRevision=true, bool $revert=false)
	Record a file upload in the upload log and the image table (version 3)
	releaseFileLock ()
	Release a lock acquired with acquireFileLock().
	resetHistory ()
	Reset the history pointer to the first element of the history.
	setProps ( $info)
	Set properties in this object to be equal to those given in the associative array $info.
	unlock ()
	Decrement the lock reference count and end the atomic section if it reaches zero.
	upgradeRow ()
	Fix assorted version-related problems with the image row by reloading it from the file.
	upload ( $src, $comment, $pageText, $flags=0, $props=false, $timestamp=false, ?Authority $uploader=null, $tags=[], $createDummyRevision=true, $revert=false)
	getHashPath inherited
Public Member Functions inherited from MediaWiki\FileRepo\File\File
	__get ( $name)
	addToShellboxCommand (BoxedCommand $command, string $boxedName)
	Add the file to a Shellbox command as an input file.
	allowInlineDisplay ()
	Alias for canRender()
	canAnimateThumbIfAppropriate ()
	Will the thumbnail be animated if one would expect it to be.
	canRender ()
	Checks if the output of transform() for this file is likely to be valid.
	convertMetadataVersion ( $metadata, $version)
	get versioned metadata
	createThumb ( $width, $height=-1)
	Create a thumbnail of the image having the specified width/height.
	formatMetadata ( $context=false)
	generateAndSaveThumb ( $tmpFile, $transformParams, $flags)
	Generates a thumbnail according to the given parameters and saves it to storage.
	generateThumbName ( $name, $params)
	Generate a thumbnail file name from a name and specified parameters.
	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.
	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.
	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. Parameters string $key Returns mixed|null
	getHashPath ()
	Get the filename hash component of the directory including trailing slash, e.g.
	getLastError ()
	Get last thumbnailing error.
	getLength ()
	Get the duration of a media file in seconds.
	getLocalRefPath ()
	Get an FS copy or original of this file and return the path.
	getLongDesc ()
	Long description.
	getMatchedLanguage ( $userPreferredLanguage)
	Get the IETF language code from the available languages for this file that matches the language requested by the user.
	getMetadataItem (string $itemName)
	Get a specific element 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.
	getRepoName ()
	Returns the name of the repository.
	getShortDesc ()
	Short description.
	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.
	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.
	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.
	iconThumb ()
	Get a ThumbnailImage representing a file type icon.
	isDeleted ( $field)
	Is this file a "deleted" file in a private archive? STUB.
	isExpensiveToThumbnail ()
	True if creating thumbnails from the file is large or otherwise resource-intensive.
	isLocal ()
	Returns true if the file comes from the local file repository.
	isMultipage ()
	Returns 'true' if this file is a type which supports multiple pages, e.g.
	isOld ()
	Returns true if the image is an old version STUB.
	isSafeFile ()
	Determines if this media file is in a format that is unlikely to contain viruses or malicious content.
	isTransformedLocally ()
	Whether the thumbnails created on the same server as this code is running.
	isVectorized ()
	Return true if the file is vectorized.
	isVisible ()
	Returns true if file exists in the repository and can be included in a page.
	mustRender ()
	Return true if the file is of a type that can't be directly rendered by typical browsers and needs to be re-rasterized.
	pageCount ()
	Returns the number of pages of a multipage document, or false for documents which aren't multipage documents.
	purgeDescription ()
	Purge the file description page, but don't go after pages using the file.
	purgeEverything ()
	Purge metadata and all affected pages when the file is created, deleted, or majorly updated.
	redirectedFrom (string $from)
	setHandlerState (string $key, $value)
	Set a value. Parameters string $key mixed $value
	thumbName ( $params, $flags=0)
	Return the file name of a thumbnail with the specified parameters.
	transform ( $params, $flags=0)
	Transform a media 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.
	wasDeleted ()
	Was this file ever deleted from the wiki?

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\FileRepo\File\LocalFile
static	getQueryInfo (array $options=[])
	Return the tables, fields, and join conditions to be selected to create a new localfile object.
static	newFromKey ( $sha1, $repo, $timestamp=false)
	Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class.
static	newFromRow ( $row, $repo)
	Create a LocalFile from a title Do not call this except from inside a repo class.
static	newFromTitle ( $title, $repo, $unused=null)
	Create a LocalFile from a title Do not call this except from inside a repo class.
Static Public Member Functions inherited from MediaWiki\FileRepo\File\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 (?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 inherited from MediaWiki\FileRepo\File\File
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 inherited from MediaWiki\FileRepo\File\LocalFile
	getCacheFields ( $prefix='img_')
	Returns the list of object properties that are included as-is in the cache.
	getCacheKey ()
	Get the memcached key for the main data for this file, or false if there is no access to the shared cache.
	getFileTypeId ()
	getLazyCacheFields ( $prefix='img_')
	Returns the list of object properties that are included as-is in the cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB().
	getThumbnails ( $archiveName=false)
	getTransformScript inherited
	loadExtraFromDB ()
	Load lazy file metadata from the DB.
	loadFromDB ( $flags=0)
	Load file metadata from the DB.
	loadMetadataFromDbFieldValue (IReadableDatabase $db, $metadataBlob)
	Unserialize a metadata blob which came from the database and store it in $this.
	loadMetadataFromString ( $metadataString)
	Unserialize a metadata string which came from some non-DB source, or is the return value of IReadableDatabase::decodeBlob().
	publishTo ( $src, $dstRel, $flags=0, array $options=[])
	Move or copy a file to a specified location.
	purgeThumbList ( $dir, $files)
	Delete a list of thumbnails visible at urls.
	readOnlyFatalStatus ()
	reserializeMetadata ()
	Write the metadata back to the database with the current serialization format.
	unprefixRow ( $row, $prefix='img_')
Protected Member Functions inherited from MediaWiki\FileRepo\File\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()
	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.
	readOnlyError ()
	transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags)
	Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
Protected Attributes inherited from MediaWiki\FileRepo\File\LocalFile
int	$bits
	Returned by getimagesize (loadFromXxx)
bool	$dataLoaded = false
	Whether or not core data has been loaded from the database (loadFromXxx)
int	$deleted
	Bitfield akin to rev_deleted.
bool	$extraDataLoaded = false
	Whether or not lazy-loaded data has been loaded from the database.
int	$file_id
	id in file table, null on read old
bool	$fileExists
	Does the file exist on disk? (loadFromXxx)
int	$filerevision_id
	id in filerevision table, null on read old
int	$height
	Image height.
string	$media_type
	MEDIATYPE_xxx (bitmap, drawing, audio...)
array	$metadataArray = []
	Unserialized metadata.
string[]	$metadataBlobs = []
	Map of metadata item name to blob address.
string null	$metadataSerializationFormat
	One of the MDS_* constants, giving the format of the metadata as stored in the DB, or null if the data was not loaded from the DB.
string	$mime
	MIME type, determined by MimeAnalyzer::guessMimeType.
string	$repoClass = LocalRepo::class
string	$sha1
	SHA-1 base 36 content hash.
int	$size
	Size in bytes (loadFromXxx)
string[]	$unloadedMetadataBlobs = []
	Map of metadata item name to blob address for items that exist but have not yet been loaded into $this->metadataArray.
int	$width
	Image width.
Protected Attributes inherited from MediaWiki\FileRepo\File\File
bool null	$canRender
	Whether the output of transform() for this file is likely to be valid.
string null	$extension
	File extension.
FSFile false null	$fsFile
	False if undefined.
MediaHandler null	$handler
string null	$hashPath
	Relative path including trailing slash.
bool null	$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 null	$pageCount
	Number of pages of a multipage document, or false for documents which aren't multipage documents.
string null	$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 null	$transformScript
	URL of transformscript (for example thumb.php)
string null	$url
	The URL corresponding to one of the four basic zones.

Detailed Description

Foreign file from a reachable database in the same wiki farm.

Definition at line 22 of file ForeignDBFile.php.

Member Function Documentation

deleteFile()

MediaWiki\FileRepo\File\ForeignDBFile::deleteFile	(		$reason,
		UserIdentity	$user,
			$suppress = false )

Parameters

string	$reason
UserIdentity	$user
bool	$suppress

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 53 of file ForeignDBFile.php.

getDescriptionShortUrl()

MediaWiki\FileRepo\File\ForeignDBFile::getDescriptionShortUrl

(

)

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

Returns

string|null

Exceptions

DBUnexpectedError

Since

1.27

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 129 of file ForeignDBFile.php.

References $url, and NS_FILE.

getDescriptionText()

MediaWiki\FileRepo\File\ForeignDBFile::getDescriptionText

(

?Language

$lang = null

)

Parameters

Language | null

$lang

Optional language to fetch description in.

Returns

string|false

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 76 of file ForeignDBFile.php.

References $wgLang, NS_FILE, and wfDebug().

getDescriptionUrl()

MediaWiki\FileRepo\File\ForeignDBFile::getDescriptionUrl

(

)

Returns

string

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 67 of file ForeignDBFile.php.

getRepo()

MediaWiki\FileRepo\File\ForeignDBFile::getRepo

(

)

Returns

ForeignDBRepo|false

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 27 of file ForeignDBFile.php.

References MediaWiki\FileRepo\File\File\$repo.

move()

MediaWiki\FileRepo\File\ForeignDBFile::move

(

$target

)

Parameters

Title

$target

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 60 of file ForeignDBFile.php.

publish()

MediaWiki\FileRepo\File\ForeignDBFile::publish	(		$srcPath,
			$flags = 0,
		array	$options = [] )

Parameters

string	$srcPath
int	$flags
array	$options

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 36 of file ForeignDBFile.php.

restore()

MediaWiki\FileRepo\File\ForeignDBFile::restore	(		$versions = [],
			$unsuppress = false )

Parameters

int[]	$versions
bool	$unsuppress

Reimplemented from MediaWiki\FileRepo\File\LocalFile.

Definition at line 44 of file ForeignDBFile.php.

---

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

• includes/FileRepo/File/ForeignDBFile.php