MediaWiki  master
OldLocalFile Class Reference

Class to represent a file in the oldimage table. More...

Inheritance diagram for OldLocalFile:
Collaboration diagram for OldLocalFile:

Public Member Functions

 __construct ( $title, $repo, $time, $archiveName)
 Stable to call. More...
 
 exists ()
 If archive name is an empty string, then file does not "exist". More...
 
 getArchiveName ()
 Stable to override. More...
 
 getRel ()
 
 getUrlRel ()
 
 getVisibility ()
 Returns bitfield value. More...
 
 isDeleted ( $field)
 
 isOld ()
 
 isVisible ()
 
 upgradeRow ()
 Stable to override. More...
 
 uploadOld ( $srcPath, $timestamp, $comment, $user)
 Upload a file directly into archive. More...
 
 userCan ( $field, User $user=null)
 Determine if the current user is allowed to view a particular field of this image file, if it's marked as deleted. More...
 
- Public Member Functions inherited from LocalFile
 __construct ( $title, $repo)
 Do not call this except from inside a repo class. More...
 
 __destruct ()
 Clean up any dangling locks. More...
 
 acquireFileLock ()
 
 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...
 
 deleteOld ( $archiveName, $reason, $suppress=false, $user=null)
 Delete an old version of the file. More...
 
 deleteOldFile ( $archiveName, $reason, User $user, $suppress=false)
 Delete an old version of the file. More...
 
 getBitDepth ()
 @stable to override More...
 
 getDescription ( $audience=self::FOR_PUBLIC, User $user=null)
 Stable to override. More...
 
 getDescriptionShortUrl ()
 Get short description URL for a file based on the page ID. More...
 
 getDescriptionText (Language $lang=null)
 Get the HTML text of the description page This is not used by ImagePage for local files, since (among other things) it skips the parser cache. More...
 
 getDescriptionTouched ()
 Stable to override. More...
 
 getDescriptionUrl ()
 isMultipage inherited More...
 
 getHeight ( $page=1)
 Return the height of the image @stable to override. More...
 
 getHistory ( $limit=null, $start=null, $end=null, $inc=true)
 purgeDescription inherited More...
 
 getMediaType ()
 Returns the type of the media in the file. More...
 
 getMetadata ()
 Get handler-specific metadata @stable to override. More...
 
 getMimeType ()
 Returns the MIME type of the file. More...
 
 getMutableCacheKeys (WANObjectCache $cache)
 
 getRepo ()
 
 getSha1 ()
 Stable to override. More...
 
 getSize ()
 Returns the size of the image file, in bytes @stable to override. More...
 
 getTimestamp ()
 Stable to override. More...
 
 getUpgraded ()
 
 getUser ( $type='text')
 Returns user who uploaded the file @stable to override. More...
 
 getWidth ( $page=1)
 Return the width of the image @stable to override. More...
 
 invalidateCache ()
 Purge the file object/metadata cache. More...
 
 isCacheable ()
 
 isMissing ()
 splitMime inherited More...
 
 load ( $flags=0)
 Load file metadata from cache or DB, unless already loaded Stable to override. More...
 
 loadFromRow ( $row, $prefix='img_')
 Load file metadata from a DB result row Stable to override. More...
 
 lock ()
 Start an atomic DB section and lock the image for update or increments a reference counter if the lock is already held. More...
 
 move ( $target)
 getLinksTo inherited More...
 
 nextHistoryLine ()
 Returns the history of this file, line by line. More...
 
 prerenderThumbnails ()
 Prerenders a configurable set of thumbnails Stable to override. More...
 
 publish ( $src, $flags=0, array $options=[])
 Move or copy a file to its public location. More...
 
 purgeCache ( $options=[])
 Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN. More...
 
 purgeOldThumbnails ( $archiveName)
 Delete cached transformed files for an archived version only. More...
 
 purgeThumbnails ( $options=[])
 Delete cached transformed files for the current version only. 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. More...
 
 recordUpload2 ( $oldver, $comment, $pageText, $props=false, $timestamp=false, $user=null, $tags=[], $createNullRevision=true, $revert=false)
 Record a file upload in the upload log and the image table. More...
 
 recordUpload3 (string $oldver, string $comment, string $pageText, User $user, $props=false, $timestamp=false, $tags=[], bool $createNullRevision=true, bool $revert=false)
 Record a file upload in the upload log and the image table (version 3) More...
 
 releaseFileLock ()
 
 resetHistory ()
 Reset the history pointer to the first element of the history Stable to override. More...
 
 restore ( $versions=[], $unsuppress=false)
 Restore all or specified deleted revisions to the given file. More...
 
 unlock ()
 Decrement the lock reference count and end the atomic section if it reaches zero. More...
 
 upload ( $src, $comment, $pageText, $flags=0, $props=false, $timestamp=false, $user=null, $tags=[], $createNullRevision=true, $revert=false)
 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 ( $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...
 
 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...
 
 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...
 
 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...
 
 getPath ()
 Return the storage path to the file. More...
 
 getRedirected ()
 
 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...
 
 getThumbPath ( $suffix=false)
 Get the path of the thumbnail directory, or a particular file if $suffix is specified Stable to override. 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...
 
 getUrl ()
 Return the URL of the file Stable to override. More...
 
 getViewURL ()
 
 getVirtualUrl ( $suffix=false)
 Get the public zone virtual URL for a current version source file Stable to override. More...
 
 iconThumb ()
 Get a ThumbnailImage representing a file type icon. 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...
 
 isMultipage ()
 Returns 'true' if this file is a type which supports multiple pages, e.g. 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...
 
 isVectorized ()
 Return true if the file is vectorized. 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...
 
 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 Stable to override. More...
 
 wasDeleted ()
 Was this file ever deleted from the wiki? More...
 

Static Public Member Functions

static getQueryInfo (array $options=[])
 Return the tables, fields, and join conditions to be selected to create a new oldlocalfile object. More...
 
static newFromArchiveName ( $title, $repo, $archiveName)
 Stable to override. More...
 
static newFromKey ( $sha1, $repo, $timestamp=false)
 Create a OldLocalFile from a SHA-1 key Do not call this except from inside a repo class. More...
 
static newFromRow ( $row, $repo)
 Stable to override. More...
 
static newFromTitle ( $title, $repo, $time=null)
 Stable to override. 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 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...
 

Public Attributes

const CACHE_VERSION = 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
 
- Public Attributes inherited from IDBAccessObject
const READ_NONE = -1
 Constants for object loading bitfield flags (higher => higher QoS) More...
 

Protected Member Functions

 getCacheFields ( $prefix='img_')
 Returns the list of object properties that are included as-is in the cache.Stable to override

Parameters
string$prefixMust be the empty string
Returns
string[]
Since
1.31 No longer accepts a non-empty $prefix
Stable to override More...
 
 getCacheKey ()
 Stable to override. More...
 
 loadExtraFromDB ()
 Load lazy file metadata from the DB Stable to override. More...
 
 loadFromDB ( $flags=0)
 Stable to override. More...
 
 recordOldUpload ( $srcPath, $archiveName, $timestamp, $comment, $user)
 Record a file upload in the oldimage table, without adding log entries. More...
 
- Protected Member Functions inherited from LocalFile
 getLazyCacheFields ( $prefix='img_')
 Returns the list of object properties that are included as-is in the cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB(). More...
 
 getThumbnails ( $archiveName=false)
 getTransformScript inherited More...
 
 loadFromFile ()
 Load metadata from the file itself. More...
 
 maybeUpgradeRow ()
 Upgrade a row if it needs it. More...
 
 publishTo ( $src, $dstRel, $flags=0, array $options=[])
 Move or copy a file to a specified location. More...
 
 purgeThumbList ( $dir, $files)
 Delete a list of thumbnails visible at urls Stable to override. More...
 
 readOnlyFatalStatus ()
 
 setProps ( $info)
 Set properties in this object to be equal to those given in the associative array $info. More...
 
 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...
 
 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 ()
 
 getThumbnails ()
 Get all thumbnail names previously generated for this file STUB Overridden by LocalFile Stable to override. More...
 
 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

string $archive_name
 Archive name. More...
 
string int $requestedTime
 Timestamp. 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 MimeAnalyzer::guessMimeType. More...
 
string $repoClass = LocalRepo::class
 
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
 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...
 

Detailed Description

Class to represent a file in the oldimage table.

Stable to extend

Definition at line 33 of file OldLocalFile.php.

Constructor & Destructor Documentation

◆ __construct()

OldLocalFile::__construct (   $title,
  $repo,
  $time,
  $archiveName 
)

Stable to call.

Parameters
Title$title
FileRepo$repo
string | int | null$timeTimestamp or null to load by archive name
string | null$archiveNameArchive name or null to load by timestamp
Exceptions
MWException

Definition at line 173 of file OldLocalFile.php.

References File\$repo, and File\$title.

Member Function Documentation

◆ exists()

OldLocalFile::exists ( )

If archive name is an empty string, then file does not "exist".

This is the case for a couple files on Wikimedia servers where the old version is "lost".

Returns
bool

Reimplemented from LocalFile.

Definition at line 478 of file OldLocalFile.php.

References getArchiveName().

Referenced by isVisible().

◆ getArchiveName()

OldLocalFile::getArchiveName ( )

Stable to override.

Returns
string

Definition at line 194 of file OldLocalFile.php.

References $archive_name, and LocalFile\load().

Referenced by exists(), RevDelFileItem\getApiData(), getRel(), getUrlRel(), and uploadOld().

◆ getCacheFields()

OldLocalFile::getCacheFields (   $prefix = 'img_')
protected

Returns the list of object properties that are included as-is in the cache.Stable to override

Parameters
string$prefixMust be the empty string
Returns
string[]
Since
1.31 No longer accepts a non-empty $prefix
Stable to override

Reimplemented from LocalFile.

Definition at line 298 of file OldLocalFile.php.

◆ getCacheKey()

OldLocalFile::getCacheKey ( )
protected

Stable to override.

Returns
bool

Reimplemented from LocalFile.

Definition at line 186 of file OldLocalFile.php.

◆ getQueryInfo()

static OldLocalFile::getQueryInfo ( array  $options = [])
static

Return the tables, fields, and join conditions to be selected to create a new oldlocalfile object.

Since
1.31 Stable to override
Parameters
string[]$options
  • omit-lazy: Omit fields that are lazily cached.
Returns
array[] With three keys:
  • tables: (string[]) to include in the $table to IDatabase->select()
  • fields: (string[]) to include in the $vars to IDatabase->select()
  • joins: (array) to include in the $join_conds to IDatabase->select()

Reimplemented from LocalFile.

Definition at line 130 of file OldLocalFile.php.

References ActorMigration\newMigration().

Referenced by ImageBuilder\buildOldImage(), LocalFileDeleteBatch\doDBInserts(), RevDelFileList\doQuery(), LocalRepo\findFiles(), LocalFile\getHistory(), LocalFile\loadExtraFieldsWithTimestamp(), and LocalFile\nextHistoryLine().

◆ getRel()

OldLocalFile::getRel ( )
Returns
string Stable to override

Reimplemented from File.

Definition at line 310 of file OldLocalFile.php.

References getArchiveName(), and File\getArchiveRel().

Referenced by recordOldUpload().

◆ getUrlRel()

OldLocalFile::getUrlRel ( )
Returns
string Stable to override

Reimplemented from File.

Definition at line 318 of file OldLocalFile.php.

References getArchiveName(), and File\getArchiveRel().

◆ getVisibility()

OldLocalFile::getVisibility ( )

Returns bitfield value.

Returns
int

Reimplemented from File.

Definition at line 372 of file OldLocalFile.php.

References LocalFile\$deleted, and LocalFile\load().

◆ isDeleted()

OldLocalFile::isDeleted (   $field)
Parameters
int$fieldOne of DELETED_* bitfield constants for file or revision rows
Returns
bool

Reimplemented from File.

Definition at line 362 of file OldLocalFile.php.

References LocalFile\load().

Referenced by RevDelArchivedFileItem\getApiData(), RevDelFileItem\getApiData(), and isVisible().

◆ isOld()

OldLocalFile::isOld ( )
Returns
bool

Reimplemented from File.

Definition at line 205 of file OldLocalFile.php.

◆ isVisible()

OldLocalFile::isVisible ( )
Returns
bool

Reimplemented from File.

Definition at line 212 of file OldLocalFile.php.

References File\DELETED_FILE, exists(), and isDeleted().

◆ loadExtraFromDB()

OldLocalFile::loadExtraFromDB ( )
protected

Load lazy file metadata from the DB Stable to override.

Reimplemented from LocalFile.

Definition at line 253 of file OldLocalFile.php.

References $archive_name, $dbr, File\$name, File\getName(), and LocalFile\unprefixRow().

◆ loadFromDB()

OldLocalFile::loadFromDB (   $flags = 0)
protected

Stable to override.

Parameters
int$flags

Reimplemented from LocalFile.

Definition at line 220 of file OldLocalFile.php.

References $archive_name, $dbr, File\getName(), and LocalFile\loadFromRow().

◆ newFromArchiveName()

static OldLocalFile::newFromArchiveName (   $title,
  $repo,
  $archiveName 
)
static

Stable to override.

Parameters
Title$title
FileRepo$repo
string$archiveName
Returns
static

Definition at line 67 of file OldLocalFile.php.

References File\$repo, and File\$title.

Referenced by ImportableUploadRevisionImporter\import(), LocalRepo\newFromArchiveName(), and RevertAction\onSubmit().

◆ newFromKey()

static OldLocalFile::newFromKey (   $sha1,
  $repo,
  $timestamp = false 
)
static

Create a OldLocalFile from a SHA-1 key Do not call this except from inside a repo class.

Stable to override

Parameters
string$sha1Base-36 SHA-1
LocalRepo$repo
string | bool$timestampMW_timestamp (optional)
Returns
bool|OldLocalFile

Reimplemented from LocalFile.

Definition at line 98 of file OldLocalFile.php.

References $dbr, File\$repo, LocalFile\$sha1, and LocalFile\$timestamp.

◆ newFromRow()

static OldLocalFile::newFromRow (   $row,
  $repo 
)
static

Stable to override.

Parameters
stdClass$row
FileRepo$repo
Returns
static

Reimplemented from LocalFile.

Definition at line 78 of file OldLocalFile.php.

References $file, File\$repo, File\$title, Title\makeTitle(), and NS_FILE.

◆ newFromTitle()

static OldLocalFile::newFromTitle (   $title,
  $repo,
  $time = null 
)
static

Stable to override.

Parameters
Title$title
FileRepo$repo
string | int | null$time
Returns
static
Exceptions
MWException

Reimplemented from LocalFile.

Definition at line 50 of file OldLocalFile.php.

References File\$repo, and File\$title.

◆ recordOldUpload()

OldLocalFile::recordOldUpload (   $srcPath,
  $archiveName,
  $timestamp,
  $comment,
  $user 
)
protected

Record a file upload in the oldimage table, without adding log entries.

Stable to override

Parameters
string$srcPathFile system path to the source file
string$archiveNameThe archive name of the file
string$timestamp
string$commentUpload comment
User$userUser who did this upload
Returns
bool

Definition at line 439 of file OldLocalFile.php.

References LocalFile\$timestamp, LocalFile\$user, File\getName(), getRel(), and ActorMigration\newMigration().

◆ upgradeRow()

OldLocalFile::upgradeRow ( )

Stable to override.

Reimplemented from LocalFile.

Definition at line 325 of file OldLocalFile.php.

References File\getName(), LocalFile\loadFromFile(), File\splitMime(), and wfDebug().

◆ uploadOld()

OldLocalFile::uploadOld (   $srcPath,
  $timestamp,
  $comment,
  $user 
)

Upload a file directly into archive.

Generally for Special:Import.

Parameters
string$srcPathFile system path of the source file
string$timestamp
string$comment
User$user
Returns
Status

Definition at line 410 of file OldLocalFile.php.

References LocalFile\$timestamp, LocalFile\$user, getArchiveName(), File\getArchiveRel(), LocalFile\lock(), LocalFile\publishTo(), and LocalFile\unlock().

◆ userCan()

OldLocalFile::userCan (   $field,
User  $user = null 
)

Determine if the current user is allowed to view a particular field of this image file, if it's marked as deleted.

Parameters
int$field
User | null$userUser object to check, or null to use $wgUser (deprecated since 1.35)
Returns
bool

Reimplemented from File.

Definition at line 386 of file OldLocalFile.php.

References LocalFile\$user, LocalFile\load(), and wfDeprecated().

Referenced by RevDelArchivedFileItem\getApiData(), and RevDelFileItem\getApiData().

Member Data Documentation

◆ $archive_name

string OldLocalFile::$archive_name
protected

Archive name.

Definition at line 38 of file OldLocalFile.php.

Referenced by getArchiveName(), loadExtraFromDB(), and loadFromDB().

◆ $requestedTime

string int OldLocalFile::$requestedTime
protected

Timestamp.

Definition at line 35 of file OldLocalFile.php.

◆ CACHE_VERSION

const OldLocalFile::CACHE_VERSION = 1

Definition at line 40 of file OldLocalFile.php.


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