MediaWiki  master
ForeignAPIFile Class Reference

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

Inheritance diagram for ForeignAPIFile:
Collaboration diagram for ForeignAPIFile:

Public Member Functions

 __construct ( $title, $repo, $info, $exists=false)
 
 exists ()
 
 getDescription ( $audience=self::FOR_PUBLIC, User $user=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. More...
 
 getDescriptionUrl ()
 
 getExtendedMetadata ()
 
 getHeight ( $page=1)
 
 getMediaType ()
 
 getMetadata ()
 
 getMimeType ()
 
 getPath ()
 
 getRepo ()
 
 getSha1 ()
 
 getSize ()
 
 getThumbPath ( $suffix='')
 Only useful if we're locally caching thumbs anyway... More...
 
 getTimestamp ()
 
 getUrl ()
 
 getUser ( $type='text')
 
 getWidth ( $page=1)
 
 isTransformedLocally ()
 The thumbnail is created on the foreign server and fetched over internet. More...
 
 purgeCache ( $options=[])
 Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile Stable to override. More...
 
 purgeThumbnails ( $options=[])
 
 transform ( $params, $flags=0)
 
- Public Member Functions inherited from File
 __construct ( $title, $repo)
 Call this constructor from child classes. More...
 
 __get ( $name)
 
 allowInlineDisplay ()
 Alias for canRender() More...
 
 canAnimateThumbIfAppropriate ()
 Will the thumbnail be animated if one would expect it to be. More...
 
 canRender ()
 Checks if the output of transform() for this file is likely to be valid. More...
 
 convertMetadataVersion ( $metadata, $version)
 get versioned metadata More...
 
 createThumb ( $width, $height=-1)
 Create a thumbnail of the image having the specified width/height. More...
 
 delete ( $reason, $suppress=false, $user=null)
 Delete all versions of the file. More...
 
 deleteFile ( $reason, User $user, $suppress=false)
 Delete all versions of the file. More...
 
 formatMetadata ( $context=false)
 
 generateAndSaveThumb ( $tmpFile, $transformParams, $flags)
 Generates a thumbnail according to the given parameters and saves it to storage. More...
 
 generateThumbName ( $name, $params)
 Generate a thumbnail file name from a name and specified parameters Stable to override. More...
 
 getArchivePath ( $suffix=false)
 Get the path of the archived file. More...
 
 getArchiveRel ( $suffix=false)
 Get the path of an archived file relative to the public zone root Stable to override. More...
 
 getArchiveThumbPath ( $archiveName, $suffix=false)
 Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified. More...
 
 getArchiveThumbUrl ( $archiveName, $suffix=false)
 Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified Stable to override. More...
 
 getArchiveUrl ( $suffix=false)
 Get the URL of the archive directory, or a particular file if $suffix is specified Stable to override. More...
 
 getArchiveVirtualUrl ( $suffix=false)
 Get the public zone virtual URL for an archived version source file Stable to override. More...
 
 getAvailableLanguages ()
 Gives a (possibly empty) list of languages to render the file in. More...
 
 getBitDepth ()
 Return the bit depth of the file Overridden by LocalFile STUB Stable to override. More...
 
 getCanonicalUrl ()
 Stable to override. More...
 
 getCommonMetaArray ()
 Like getMetadata but returns a handler independent array of common values. More...
 
 getContentHeaders ()
 
 getDefaultRenderLanguage ()
 In files that support multiple language, what is the default language to use if none specified. More...
 
 getDescriptionText (Language $lang=null)
 Get the HTML text of the description page, if available Stable to override. More...
 
 getDescriptionTouched ()
 Returns the timestamp (in TS_MW format) of the last change of the description page. More...
 
 getDimensionsString ()
 
 getDisplayWidthHeight ( $maxWidth, $maxHeight, $page=1)
 Get the width and height to display image at. More...
 
 getExtension ()
 Get the file extension, e.g. More...
 
 getFullUrl ()
 Return a fully-qualified URL to the file. More...
 
 getHandler ()
 Get a MediaHandler instance for this file. More...
 
 getHashPath ()
 Get the filename hash component of the directory including trailing slash, e.g. More...
 
 getHistory ( $limit=null, $start=null, $end=null, $inc=true)
 Return a fragment of the history of file. More...
 
 getLastError ()
 Get last thumbnailing error. More...
 
 getLength ()
 Get the duration of a media file in seconds. More...
 
 getLocalRefPath ()
 Get an FS copy or original of this file and return the path. More...
 
 getLongDesc ()
 
 getMatchedLanguage ( $userPreferredLanguage)
 Get the language code from the available languages for this file that matches the language requested by the user. More...
 
 getName ()
 Return the name of this file. More...
 
 getOriginalTitle ()
 Return the title used to find this file. More...
 
 getRedirected ()
 
 getRel ()
 Get the path of the file relative to the public zone root. More...
 
 getRepoName ()
 Returns the name of the repository. More...
 
 getShortDesc ()
 
 getStorageKey ()
 Get the deletion archive key, "<sha1>.<ext>". More...
 
 getThumbDisposition ( $thumbName, $dispositionType='inline')
 
 getThumbnailBucket ( $desiredWidth, $page=1)
 Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistance larger than $desiredWidth. More...
 
 getThumbnailSource ( $params)
 Returns the most appropriate source image for the thumbnail, given a target thumbnail size. More...
 
 getThumbRel ( $suffix=false)
 Get the path, relative to the thumbnail zone root, of the thumbnail directory or a particular file if $suffix is specified Stable to override. More...
 
 getThumbUrl ( $suffix=false)
 Get the URL of the thumbnail directory, or a particular file if $suffix is specified Stable to override. More...
 
 getThumbVirtualUrl ( $suffix=false)
 Get the virtual URL for a thumbnail file or directory Stable to override. More...
 
 getTitle ()
 Return the associated title object. More...
 
 getTranscodedPath ( $suffix=false)
 Get the path of the transcoded directory, or a particular file if $suffix is specified. More...
 
 getTranscodedUrl ( $suffix=false)
 Get the URL of the transcoded directory, or a particular file if $suffix is specified. More...
 
 getUnscaledThumb ( $handlerParams=[])
 Get a ThumbnailImage which is the same size as the source. More...
 
 getUrlRel ()
 Get urlencoded path of the file relative to the public zone root. More...
 
 getViewURL ()
 
 getVirtualUrl ( $suffix=false)
 Get the public zone virtual URL for a current version source file Stable to override. More...
 
 getVisibility ()
 Return the deletion bitfield STUB Stable to override. More...
 
 iconThumb ()
 Get a ThumbnailImage representing a file type icon. More...
 
 isCacheable ()
 Check if this file object is small and can be cached Stable to override. More...
 
 isDeleted ( $field)
 Is this file a "deleted" file in a private archive? STUB. More...
 
 isExpensiveToThumbnail ()
 True if creating thumbnails from the file is large or otherwise resource-intensive. More...
 
 isLocal ()
 Returns true if the file comes from the local file repository. More...
 
 isMissing ()
 Stable to override. More...
 
 isMultipage ()
 Returns 'true' if this file is a type which supports multiple pages, e.g. More...
 
 isOld ()
 Returns true if the image is an old version STUB. More...
 
 isSafeFile ()
 Determines if this media file is in a format that is unlikely to contain viruses or malicious content. More...
 
 isVectorized ()
 Return true if the file is vectorized. More...
 
 isVisible ()
 Returns true if file exists in the repository and can be included in a page. More...
 
 load ( $flags=0)
 Load any lazy-loaded file object fields from source. More...
 
 move ( $target)
 Move file to the new title. More...
 
 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. More...
 
 nextHistoryLine ()
 Return the history of this file, line by line. More...
 
 pageCount ()
 Returns the number of pages of a multipage document, or false for documents which aren't multipage documents. More...
 
 publish ( $src, $flags=0, array $options=[])
 Move or copy a file to its public location. More...
 
 purgeDescription ()
 Purge the file description page, but don't go after pages using the file. More...
 
 purgeEverything ()
 Purge metadata and all affected pages when the file is created, deleted, or majorly updated. More...
 
 recordUpload ( $oldver, $desc, $license='', $copyStatus='', $source='', $watch=false, $timestamp=false, User $user=null)
 Record a file upload in the upload log and the image table Stable to override STUB Overridden by LocalFile. More...
 
 redirectedFrom ( $from)
 
 resetHistory ()
 Reset the history pointer to the first element of the history. More...
 
 restore ( $versions=[], $unsuppress=false)
 Restore all or specified deleted revisions to the given file. More...
 
 thumbName ( $params, $flags=0)
 Return the file name of a thumbnail with the specified parameters. More...
 
 upgradeRow ()
 Upgrade the database row if there is one Called by ImagePage STUB. More...
 
 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. More...
 
 wasDeleted ()
 Was this file ever deleted from the wiki? More...
 

Static Public Member Functions

static getProps ()
 Get the property string for iiprop and aiprop. More...
 
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. More...
 
static compare (File $a, File $b)
 Callback for usort() to do file sorts by name. More...
 
static normalizeExtension ( $extension)
 Normalize a file extension to the common form, making it lowercase and checking some synonyms, and ensure it's clean. More...
 
static normalizeTitle ( $title, $exception=false)
 Given a string or Title object return either a valid Title object with namespace NS_FILE or null. More...
 
static scaleHeight ( $srcWidth, $srcHeight, $dstWidth)
 Calculate the height of a thumbnail using the source and destination width. More...
 
static splitMime ( $mime)
 Split an internet media type into its two components; if not a two-part name, set the minor type to 'unknown'. More...
 

Protected Member Functions

 getThumbnails ()
 
- Protected Member Functions inherited from File
 assertRepoDefined ()
 Assert that $this->repo is set to a valid FileRepo instance. More...
 
 assertTitleDefined ()
 Assert that $this->title is set to a Title. More...
 
 generateBucketsIfNeeded ( $params, $flags=0)
 Generates chained bucketed thumbnails if needed. More...
 
 getBucketThumbName ( $bucket)
 Returns the name of the thumb for a given bucket. More...
 
 getBucketThumbPath ( $bucket)
 Returns the repo path of the thumb for a given bucket. More...
 
 getCanRender ()
 Accessor for __get() More...
 
 getImageSize ( $filePath)
 Get an image size array like that returned by getImageSize(), or false if it can't be determined. More...
 
 getIsSafeFile ()
 Accessor for __get() More...
 
 getIsSafeFileUncached ()
 Uncached accessor. More...
 
 getRedirectedTitle ()
 
 isHashed ()
 
 isTrustedFile ()
 Returns true if the file is flagged as trusted. More...
 
 makeTransformTmpFile ( $thumbPath)
 Creates a temp FS file with the same extension and the thumbnail. More...
 
 migrateThumbFile ( $thumbName)
 Hook into transform() to allow migration of thumbnail files STUB Stable to override. More...
 
 readOnlyError ()
 
 transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags)
 Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors) More...
 

Protected Attributes

 $repoClass = ForeignAPIRepo::class
 
- Protected Attributes inherited from File
bool $canRender
 Whether the output of transform() for this file is likely to be valid. More...
 
string $extension
 File extension. More...
 
FSFile bool $fsFile
 False if undefined. More...
 
MediaHandler $handler
 
string $hashPath
 Relative path including trailing slash. More...
 
bool $isSafeFile
 Whether this media file is in a format that is unlikely to contain viruses or malicious content. More...
 
string $lastError
 Text of last error. More...
 
string $name
 The name of a file from its title object. More...
 
int false $pageCount
 Number of pages of a multipage document, or false for documents which aren't multipage documents. More...
 
string $path
 The storage path corresponding to one of the zones. More...
 
string $redirected
 Main part of the title, with underscores (Title::getDBkey) More...
 
Title $redirectedTitle
 
Title $redirectTitle
 
string $repoClass = FileRepo::class
 Required Repository class type. More...
 
Title string bool $title
 
array $tmpBucketedThumbCache = []
 Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width. More...
 
string $transformScript
 URL of transformscript (for example thumb.php) More...
 
string $url
 The URL corresponding to one of the four basic zones. More...
 

Private Member Functions

 purgeDescriptionPage ()
 

Private Attributes

bool $mExists
 
array $mInfo = []
 

Additional Inherited Members

- Public Attributes inherited from File
FileRepo LocalRepo ForeignAPIRepo bool $repo
 Some member variables can be lazy-initialised using __get(). More...
 
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. More...
 
const RENDER_NOW = 1
 Force rendering in the current process. More...
 
const THUMB_FULL_NAME = 1
 
- Public Attributes inherited from IDBAccessObject
const READ_NONE = -1
 Constants for object loading bitfield flags (higher => higher QoS) More...
 

Detailed Description

Foreign file accessible through api.php requests.

Very hacky and inefficient, do not use :D

Definition at line 32 of file ForeignAPIFile.php.

Constructor & Destructor Documentation

◆ __construct()

ForeignAPIFile::__construct (   $title,
  $repo,
  $info,
  $exists = false 
)
Parameters
Title | string | bool$title
ForeignApiRepo$repo
array$info
bool$exists

Definition at line 46 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 112 of file ForeignAPIFile.php.

References $mExists.

◆ getDescription()

ForeignAPIFile::getDescription (   $audience = self::FOR_PUBLIC,
User  $user = null 
)
Parameters
int$audience
User | null$user
Returns
null|string

Reimplemented from File.

Definition at line 265 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 236 of file ForeignAPIFile.php.

References File\$url.

◆ getDescriptionUrl()

ForeignAPIFile::getDescriptionUrl ( )
Returns
bool|string

Reimplemented from File.

Definition at line 316 of file ForeignAPIFile.php.

◆ getExtendedMetadata()

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

Definition at line 194 of file ForeignAPIFile.php.

◆ getHeight()

ForeignAPIFile::getHeight (   $page = 1)
Parameters
int$page
Returns
int

Reimplemented from File.

Definition at line 175 of file ForeignAPIFile.php.

◆ getMediaType()

ForeignAPIFile::getMediaType ( )
Returns
int|string

Reimplemented from File.

Definition at line 304 of file ForeignAPIFile.php.

References MediaWiki\MediaWikiServices\getInstance(), and getMimeType().

◆ getMetadata()

ForeignAPIFile::getMetadata ( )
Returns
bool|null|string

Reimplemented from File.

Definition at line 182 of file ForeignAPIFile.php.

References serialize().

◆ getMimeType()

ForeignAPIFile::getMimeType ( )
Returns
string

Reimplemented from File.

Definition at line 292 of file ForeignAPIFile.php.

References File\getExtension(), and MediaWiki\MediaWikiServices\getInstance().

Referenced by getMediaType().

◆ getPath()

ForeignAPIFile::getPath ( )
Returns
bool

Reimplemented from File.

Definition at line 119 of file ForeignAPIFile.php.

◆ getProps()

static ForeignAPIFile::getProps ( )
static

Get the property string for iiprop and aiprop.

Returns
string

Definition at line 96 of file ForeignAPIFile.php.

Referenced by ForeignAPIRepo\findBySha1().

◆ getRepo()

ForeignAPIFile::getRepo ( )
Returns
ForeignAPIRepo|bool

Reimplemented from File.

Definition at line 103 of file ForeignAPIFile.php.

References File\$repo.

◆ getSha1()

ForeignAPIFile::getSha1 ( )
Returns
null|string

Reimplemented from File.

Definition at line 272 of file ForeignAPIFile.php.

◆ getSize()

ForeignAPIFile::getSize ( )
Returns
bool|int|null

Reimplemented from File.

Definition at line 218 of file ForeignAPIFile.php.

◆ getThumbnails()

ForeignAPIFile::getThumbnails ( )
protected
Returns
string[]

Reimplemented from File.

Definition at line 340 of file ForeignAPIFile.php.

References $file, File\getName(), and getThumbPath().

Referenced by purgeThumbnails().

◆ 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 325 of file ForeignAPIFile.php.

References File\$path, and File\getHashPath().

Referenced by getThumbnails(), and purgeThumbnails().

◆ getTimestamp()

ForeignAPIFile::getTimestamp ( )
Returns
bool|string

Reimplemented from File.

Definition at line 281 of file ForeignAPIFile.php.

References wfTimestamp().

◆ getUrl()

ForeignAPIFile::getUrl ( )
Returns
null|string

Reimplemented from File.

Definition at line 225 of file ForeignAPIFile.php.

◆ getUser()

ForeignAPIFile::getUser (   $type = 'text')
Parameters
string$type
Returns
int|null|string

Reimplemented from File.

Definition at line 252 of file ForeignAPIFile.php.

References $type.

◆ getWidth()

ForeignAPIFile::getWidth (   $page = 1)
Parameters
int$page
Returns
int

Reimplemented from File.

Definition at line 167 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 399 of file ForeignAPIFile.php.

◆ newFromTitle()

static ForeignAPIFile::newFromTitle ( Title  $title,
  $repo 
)
static
Parameters
Title$title
ForeignApiRepo$repo
Returns
ForeignAPIFile|null

Definition at line 60 of file ForeignAPIFile.php.

References File\$repo, File\$title, Title\getDBkey(), MediaHandler\getMetadataVersion(), Title\newFromText(), and true.

◆ parseMetadata()

static ForeignAPIFile::parseMetadata (   $metadata)
static
Parameters
mixed$metadata
Returns
mixed

Definition at line 202 of file ForeignAPIFile.php.

◆ purgeCache()

ForeignAPIFile::purgeCache (   $options = [])

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

Parameters
array$optionsOptions, which include: 'forThumbRefresh' : The purging is only to refresh thumbnails

Reimplemented from File.

Definition at line 354 of file ForeignAPIFile.php.

References purgeDescriptionPage(), and purgeThumbnails().

◆ purgeDescriptionPage()

ForeignAPIFile::purgeDescriptionPage ( )
private

Definition at line 359 of file ForeignAPIFile.php.

References File\$url, and File\getName().

Referenced by purgeCache().

◆ purgeThumbnails()

ForeignAPIFile::purgeThumbnails (   $options = [])
Parameters
array$options

Definition at line 371 of file ForeignAPIFile.php.

References $file, File\$handler, MediaHandler\filterThumbnailPurgeList(), File\getHandler(), File\getName(), getThumbnails(), and getThumbPath().

Referenced by purgeCache().

◆ transform()

ForeignAPIFile::transform (   $params,
  $flags = 0 
)
Parameters
array$params
int$flags
Returns
bool|MediaTransformOutput

Reimplemented from File.

Definition at line 128 of file ForeignAPIFile.php.

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

Member Data Documentation

◆ $mExists

bool ForeignAPIFile::$mExists
private

Definition at line 34 of file ForeignAPIFile.php.

Referenced by exists().

◆ $mInfo

array ForeignAPIFile::$mInfo = []
private

Definition at line 36 of file ForeignAPIFile.php.

◆ $repoClass

ForeignAPIFile::$repoClass = ForeignAPIRepo::class
protected

Definition at line 38 of file ForeignAPIFile.php.


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