FakeDimensionFile Class Reference
Media. More...
Inheritance diagram for FakeDimensionFile:
Collaboration diagram for FakeDimensionFile:
Public Member Functions | |
| __construct ($dimensions) | |
| getHeight ($page=1) | |
| getPath () | |
| getWidth ($page=1) | |
| mustRender () | |
 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... | |
| exists () | |
| Returns true if file exists in the repository. 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. 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. More... | |
| getArchiveThumbPath ($archiveName, $suffix=false) | |
| Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified. More... | |
| 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. More... | |
| getArchiveThumbUrl ($archiveName, $suffix=false) | |
| Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified. More... | |
| getArchiveUrl ($suffix=false) | |
| Get the URL of the archive directory, or a particular file if $suffix is specified. More... | |
| getArchiveVirtualUrl ($suffix=false) | |
| Get the public zone virtual URL for an archived version source file. 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. More... | |
| getCanonicalUrl () | |
| getCommonMetaArray () | |
| Like getMetadata but returns a handler independent array of common values. More... | |
| getDefaultRenderLanguage () | |
| In files that support multiple language, what is the default language to use if none specified. More... | |
| getDescription ($audience=self::FOR_PUBLIC, User $user=null) | |
| Get description of file revision STUB. More... | |
| getDescriptionShortUrl () | |
| getDescriptionText ($lang=false) | |
| Get the HTML text of the description page, if available. More... | |
| getDescriptionTouched () | |
| Returns the timestamp (in TS_MW format) of the last change of the description page. More... | |
| getDescriptionUrl () | |
| Get the URL of the image description page. More... | |
| getDimensionsString () | |
| 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... | |
| getHeight ($page=1) | |
| Return the height of the image. More... | |
| getHistory ($limit=null, $start=null, $end=null, $inc=true) | |
| Return a fragment of the history of file. More... | |
| getImageSize ($filePath) | |
| Get an image size array like that returned by getImageSize(), or false if it can't be determined. 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 () | |
| getMediaType () | |
| Return the type of the media in the file. More... | |
| getMetadata () | |
| Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB. More... | |
| getMimeType () | |
| Returns the MIME type of the file. More... | |
| getName () | |
| Return the name of this file. More... | |
| getOriginalTitle () | |
| Return the title used to find this file. More... | |
| getPath () | |
| Return the storage path to the file. More... | |
| getRedirected () | |
| getRedirectedTitle () | |
| getRel () | |
| Get the path of the file relative to the public zone root. More... | |
| getRepo () | |
| Returns the repository. More... | |
| getRepoName () | |
| Returns the name of the repository. More... | |
| getSha1 () | |
| Get the SHA-1 base 36 hash of the file. More... | |
| getShortDesc () | |
| getSize () | |
| Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB. More... | |
| getStorageKey () | |
| Get the deletion archive key, "<sha1>.<ext>". More... | |
| getStreamHeaders () | |
| getThumbDisposition ($thumbName, $dispositionType= 'inline') | |
| getThumbnailBucket ($desiredWidth, $page=1) | |
| Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistance larger than $desiredWidth. More... | |
| getThumbnails () | |
| Get all thumbnail names previously generated for this file STUB Overridden by LocalFile. More... | |
| getThumbnailSource ($params) | |
| Returns the most appropriate source image for the thumbnail, given a target thumbnail size. More... | |
| getThumbPath ($suffix=false) | |
| Get the path of the thumbnail directory, or a particular file if $suffix is specified. 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. More... | |
| getThumbUrl ($suffix=false) | |
| Get the URL of the thumbnail directory, or a particular file if $suffix is specified. More... | |
| getThumbVirtualUrl ($suffix=false) | |
| Get the virtual URL for a thumbnail file or directory. More... | |
| getTimestamp () | |
| Get the 14-character timestamp of the file upload. 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... | |
| getTransformScript () | |
| getUnscaledThumb ($handlerParams=[]) | |
| Get a ThumbnailImage which is the same size as the source. More... | |
| getUrl () | |
| Return the URL of the file. More... | |
| getUrlRel () | |
| Get urlencoded path of the file relative to the public zone root. More... | |
| getUser ($type= 'text') | |
| Returns ID or name of user who uploaded the file STUB. More... | |
| getViewURL () | |
| getVirtualUrl ($suffix=false) | |
| Get the public zone virtual URL for a current version source file. More... | |
| getVisibility () | |
| Return the deletion bitfield STUB. More... | |
| getWidth ($page=1) | |
| Return the width of the image. More... | |
| getZoneUrl ($zone, $suffix=false) | |
| Get the URL of the zone directory, or a particular file if $suffix is specified. More... | |
| iconThumb () | |
| Get a ThumbnailImage representing a file type icon. More... | |
| isCacheable () | |
| Check if this file object is small and can be cached. 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... | |
| isHashed () | |
| isLocal () | |
| Returns true if the file comes from the local file repository. More... | |
| isMissing () | |
| 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... | |
| isTransformedLocally () | |
| Whether the thumbnails created on the same server as this code is running. More... | |
| isTrustedFile () | |
| Returns true if the file is flagged as trusted. 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... | |
| migrateThumbFile ($thumbName) | |
| Hook into transform() to allow migration of thumbnail files STUB Overridden by LocalFile. 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... | |
| purgeCache ($options=[]) | |
| Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile. 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... | |
| 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. 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... | |
| transform ($params, $flags=0) | |
| Transform a media file. 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... | |
Public Attributes | |
| $mustRender = false | |
| 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_EXCLUSIVE = 7 |
| const | READ_LATEST = 1 |
| const | READ_LOCKING = 3 |
| const | READ_NONE = -1 |
| const | READ_NORMAL = 0 |
Additional Inherited Members | |
| 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 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... | |
| getIsSafeFile () | |
| Accessor for __get() More... | |
| getIsSafeFileUncached () | |
| Uncached accessor. More... | |
| makeTransformTmpFile ($thumbPath) | |
| Creates a temp FS file with the same extension and the thumbnail. More... | |
| transformErrorOutput ($thumbPath, $thumbUrl, $params, $flags) | |
| Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors) More... | |
| 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... | |
| string | $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' |
| 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... | |
Detailed Description
Media.
Definition at line 6 of file FakeDimensionFile.php.
Constructor & Destructor Documentation
| FakeDimensionFile::__construct | ( | $dimensions | ) |
Definition at line 9 of file FakeDimensionFile.php.
References Title\makeTitle(), and NS_FILE.
Member Function Documentation
| FakeDimensionFile::getHeight | ( | $page = 1 | ) |
Definition at line 20 of file FakeDimensionFile.php.
| FakeDimensionFile::getPath | ( | ) |
Definition at line 28 of file FakeDimensionFile.php.
| FakeDimensionFile::getWidth | ( | $page = 1 | ) |
Definition at line 16 of file FakeDimensionFile.php.
| FakeDimensionFile::mustRender | ( | ) |
Definition at line 24 of file FakeDimensionFile.php.
References $mustRender.
Member Data Documentation
| FakeDimensionFile::$mustRender = false |
Definition at line 7 of file FakeDimensionFile.php.
Referenced by mustRender().
The documentation for this class was generated from the following file:
- tests/phpunit/includes/media/FakeDimensionFile.php
