FakeDimensionFile Class Reference
Inheritance diagram for FakeDimensionFile:
Collaboration diagram for FakeDimensionFile:
Public Member Functions | |
| __construct ( $dimensions, $mime='unknown/unknown') | |
| Call this constructor from child classes. | |
| getHeight ( $page=1) | |
| Return the height of the image. | |
| getMimeType () | |
| Returns the MIME type of the file. | |
| getPath () | |
| Return the storage path to the file. | |
| getWidth ( $page=1) | |
| Return the width of the image. | |
| 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. | |
 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. | |
| delete ( $reason, $suppress=false, $user=null) | |
| 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. | |
| 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. | |
| 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. | |
| getDescription ( $audience=self::FOR_PUBLIC, User $user=null) | |
| Get description of file revision STUB. | |
| getDescriptionShortUrl () | |
| Get short description URL for a files based on the page ID. | |
| getDescriptionText ( $lang=false) | |
| 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 () | |
| 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. | |
| getHistory ( $limit=null, $start=null, $end=null, $inc=true) | |
| Return a fragment of the history of file. | |
| 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 () | |
| 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. | |
| getMetadata () | |
| Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB. | |
| getName () | |
| Return the name of this file. | |
| getOriginalTitle () | |
| Return the title used to find this 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. | |
| getSha1 () | |
| Get the SHA-1 base 36 hash of the file. | |
| getShortDesc () | |
| getSize () | |
| Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| isHashed () | |
| 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. | |
| 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. | |
| load ( $flags=0) | |
| Load any lazy-loaded file object fields from source. | |
| migrateThumbFile ( $thumbName) | |
| Hook into transform() to allow migration of thumbnail files STUB Overridden by LocalFile. | |
| move ( $target) | |
| Move file to the new title. | |
| 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. | |
| readOnlyError () | |
| 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 STUB Overridden by LocalFile. | |
| 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. | |
| 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, 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? | |
Public Attributes | |
| $dimensions | |
| $mime | |
| $mustRender = false | |
| 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 |
Additional Inherited Members | |
| 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'. | |
| 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 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 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. | |
Detailed Description
Definition at line 3 of file FakeDimensionFile.php.
Constructor & Destructor Documentation
◆ __construct()
| FakeDimensionFile::__construct | ( | $title, | |
| $repo = 'unknown/unknown' ) |
Call this constructor from child classes.
Both $title and $repo are optional, though some functions may return false or throw exceptions if they are not set. Most subclasses will want to call assertRepoDefined() here.
Reimplemented from File.
Definition at line 8 of file FakeDimensionFile.php.
References $dimensions, $mime, and NS_FILE.
Member Function Documentation
◆ getHeight()
| FakeDimensionFile::getHeight | ( | $page = 1 | ) |
Return the height of the image.
Returns false if the height is unknown or undefined
STUB Overridden by LocalFile, UnregisteredLocalFile
- Parameters
-
int $page
- Returns
- bool|int False on failure
Reimplemented from File.
Definition at line 20 of file FakeDimensionFile.php.
◆ getMimeType()
| FakeDimensionFile::getMimeType | ( | ) |
Returns the MIME type of the file.
Overridden by LocalFile, UnregisteredLocalFile STUB
- Returns
- string
Reimplemented from File.
Definition at line 32 of file FakeDimensionFile.php.
References $mime.
◆ getPath()
| FakeDimensionFile::getPath | ( | ) |
Return the storage path to the file.
Note that this does not mean that a file actually exists under that location.
This path depends on whether directory hashing is active or not, i.e. whether the files are all found in the same directory, or in hashed paths like /images/3/3c.
Most callers don't check the return value, but ForeignAPIFile::getPath returns false.
- Returns
- string|bool ForeignAPIFile::getPath can return false
Reimplemented from File.
Definition at line 28 of file FakeDimensionFile.php.
◆ getWidth()
| FakeDimensionFile::getWidth | ( | $page = 1 | ) |
Return the width of the image.
Returns false if the width is unknown or undefined.
STUB Overridden by LocalFile, UnregisteredLocalFile
- Parameters
-
int $page
- Returns
- int|bool
Reimplemented from File.
Definition at line 16 of file FakeDimensionFile.php.
◆ mustRender()
| FakeDimensionFile::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.
This returns true for everything but the bitmap types supported by all browsers, i.e. JPEG; GIF and PNG. It will also return true for any non-image formats.
- Returns
- bool
Reimplemented from File.
Definition at line 24 of file FakeDimensionFile.php.
References $mustRender.
Member Data Documentation
◆ $dimensions
| FakeDimensionFile::$dimensions |
Definition at line 6 of file FakeDimensionFile.php.
Referenced by __construct().
◆ $mime
| FakeDimensionFile::$mime |
Definition at line 5 of file FakeDimensionFile.php.
Referenced by __construct(), and getMimeType().
◆ $mustRender
| FakeDimensionFile::$mustRender = false |
Definition at line 4 of file FakeDimensionFile.php.
Referenced by mustRender().
The documentation for this class was generated from the following file:
- tests/phpunit/includes/media/FakeDimensionFile.php
