MediaWiki REL1_34
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)
 
 exists ()
 If archive name is an empty string, then file does not "exist".
 
 getArchiveName ()
 
 getCacheKey ()
 
 getRel ()
 
 getUrlRel ()
 
 getVisibility ()
 Returns bitfield value.
 
 isDeleted ( $field)
 
 isOld ()
 
 isVisible ()
 
 loadFromDB ( $flags=0)
 Load file metadata from the DB.
 
 upgradeRow ()
 Fix assorted version-related problems with the image row by reloading it from the file.
 
 uploadOld ( $srcPath, $timestamp, $comment, $user)
 Upload a file directly into archive.
 
 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.
 
- Public Member Functions inherited from LocalFile
 __construct ( $title, $repo)
 Do not call this except from inside a repo class.
 
 __destruct ()
 Clean up any dangling locks.
 
 acquireFileLock ()
 
 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.
 
 delete ( $reason, $suppress=false, $user=null)
 Delete all versions of the file.
 
 deleteOld ( $archiveName, $reason, $suppress=false, $user=null)
 Delete an old version of the file.
 
 getBitDepth ()
 
 getDescription ( $audience=self::FOR_PUBLIC, User $user=null)
 
 getDescriptionShortUrl ()
 Get short description URL for a file based on the page ID.
 
 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.
 
 getDescriptionTouched ()
 
 getDescriptionUrl ()
 isMultipage inherited
 
 getHeight ( $page=1)
 Return the height of the image.
 
 getHistory ( $limit=null, $start=null, $end=null, $inc=true)
 purgeDescription inherited
 
 getMediaType ()
 Returns the type of the media in the file.
 
 getMetadata ()
 Get handler-specific metadata.
 
 getMimeType ()
 Returns the MIME type of the file.
 
 getMutableCacheKeys (WANObjectCache $cache)
 
 getSha1 ()
 
 getSize ()
 Returns the size of the image file, in bytes.
 
 getThumbnails ( $archiveName=false)
 getTransformScript inherited
 
 getTimestamp ()
 
 getUpgraded ()
 
 getUser ( $type='text')
 Returns user who uploaded the file.
 
 getWidth ( $page=1)
 Return the width of the image.
 
 invalidateCache ()
 Purge the file object/metadata cache.
 
 isCacheable ()
 
 isMissing ()
 splitMime inherited
 
 load ( $flags=0)
 Load file metadata from cache or DB, unless already loaded.
 
 loadFromFile ()
 Load metadata from the file itself.
 
 loadFromRow ( $row, $prefix='img_')
 Load file metadata from a DB result row.
 
 lock ()
 Start an atomic DB section and lock the image for update or increments a reference counter if the lock is already held.
 
 move ( $target)
 getLinksTo inherited
 
 nextHistoryLine ()
 Returns the history of this file, line by line.
 
 prerenderThumbnails ()
 Prerenders a configurable set of thumbnails.
 
 publish ( $src, $flags=0, array $options=[])
 Move or copy a file to its public location.
 
 publishTo ( $src, $dstRel, $flags=0, array $options=[])
 Move or copy a file to a specified location.
 
 purgeCache ( $options=[])
 Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
 
 purgeMetadataCache ()
 Refresh metadata in memcached, but don't touch thumbnails or CDN.
 
 purgeOldThumbnails ( $archiveName)
 Delete cached transformed files for an archived version only.
 
 purgeThumbnails ( $options=[])
 Delete cached transformed files for the current version only.
 
 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.
 
 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.
 
 releaseFileLock ()
 
 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.
 
 setProps ( $info)
 Set properties in this object to be equal to those given in the associative array $info.
 
 unlock ()
 Decrement the lock reference count and end the atomic section if it reaches zero.
 
 upload ( $src, $comment, $pageText, $flags=0, $props=false, $timestamp=false, $user=null, $tags=[], $createNullRevision=true, $revert=false)
 getHashPath inherited
 
- 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.
 
 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.
 
 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.
 
 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.
 
 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.
 
 getName ()
 Return the name of this file.
 
 getOriginalTitle ()
 Return the title used to find this file.
 
 getPath ()
 Return the storage path to the file.
 
 getRedirected ()
 
 getRedirectedTitle ()
 
 getRepo ()
 Returns the repository.
 
 getRepoName ()
 Returns the name of the repository.
 
 getShortDesc ()
 
 getStorageKey ()
 Get the deletion archive key, "<sha1>.<ext>".
 
 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.
 
 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.
 
 getViewURL ()
 
 getVirtualUrl ( $suffix=false)
 Get the public zone virtual URL for a current version source file.
 
 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.
 
 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.
 
 isMultipage ()
 Returns 'true' if this file is a type which supports multiple pages, e.g.
 
 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.
 
 migrateThumbFile ( $thumbName)
 Hook into transform() to allow migration of thumbnail files STUB Overridden by LocalFile.
 
 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.
 
 pageCount ()
 Returns the number of pages of a multipage document, or false for documents which aren't multipage documents.
 
 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 ()
 
 redirectedFrom ( $from)
 
 thumbName ( $params, $flags=0)
 Return the file name of a thumbnail with the specified parameters.
 
 transform ( $params, $flags=0)
 Transform a media file.
 
 wasDeleted ()
 Was this file ever deleted from the wiki?
 

Static Public Member Functions

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

Public Attributes

const CACHE_VERSION = 1
 
const MAX_CACHE_ROWS = 20
 
- Public Attributes inherited from LocalFile
const ATOMIC_SECTION_LOCK = 'LocalFile::lockingTransaction'
 
const CACHE_FIELD_MAX_LEN = 1000
 
const LOAD_ALL = 16
 
const VERSION = 11
 
- 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 = self::READ_LATEST | 2
 Constants for object loading bitfield flags (higher => higher QoS)
 
const READ_NONE = -1
 

Protected Member Functions

 getCacheFields ( $prefix='img_')
 Returns the list of object properties that are included as-is in the cache.
Parameters
string$prefixMust be the empty string
Returns
string[]
Since
1.31 No longer accepts a non-empty $prefix

 
 loadExtraFromDB ()
 Load lazy file metadata from the DB.
 
 recordOldUpload ( $srcPath, $archiveName, $timestamp, $comment, $user)
 Record a file upload in the oldimage table, without adding log entries.
 
- 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().
 
 maybeUpgradeRow ()
 Upgrade a row if it needs it.
 
 purgeThumbList ( $dir, $files)
 Delete a list of thumbnails visible at urls.
 
 readOnlyFatalStatus ()
 
 unprefixRow ( $row, $prefix='img_')
 
- 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

string $archive_name
 Archive name.
 
string int $requestedTime
 Timestamp.
 
- Protected Attributes inherited from LocalFile
int $bits
 Returned by getimagesize (loadFromXxx)
 
bool $dataLoaded
 Whether or not core data has been loaded from the database (loadFromXxx)
 
int $deleted
 Bitfield akin to rev_deleted.
 
bool $extraDataLoaded
 Whether or not lazy-loaded data has been loaded from the database.
 
bool $fileExists
 Does the file exist on disk? (loadFromXxx)
 
int $height
 Image height.
 
string $media_type
 MEDIATYPE_xxx (bitmap, drawing, audio...)
 
string $metadata
 Handler-specific metadata.
 
string $mime
 MIME type, determined by MimeAnalyzer::guessMimeType.
 
string $repoClass = LocalRepo::class
 
string $sha1
 SHA-1 base 36 content hash.
 
int $size
 Size in bytes (loadFromXxx)
 
int $width
 Image width.
 
- 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

Class to represent a file in the oldimage table.

Definition at line 31 of file OldLocalFile.php.

Constructor & Destructor Documentation

◆ __construct()

OldLocalFile::__construct (   $title,
  $repo,
  $time,
  $archiveName 
)
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 161 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 441 of file OldLocalFile.php.

References getArchiveName().

Referenced by isVisible().

◆ getArchiveName()

OldLocalFile::getArchiveName ( )
Returns
string

Definition at line 180 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.

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

Reimplemented from LocalFile.

Definition at line 276 of file OldLocalFile.php.

◆ getCacheKey()

OldLocalFile::getCacheKey ( )
Returns
bool

Reimplemented from LocalFile.

Definition at line 173 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
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 120 of file OldLocalFile.php.

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

◆ getRel()

OldLocalFile::getRel ( )
Returns
string

Reimplemented from File.

Definition at line 287 of file OldLocalFile.php.

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

Referenced by recordOldUpload().

◆ getUrlRel()

OldLocalFile::getUrlRel ( )
Returns
string

Reimplemented from File.

Definition at line 294 of file OldLocalFile.php.

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

◆ getVisibility()

OldLocalFile::getVisibility ( )

Returns bitfield value.

Returns
int

Reimplemented from File.

Definition at line 345 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 335 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 191 of file OldLocalFile.php.

◆ isVisible()

OldLocalFile::isVisible ( )
Returns
bool

Reimplemented from File.

Definition at line 198 of file OldLocalFile.php.

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

◆ loadExtraFromDB()

OldLocalFile::loadExtraFromDB ( )
protected

Load lazy file metadata from the DB.

Reimplemented from LocalFile.

Definition at line 234 of file OldLocalFile.php.

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

◆ loadFromDB()

OldLocalFile::loadFromDB (   $flags = 0)

Load file metadata from the DB.

Parameters
int$flags

Reimplemented from LocalFile.

Definition at line 202 of file OldLocalFile.php.

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

◆ newFromArchiveName()

static OldLocalFile::newFromArchiveName (   $title,
  $repo,
  $archiveName 
)
static
Parameters
Title$title
FileRepo$repo
string$archiveName
Returns
static

Definition at line 63 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.

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

Reimplemented from LocalFile.

Definition at line 90 of file OldLocalFile.php.

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

◆ newFromRow()

static OldLocalFile::newFromRow (   $row,
  $repo 
)
static
Parameters
stdClass$row
FileRepo$repo
Returns
static

Reimplemented from LocalFile.

Definition at line 72 of file OldLocalFile.php.

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

◆ newFromTitle()

static OldLocalFile::newFromTitle (   $title,
  $repo,
  $time = null 
)
static
Parameters
Title$title
FileRepo$repo
string | int | null$time
Returns
static
Exceptions
MWException

Reimplemented from LocalFile.

Definition at line 48 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.

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 402 of file OldLocalFile.php.

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

◆ upgradeRow()

OldLocalFile::upgradeRow ( )

Fix assorted version-related problems with the image row by reloading it from the file.

Reimplemented from LocalFile.

Definition at line 298 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 374 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
Returns
bool

Reimplemented from File.

Definition at line 359 of file OldLocalFile.php.

References LocalFile\$user, LocalFile\load(), and Revision\userCanBitfield().

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

Member Data Documentation

◆ $archive_name

string OldLocalFile::$archive_name
protected

Archive name.

Definition at line 36 of file OldLocalFile.php.

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

◆ $requestedTime

string int OldLocalFile::$requestedTime
protected

Timestamp.

Definition at line 33 of file OldLocalFile.php.

◆ CACHE_VERSION

const OldLocalFile::CACHE_VERSION = 1

Definition at line 38 of file OldLocalFile.php.

◆ MAX_CACHE_ROWS

const OldLocalFile::MAX_CACHE_ROWS = 20

Definition at line 39 of file OldLocalFile.php.


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