Foreign file accessible through api.php requests. More...

Inherits File.

Collaboration diagram for ForeignAPIFile:

[legend]

Public Member Functions
	__construct ( $title, $repo, $info, $exists=false)

	exists ()

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

	getDescriptionShortUrl ()
	Get short description URL for a file based on the foreign API response, or if unavailable, the short URL is constructed from the foreign page ID.

	getDescriptionUrl ()

	getExtendedMetadata ()

	getHeight ( $page=1)

	getMediaType ()

	getMetadata ()

	getMetadataArray ()

	getMimeType ()

	getPath ()

	getRepo ()

	getSha1 ()

	getSize ()

	getThumbPath ( $suffix='')
	Only useful if we're locally caching thumbs anyway...

	getTimestamp ()

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

	getUrl ()

	getWidth ( $page=1)

	isTransformedLocally ()
	The thumbnail is created on the foreign server and fetched over internet.

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

	purgeThumbnails ( $options=[])

	transform ( $params, $flags=0)

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

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

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

	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.

	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.

	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.

	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.

	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.

	getRedirected ()

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

	getRepoName ()
	Returns the name of the repository.

	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.

	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.

	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.

	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.

	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.

	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.

	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	getProps ()
	Get the property string for iiprop and aiprop.

static	newFromTitle (Title $title, $repo)

static	parseMetadata ( $metadata)

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 (?string $mime)
	Split an internet media type into its two components; if not a two-part name, set the minor type to 'unknown'.

Protected Member Functions
	getThumbnails ()

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.

	getRedirectedTitle ()

	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
	$repoClass = ForeignAPIRepo::class

Protected Attributes inherited from 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.

Additional Inherited Members
Public Attributes inherited from 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

Detailed Description

Foreign file accessible through api.php requests.

Definition at line 32 of file ForeignAPIFile.php.

Constructor & Destructor Documentation

◆ __construct()

ForeignAPIFile::__construct	(	$title,
		$repo,
		$info,
		$exists = false )

Parameters

Title \| string \| false	$title
ForeignApiRepo	$repo
array	$info
bool	$exists

Definition at line 47 of file ForeignAPIFile.php.

References File\$repo, File\$title, and File\assertRepoDefined().

Member Function Documentation

◆ exists()

ForeignAPIFile::exists ( )

Returns: bool

Reimplemented from File.

Definition at line 111 of file ForeignAPIFile.php.

◆ getDescription()

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

Parameters

int	$audience
Authority \| null	$performer

Returns: null|string

Reimplemented from File.

Definition at line 294 of file ForeignAPIFile.php.

◆ getDescriptionShortUrl()

ForeignAPIFile::getDescriptionShortUrl ( )

Get short description URL for a file based on the foreign API response, or if unavailable, the short URL is constructed from the foreign page ID.

Returns: null|string

Since: 1.27

Reimplemented from File.

Definition at line 270 of file ForeignAPIFile.php.

References $url.

◆ getDescriptionUrl()

ForeignAPIFile::getDescriptionUrl ( )

Returns: string|false

Reimplemented from File.

Definition at line 345 of file ForeignAPIFile.php.

◆ getExtendedMetadata()

ForeignAPIFile::getExtendedMetadata ( )

Returns: array|null Extended metadata (see imageinfo API for format) or null on error

Definition at line 211 of file ForeignAPIFile.php.

◆ getHeight()

ForeignAPIFile::getHeight ( $page = 1 )

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 181 of file ForeignAPIFile.php.

◆ getMediaType()

ForeignAPIFile::getMediaType ( )

Returns: int|string

Reimplemented from File.

Definition at line 333 of file ForeignAPIFile.php.

Referenced by transform().

◆ getMetadata()

ForeignAPIFile::getMetadata ( )

Returns: string|false

Reimplemented from File.

Definition at line 188 of file ForeignAPIFile.php.

◆ getMetadataArray()

ForeignAPIFile::getMetadataArray ( )

Returns: array

Reimplemented from File.

Definition at line 199 of file ForeignAPIFile.php.

References parseMetadata().

◆ getMimeType()

ForeignAPIFile::getMimeType ( )

Returns: string

Reimplemented from File.

Definition at line 321 of file ForeignAPIFile.php.

◆ getPath()

ForeignAPIFile::getPath ( )

Returns: bool

Reimplemented from File.

Definition at line 118 of file ForeignAPIFile.php.

◆ getProps()

static ForeignAPIFile::getProps ( )

static

Get the property string for iiprop and aiprop.

Returns: string

Definition at line 95 of file ForeignAPIFile.php.

Referenced by ForeignAPIRepo\findBySha1().

◆ getRepo()

ForeignAPIFile::getRepo ( )

Returns: ForeignAPIRepo|false

Reimplemented from File.

Definition at line 102 of file ForeignAPIFile.php.

References File\$repo.

◆ getSha1()

ForeignAPIFile::getSha1 ( )

Returns: null|string

Reimplemented from File.

Definition at line 301 of file ForeignAPIFile.php.

◆ getSize()

ForeignAPIFile::getSize ( )

Returns: int|null|false

Reimplemented from File.

Definition at line 252 of file ForeignAPIFile.php.

◆ getThumbnails()

ForeignAPIFile::getThumbnails ( )

protected

Returns: string[]

Reimplemented from File.

Definition at line 369 of file ForeignAPIFile.php.

◆ getThumbPath()

ForeignAPIFile::getThumbPath ( $suffix = '' )

Only useful if we're locally caching thumbs anyway...

Parameters

string $suffix

Returns: null|string

Reimplemented from File.

Definition at line 354 of file ForeignAPIFile.php.

References $path.

◆ getTimestamp()

ForeignAPIFile::getTimestamp ( )

Returns: string|false

Reimplemented from File.

Definition at line 310 of file ForeignAPIFile.php.

References wfTimestamp().

◆ getUploader()

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

Definition at line 282 of file ForeignAPIFile.php.

◆ getUrl()

ForeignAPIFile::getUrl ( )

Returns: null|string

Reimplemented from File.

Definition at line 259 of file ForeignAPIFile.php.

◆ getWidth()

ForeignAPIFile::getWidth ( $page = 1 )

Parameters

int $page

Returns: int

Reimplemented from File.

Definition at line 173 of file ForeignAPIFile.php.

◆ isTransformedLocally()

ForeignAPIFile::isTransformedLocally ( )

The thumbnail is created on the foreign server and fetched over internet.

Since: 1.25

Returns: bool

Reimplemented from File.

Definition at line 428 of file ForeignAPIFile.php.

◆ newFromTitle()

static ForeignAPIFile::newFromTitle	(	Title	$title,
			$repo )

static

Parameters

Title	$title
ForeignApiRepo	$repo

Returns: ForeignAPIFile|null

Definition at line 61 of file ForeignAPIFile.php.

References File\$repo, File\$title, and MediaWiki\Title\Title\getDBkey().

◆ parseMetadata()

static ForeignAPIFile::parseMetadata ( $metadata )

static

Parameters

mixed $metadata

Returns: array

Definition at line 219 of file ForeignAPIFile.php.

Referenced by getMetadataArray().

◆ purgeCache()

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

Definition at line 383 of file ForeignAPIFile.php.

◆ purgeThumbnails()

ForeignAPIFile::purgeThumbnails ( $options = [] )

Parameters

array $options

Definition at line 400 of file ForeignAPIFile.php.

◆ transform()

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

Parameters

array	$params
int	$flags

Returns: MediaTransformOutput|false

Reimplemented from File.

Definition at line 127 of file ForeignAPIFile.php.

References $params, $wgLang, File\canRender(), getMediaType(), File\getName(), and MEDIATYPE_AUDIO.

Member Data Documentation

◆ $repoClass

ForeignAPIFile::$repoClass = ForeignAPIRepo::class

protected

Definition at line 39 of file ForeignAPIFile.php.

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

includes/filerepo/file/ForeignAPIFile.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ exists()

◆ getDescription()

◆ getDescriptionShortUrl()

◆ getDescriptionUrl()

◆ getExtendedMetadata()

◆ getHeight()

◆ getMediaType()

◆ getMetadata()

◆ getMetadataArray()

◆ getMimeType()

◆ getPath()

◆ getProps()

◆ getRepo()

◆ getSha1()

◆ getSize()

◆ getThumbnails()

◆ getThumbPath()

◆ getTimestamp()

◆ getUploader()

◆ getUrl()

◆ getWidth()

◆ isTransformedLocally()

◆ newFromTitle()

◆ parseMetadata()

◆ purgeCache()

◆ purgeThumbnails()

◆ transform()

Member Data Documentation

◆ $repoClass