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) | |
| getDescriptionText ( $lang=false) | |
| getDescriptionUrl () | |
| move ( $target) | |
| publish ( $srcPath, $flags=0, array $options=array()) | |
| recordUpload ( $oldver, $desc, $license='', $copyStatus='', $source='', $watch=false, $timestamp=false, User $user=null) | |
| restore ( $versions=array(), $unsuppress=false) | |
 Public Member Functions inherited from LocalFile | |
| __construct ( $title, $repo) | |
| Constructor. More... | |
| __destruct () | |
| Clean up any dangling locks. More... | |
| 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. More... | |
| deleteOld ( $archiveName, $reason, $suppress=false) | |
| Delete an old version of the file. More... | |
| exists () | |
| canRender inherited More... | |
| 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. More... | |
| getDescription ( $audience=self::FOR_PUBLIC, User $user=null) | |
| getHeight ( $page=1) | |
| Return the height of the image. More... | |
| getHistory ( $limit=null, $start=null, $end=null, $inc=true) | |
| purgeDescription inherited More... | |
| getLazyCacheFields ( $prefix='img_') | |
| getMediaType () | |
| Returns the type of the media in the file. More... | |
| getMetadata () | |
| Get handler-specific metadata. More... | |
| getMimeType () | |
| Returns the mime type of the file. More... | |
| getSha1 () | |
| getSize () | |
| Returns the size of the image file, in bytes. More... | |
| getThumbnails ( $archiveName=false) | |
| getHandler inherited More... | |
| getTimestamp () | |
| getUpgraded () | |
| getUser ( $type='text') | |
| Returns ID or name of user who uploaded the file. More... | |
| getWidth ( $page=1) | |
| Return the width of the image. More... | |
| isCacheable () | |
| isMissing () | |
| splitMime inherited More... | |
| load ( $flags=0) | |
| Load file metadata from cache or DB, unless already loaded. More... | |
| loadFromCache () | |
| Try to load file metadata from memcached. More... | |
| loadFromDB () | |
| Load file metadata from the DB. More... | |
| loadFromFile () | |
| Load metadata from the file itself. More... | |
| loadFromRow ( $row, $prefix='img_') | |
| Load file metadata from a DB result row. More... | |
| lock () | |
| Start a transaction and lock the image for update Increments a reference counter if the lock is already held. More... | |
| maybeUpgradeRow () | |
| Upgrade a row if it needs it. More... | |
| migrateThumbFile ( $thumbName) | |
| getTransformScript inherited More... | |
| nextHistoryLine () | |
| Returns the history of this file, line by line. More... | |
| publishTo ( $srcPath, $dstRel, $flags=0, array $options=array()) | |
| Move or copy a file to a specified location. More... | |
| purgeCache ( $options=array()) | |
| Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid. More... | |
| purgeHistory () | |
| Purge the shared history (OldLocalFile) cache. More... | |
| purgeMetadataCache () | |
| Refresh metadata in memcached, but don't touch thumbnails or squid. More... | |
| purgeOldThumbnails ( $archiveName) | |
| Delete cached transformed files for an archived version only. More... | |
| purgeThumbnails ( $options=array()) | |
| Delete cached transformed files for the current version only. More... | |
| recordUpload2 ( $oldver, $comment, $pageText, $props=false, $timestamp=false, $user=null) | |
| Record a file upload in the upload log and the image table. More... | |
| resetHistory () | |
| Reset the history pointer to the first element of the history. More... | |
| saveToCache () | |
| Save the file metadata to memcached. More... | |
| setProps ( $info) | |
| Set properties in this object to be equal to those given in the associative array $info. More... | |
| unlock () | |
| Decrement the lock reference count. More... | |
| unlockAndRollback () | |
| Roll back the DB transaction and mark the image unlocked. More... | |
| upgradeRow () | |
| Fix assorted version-related problems with the image row by reloading it from the file. More... | |
| upload ( $srcPath, $comment, $pageText, $flags=0, $props=false, $timestamp=false, $user=null) | |
| getHashPath inherited More... | |
| Public Member Functions inherited from File | |
| __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... | |
| formatMetadata () | |
| 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... | |
| 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... | |
| 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... | |
| getImageSize ( $fileName) | |
| 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 () | |
| 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... | |
| getShortDesc () | |
| getStorageKey () | |
| Get the deletion archive key, "<sha1>.<ext>". More... | |
| getStreamHeaders () | |
| getThumbDisposition ( $thumbName, $dispositionType='inline') | |
| getThumbnails () | |
| Get all thumbnail names previously generated for this file STUB Overridden by LocalFile. 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... | |
| 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=array()) | |
| 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... | |
| getViewURL () | |
| getVirtualUrl ( $suffix=false) | |
| Get the public zone virtual URL for a current version source file. More... | |
| getVisibility () | |
| Return the deletion bitfield STUB. 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... | |
| isDeleted ( $field) | |
| Is this file a "deleted" file in a private archive? STUB. More... | |
| isHashed () | |
| isLocal () | |
| Returns true if the file comes from the local file repository. 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... | |
| 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... | |
| 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... | |
| pageCount () | |
| Returns the number of pages of a multipage document, or false for documents which aren't multipage documents. 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 () | |
| redirectedFrom ( $from) | |
| 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... | |
| 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 | newFromRow ( $row, $repo) |
| Create a ForeignDBFile from a title Do not call this except from inside a repo class. More... | |
| 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. More... | |
| static | selectFields () |
| Fields in the image table. More... | |
| 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 | getPropsFromPath ( $path, $ext=true) |
| Get an associative array containing information about a file in the local filesystem. More... | |
| static | normalizeExtension ( $ext) |
| Normalize a file extension to the common form, 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 | sha1Base36 ( $path) |
| Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits. 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... | |
Additional Inherited Members | |
| Public Attributes inherited from LocalFile | |
| const | CACHE_FIELD_MAX_LEN = 1000 |
| const | LOAD_ALL = 1 |
| 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 |
| Protected Member Functions inherited from LocalFile | |
| loadExtraFromDB () | |
| Load lazy file metadata from the DB. More... | |
| purgeThumbList ( $dir, $files) | |
| Delete a list of thumbnails visible at urls. More... | |
| readOnlyFatalStatus () | |
| unprefixRow ( $row, $prefix='img_') | |
| 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... | |
| getCanRender () | |
| Accessor for __get() More... | |
| getIsSafeFile () | |
| Accessor for __get() More... | |
| getIsSafeFileUncached () | |
| Uncached accessor. More... | |
| transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags) | |
| Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors) More... | |
| Protected Attributes inherited from LocalFile | |
| int | $bits |
| Returned by getimagesize (loadFromXxx) *. More... | |
| bool | $dataLoaded |
| Whether or not core data has been loaded from the database (loadFromXxx) *. More... | |
| int | $deleted |
| Bitfield akin to rev_deleted *. More... | |
| bool | $extraDataLoaded |
| Whether or not lazy-loaded data has been loaded from the database *. More... | |
| bool | $fileExists |
| Does the file exist on disk? (loadFromXxx) *. More... | |
| int | $height |
| image height * More... | |
| string | $media_type |
| MEDIATYPE_xxx (bitmap, drawing, audio...) *. More... | |
| string | $metadata |
| Handler-specific metadata *. More... | |
| string | $mime |
| MIME type, determined by MimeMagic::guessMimeType *. More... | |
| string | $repoClass = 'LocalRepo' |
| string | $sha1 |
| SHA-1 base 36 content hash *. More... | |
| int | $size |
| Size in bytes (loadFromXxx) *. More... | |
| int | $width |
| image width * More... | |
| Protected Attributes inherited from File | |
| bool | $canRender |
| Wether 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 |
| Wether 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 |
| 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
Foreign file with an accessible MediaWiki database.
Definition at line 29 of file ForeignDBFile.php.
Member Function Documentation
◆ delete()
| ForeignDBFile::delete | ( | $reason, | |
$suppress = false |
|||
| ) |
- Parameters
-
string $reason bool $suppress
- Returns
- FileRepoStatus
- Exceptions
-
MWException
Reimplemented from LocalFile.
Definition at line 100 of file ForeignDBFile.php.
References File\readOnlyError().
◆ getDescriptionText()
| ForeignDBFile::getDescriptionText | ( | $lang = false | ) |
- Parameters
-
bool | Language $lang Optional language to fetch description in.
- Returns
- string
Reimplemented from LocalFile.
Definition at line 125 of file ForeignDBFile.php.
References File\getDescriptionText().
◆ getDescriptionUrl()
| ForeignDBFile::getDescriptionUrl | ( | ) |
- Returns
- string
Reimplemented from LocalFile.
Definition at line 116 of file ForeignDBFile.php.
References File\getDescriptionUrl().
◆ move()
| ForeignDBFile::move | ( | $target | ) |
- Parameters
-
Title $target
- Returns
- FileRepoStatus
- Exceptions
-
MWException
Reimplemented from LocalFile.
Definition at line 109 of file ForeignDBFile.php.
References File\readOnlyError().
◆ newFromRow()
|
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, File\$repo, File\$title, Title\makeTitle(), and NS_FILE.
◆ newFromTitle()
|
static |
- Returns
- ForeignDBFile
Reimplemented from LocalFile.
Definition at line 36 of file ForeignDBFile.php.
References File\$repo, and File\$title.
◆ publish()
- Parameters
-
string $srcPath int $flags array $options
- Returns
- FileRepoStatus
- 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
-
$oldver $desc string $license string $copyStatus string $source string $watch bool $timestamp bool|string $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()
- Parameters
-
array $versions bool $unsuppress
- Returns
- FileRepoStatus
- 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
