ForeignDBFile Class Reference

Foreign file with an accessible MediaWiki database. More...

Inheritance diagram for ForeignDBFile:

Collaboration diagram for ForeignDBFile:

Public Member Functions
	delete ( $reason, $suppress=false, $user=null)
	getDescriptionShortUrl ()
	Get short description URL for a file based on the page ID.
	getDescriptionText ( $lang=false)
	getDescriptionUrl ()
	move ( $target)
	publish ( $srcPath, $flags=0, array $options=[])
	recordUpload ( $oldver, $desc, $license='', $copyStatus='', $source='', $watch=false, $timestamp=false, User $user=null)
	restore ( $versions=[], $unsuppress=false)
Public Member Functions inherited from LocalFile
	__construct ( $title, $repo)
	Constructor.
	__destruct ()
	Clean up any dangling locks.
	acquireFileLock ()
	decodeRow ( $row, $prefix='img_')
	Decode a row from the database (either object or array) to an array with timestamps and MIME types decoded, and the field prefix removed.
	deleteOld ( $archiveName, $reason, $suppress=false, $user=null)
	Delete an old version of the file.
	exists ()
	canRender inherited
	getBitDepth ()
	getCacheFields ( $prefix='img_')
	getCacheKey ()
	Get the memcached key for the main data for this file, or false if there is no access to the shared cache.
	getDescription ( $audience=self::FOR_PUBLIC, User $user=null)
	getDescriptionTouched ()
	getHeight ( $page=1)
	Return the height of the image.
	getHistory ( $limit=null, $start=null, $end=null, $inc=true)
	purgeDescription inherited
	getLazyCacheFields ( $prefix='img_')
	getMediaType ()
	Returns the type of the media in the file.
	getMetadata ()
	Get handler-specific metadata.
	getMimeType ()
	Returns the MIME type of the file.
	getSha1 ()
	getSize ()
	Returns the size of the image file, in bytes.
	getThumbnails ( $archiveName=false)
	getTransformScript inherited
	getTimestamp ()
	getUpgraded ()
	getUser ( $type='text')
	Returns ID or name of user who uploaded the file.
	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.
	loadFromDB ( $flags=0)
	Load file metadata from the DB.
	loadFromFile ()
	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.
	publishTo ( $src, $dstRel, $flags=0, array $options=[])
	Move or copy a file to a specified location.
	purgeCache ( $options=[])
	Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
	purgeMetadataCache ()
	Refresh metadata in memcached, but don't touch thumbnails or CDN.
	purgeOldThumbnails ( $archiveName)
	Delete cached transformed files for an archived version only.
	purgeThumbnails ( $options=[])
	Delete cached transformed files for the current version only.
	recordUpload2 ( $oldver, $comment, $pageText, $props=false, $timestamp=false, $user=null, $tags=[])
	Record a file upload in the upload log and the image table.
	releaseFileLock ()
	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, $user=null, $tags=[])
	getHashPath inherited
Public Member Functions inherited from File
	__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.
	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.
	getArchiveThumbRel ( $archiveName, $suffix=false)
	Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory or a specific thumb if the $suffix is given.
	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.
	getDefaultRenderLanguage ()
	In files that support multiple language, what is the default language to use if none specified.
	getDimensionsString ()
	getExtension ()
	Get the file extension, e.g.
	getFullUrl ()
	Return a fully-qualified URL to the file.
	getHandler ()
	Get a MediaHandler instance for this file.
	getHashPath ()
	Get the filename hash component of the directory including trailing slash, e.g.
	getImageSize ( $filePath)
	Get an image size array like that returned by getImageSize(), or false if it can't be determined.
	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 ()
	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 ()
	getRedirectedTitle ()
	getRel ()
	Get the path of the file relative to the public zone root.
	getRepo ()
	Returns the repository.
	getRepoName ()
	Returns the name of the repository.
	getShortDesc ()
	getStorageKey ()
	Get the deletion archive key, "<sha1>.<ext>".
	getStreamHeaders ()
	getThumbDisposition ( $thumbName, $dispositionType='inline')
	getThumbnailBucket ( $desiredWidth, $page=1)
	Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistance larger than $desiredWidth.
	getThumbnails ()
	Get all thumbnail names previously generated for this file STUB Overridden by LocalFile.
	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.
	getTransformScript ()
	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.
	getZoneUrl ( $zone, $suffix=false)
	Get the URL of the zone directory, or a particular file if $suffix is specified.
	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.
	isHashed ()
	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.
	isTrustedFile ()
	Returns true if the file is flagged as trusted.
	isVectorized ()
	Return true if the file is vectorized.
	isVisible ()
	Returns true if file exists in the repository and can be included in a page.
	migrateThumbFile ( $thumbName)
	Hook into transform() to allow migration of thumbnail files STUB Overridden by LocalFile.
	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.
	readOnlyError ()
	redirectedFrom ( $from)
	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, User $user=null)
	Determine if the current user is allowed to view a particular field of this file, if it's marked as deleted.
	wasDeleted ()
	Was this file ever deleted from the wiki?

Static Public Member Functions
static	newFromRow ( $row, $repo)
	Create a ForeignDBFile from a title Do not call this except from inside a repo class.
static	newFromTitle ( $title, $repo, $unused=null)
Static Public Member Functions inherited from LocalFile
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	selectFields ()
	Fields in the image table.
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'.

Additional Inherited Members
Public Attributes inherited from LocalFile
const	ATOMIC_SECTION_LOCK = 'LocalFile::lockingTransaction'
const	CACHE_FIELD_MAX_LEN = 1000
const	LOAD_ALL = 16
const	VERSION = 10
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_LOCKING = 3
	Constants for object loading bitfield flags (higher => higher QoS)
const	READ_NONE = -1
Protected Member Functions inherited from LocalFile
	loadExtraFromDB ()
	Load lazy file metadata from the DB.
	purgeThumbList ( $dir, $files)
	Delete a list of thumbnails visible at urls.
	readOnlyFatalStatus ()
	unprefixRow ( $row, $prefix='img_')
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()
	getIsSafeFile ()
	Accessor for __get()
	getIsSafeFileUncached ()
	Uncached accessor.
	makeTransformTmpFile ( $thumbPath)
	Creates a temp FS file with the same extension and the thumbnail.
	transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags)
	Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
Protected Attributes inherited from LocalFile
int	$bits
	Returned by getimagesize (loadFromXxx)
bool	$dataLoaded
	Whether or not core data has been loaded from the database (loadFromXxx)
int	$deleted
	Bitfield akin to rev_deleted.
bool	$extraDataLoaded
	Whether or not lazy-loaded data has been loaded from the database.
bool	$fileExists
	Does the file exist on disk? (loadFromXxx)
int	$height
	Image height.
string	$media_type
	MEDIATYPE_xxx (bitmap, drawing, audio...)
string	$metadata
	Handler-specific metadata.
string	$mime
	MIME type, determined by MimeMagic::guessMimeType.
string	$repoClass = 'LocalRepo'
string	$sha1
	SHA-1 base 36 content hash.
int	$size
	Size in bytes (loadFromXxx)
int	$width
	Image width.
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.
string	$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'
	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.

Detailed Description

Foreign file with an accessible MediaWiki database.

Definition at line 29 of file ForeignDBFile.php.

Member Function Documentation

delete()

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

Parameters

string	$reason
bool	$suppress
User | null	$user

Returns

Status

Exceptions

MWException

Reimplemented from LocalFile.

Definition at line 101 of file ForeignDBFile.php.

References File\readOnlyError().

getDescriptionShortUrl()

ForeignDBFile::getDescriptionShortUrl

(

)

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

Returns

string

Exceptions

DBUnexpectedError

Since

1.27

Reimplemented from LocalFile.

Definition at line 181 of file ForeignDBFile.php.

References $dbr, File\$url, NS_FILE, and title.

getDescriptionText()

ForeignDBFile::getDescriptionText

(

$lang = false

)

Parameters

bool | Language

$lang

Optional language to fetch description in.

Returns

string

Reimplemented from LocalFile.

Definition at line 126 of file ForeignDBFile.php.

References $cache, $lang, $res, $wgLang, array(), File\getName(), global, NS_FILE, title, use, and wfDebug().

getDescriptionUrl()

ForeignDBFile::getDescriptionUrl

(

)

Returns

string

Reimplemented from LocalFile.

Definition at line 117 of file ForeignDBFile.php.

References File\getDescriptionUrl().

move()

ForeignDBFile::move

(

$target

)

Parameters

Title

$target

Returns

Status

Exceptions

MWException

Reimplemented from LocalFile.

Definition at line 110 of file ForeignDBFile.php.

References File\readOnlyError().

newFromRow()

static ForeignDBFile::newFromRow (   $row,   $repo  )

static

Create a ForeignDBFile from a title Do not call this except from inside a repo class.

Parameters

stdClass	$row
FileRepo	$repo

Returns

ForeignDBFile

Reimplemented from LocalFile.

Definition at line 48 of file ForeignDBFile.php.

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

newFromTitle()

static ForeignDBFile::newFromTitle (   $title,   $repo,   $unused = null  )

static

Parameters

Title	$title
FileRepo	$repo
null	$unused

Returns

ForeignDBFile

Reimplemented from LocalFile.

Definition at line 36 of file ForeignDBFile.php.

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

publish()

ForeignDBFile::publish	(		$srcPath,
			$flags = 0,
		array	$options = []
	)

Parameters

string	$srcPath
int	$flags
array	$options

Returns

Status

Exceptions

MWException

Reimplemented from LocalFile.

Definition at line 63 of file ForeignDBFile.php.

References File\readOnlyError().

recordUpload()

ForeignDBFile::recordUpload	(		$oldver,
			$desc,
			$license = '',
			$copyStatus = '',
			$source = '',
			$watch = false,
			$timestamp = false,
		User	$user = null
	)

Parameters

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

Returns

bool

Exceptions

MWException

Reimplemented from LocalFile.

Definition at line 79 of file ForeignDBFile.php.

References File\readOnlyError().

restore()

ForeignDBFile::restore	(		$versions = [],
			$unsuppress = false
	)

Parameters

array	$versions
bool	$unsuppress

Returns

Status

Exceptions

MWException

Reimplemented from LocalFile.

Definition at line 90 of file ForeignDBFile.php.

References File\readOnlyError().

---

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

• includes/filerepo/file/ForeignDBFile.php