MediaWiki  master
ArchivedFile Class Reference

Deleted file in the 'filearchive' table. More...

Collaboration diagram for ArchivedFile:

Public Member Functions

 __construct ( $title, $id=0, $key='', $sha1='')
 
 exists ()
 
 getBits ()
 Return the bits of the image file, in bytes. More...
 
 getDescription (int $audience=self::FOR_PUBLIC, Authority $performer=null)
 Return upload description. More...
 
 getGroup ()
 Return the FileStore storage group. More...
 
 getHeight ()
 Return the height of the image. More...
 
 getID ()
 
 getKey ()
 Return the FileStore key. More...
 
 getMediaType ()
 Return the type of the media in the file. More...
 
 getMetadata ()
 Get handler-specific metadata as a serialized string. More...
 
 getMetadataArray ()
 Get unserialized handler-specific metadata. More...
 
 getMetadataForDb (IDatabase $db)
 Serialize the metadata array for insertion into img_metadata, oi_metadata or fa_metadata. More...
 
 getMetadataItems (array $itemNames)
 
 getMimeType ()
 Returns the MIME type of the file. More...
 
 getName ()
 Return the file name. More...
 
 getSha1 ()
 Get the SHA-1 base 36 hash of the file. More...
 
 getSize ()
 Return the size of the image file, in bytes. More...
 
 getStorageKey ()
 Return the FileStore key (overriding base File class) More...
 
 getTimestamp ()
 Return upload timestamp. More...
 
 getTitle ()
 Return the associated title object. More...
 
 getUploader (int $audience=self::FOR_PUBLIC, Authority $performer=null)
 
 getVisibility ()
 Returns the deletion bitfield. More...
 
 getWidth ()
 Return the width of the image. More...
 
 isDeleted ( $field)
 for file or revision rows More...
 
 load ()
 Loads a file object from the filearchive table. More...
 
 loadFromRow ( $row)
 Load ArchivedFile object fields from a DB row. More...
 
 pageCount ()
 Returns the number of pages of a multipage document, or false for documents which aren't multipage documents. More...
 
 userCan ( $field, Authority $performer)
 Determine if the current user is allowed to view a particular field of this FileStore image file, if it's marked as deleted. More...
 

Static Public Member Functions

static getQueryInfo ()
 Return the tables, fields, and join conditions to be selected to create a new archivedfile object. More...
 
static newFromRow ( $row)
 Loads a file object from the filearchive table. More...
 

Public Attributes

const FOR_PUBLIC = 1
 
const FOR_THIS_USER = 2
 
const RAW = 3
 

Protected Member Functions

 loadMetadataFromDbFieldValue (IDatabase $db, $metadataBlob)
 Unserialize a metadata blob which came from the database and store it in $this. More...
 
 loadMetadataFromString ( $metadataString)
 Unserialize a metadata string which came from some non-DB source, or is the return value of IDatabase::decodeBlob(). More...
 

Protected Attributes

bool $exists
 
bool $extraDataLoaded = false
 Whether or not lazy-loaded data has been loaded from the database. More...
 
MediaHandler $handler
 
array $metadataArray = []
 Unserialized metadata. More...
 
string[] $metadataBlobs = []
 Map of metadata item name to blob address. More...
 
string null $metadataSerializationFormat
 One of the MDS_* constants, giving the format of the metadata as stored in the DB, or null if the data was not loaded from the DB. More...
 
Title null $title
 
string[] $unloadedMetadataBlobs = []
 Map of metadata item name to blob address for items that exist but have not yet been loaded into $this->metadataArray. More...
 

Detailed Description

Deleted file in the 'filearchive' table.

Stability: stable
to extend

Definition at line 34 of file ArchivedFile.php.

Constructor & Destructor Documentation

◆ __construct()

ArchivedFile::__construct (   $title,
  $id = 0,
  $key = '',
  $sha1 = '' 
)
Stability: stable
to call
Exceptions
MWException
Parameters
Title | null$title
int$id
string$key
string$sha1

Definition at line 157 of file ArchivedFile.php.

References $title, exists(), Title\getDBkey(), and File\normalizeTitle().

Member Function Documentation

◆ exists()

ArchivedFile::exists ( )
Returns
bool

Definition at line 401 of file ArchivedFile.php.

References $exists, and load().

Referenced by __construct(), and load().

◆ getBits()

ArchivedFile::getBits ( )

Return the bits of the image file, in bytes.

Returns
int

Definition at line 639 of file ArchivedFile.php.

◆ getDescription()

ArchivedFile::getDescription ( int  $audience = self::FOR_PUBLIC,
Authority  $performer = null 
)

Return upload description.

Since
1.37 the method takes $audience and $performer parameters.
Parameters
int$audienceOne of: File::FOR_PUBLIC to be displayed to all users File::FOR_THIS_USER to be displayed to the given user File::RAW get the description regardless of permissions
Authority | null$performerto check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns
string

Definition at line 756 of file ArchivedFile.php.

◆ getGroup()

ArchivedFile::getGroup ( )

Return the FileStore storage group.

Returns
string

Definition at line 429 of file ArchivedFile.php.

◆ getHeight()

ArchivedFile::getHeight ( )

Return the height of the image.

Returns
int

Definition at line 447 of file ArchivedFile.php.

References load().

◆ getID()

ArchivedFile::getID ( )
Returns
int

Definition at line 392 of file ArchivedFile.php.

References load().

◆ getKey()

ArchivedFile::getKey ( )

Return the FileStore key.

Returns
string

Definition at line 411 of file ArchivedFile.php.

References load().

Referenced by getStorageKey().

◆ getMediaType()

ArchivedFile::getMediaType ( )

Return the type of the media in the file.

Use the value returned by this function with the MEDIATYPE_xxx constants.

Returns
string

Definition at line 693 of file ArchivedFile.php.

◆ getMetadata()

ArchivedFile::getMetadata ( )

Get handler-specific metadata as a serialized string.

Deprecated:
since 1.37 use getMetadataArray() or getMetadataItem()
Returns
string

Definition at line 459 of file ArchivedFile.php.

References getMetadataArray(), and serialize().

◆ getMetadataArray()

ArchivedFile::getMetadataArray ( )

Get unserialized handler-specific metadata.

Since
1.39
Returns
array

Definition at line 477 of file ArchivedFile.php.

References getMetadataItems().

Referenced by getMetadata().

◆ getMetadataForDb()

ArchivedFile::getMetadataForDb ( IDatabase  $db)

Serialize the metadata array for insertion into img_metadata, oi_metadata or fa_metadata.

If metadata splitting is enabled, this may write blobs to the database, returning their addresses.

Access: internal
Parameters
IDatabase$db
Returns
string|Blob

Definition at line 527 of file ArchivedFile.php.

References $s, Wikimedia\Rdbms\IDatabase\encodeBlob(), and serialize().

◆ getMetadataItems()

ArchivedFile::getMetadataItems ( array  $itemNames)

Definition at line 490 of file ArchivedFile.php.

Referenced by getMetadataArray().

◆ getMimeType()

ArchivedFile::getMimeType ( )

Returns the MIME type of the file.

Returns
string

Definition at line 649 of file ArchivedFile.php.

References $mime.

◆ getName()

ArchivedFile::getName ( )

Return the file name.

Returns
string

Definition at line 381 of file ArchivedFile.php.

References load().

Referenced by EraseArchivedFile\scrubVersion().

◆ getQueryInfo()

static ArchivedFile::getQueryInfo ( )
static

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

Since 1.34, fa_user and fa_user_text have not been present in the database, but they continue to be available in query results as an alias.

Since
1.31
Stability: stable
to override
Returns
array[] With three keys:
  • tables: (string[]) to include in the $table to IDatabase->select() or SelectQueryBuilder::tables
  • fields: (string[]) to include in the $vars to IDatabase->select() or SelectQueryBuilder::fields
  • joins: (array) to include in the $join_conds to IDatabase->select() or SelectQueryBuilder::joinConds

Definition at line 289 of file ArchivedFile.php.

Referenced by RevDelArchivedFileList\doQuery(), ApiQueryFilearchive\execute(), LocalFileRestoreBatch\execute(), EraseArchivedFile\execute(), PageArchive\listFiles(), load(), and EraseArchivedFile\scrubAllVersions().

◆ getSha1()

ArchivedFile::getSha1 ( )

Get the SHA-1 base 36 hash of the file.

Returns
string
Since
1.21

Definition at line 716 of file ArchivedFile.php.

◆ getSize()

ArchivedFile::getSize ( )

Return the size of the image file, in bytes.

Returns
int

Definition at line 629 of file ArchivedFile.php.

◆ getStorageKey()

ArchivedFile::getStorageKey ( )

Return the FileStore key (overriding base File class)

Returns
string

Definition at line 421 of file ArchivedFile.php.

References getKey().

Referenced by EraseArchivedFile\scrubVersion().

◆ getTimestamp()

ArchivedFile::getTimestamp ( )

Return upload timestamp.

Returns
string

Definition at line 704 of file ArchivedFile.php.

References wfTimestamp().

Referenced by EraseArchivedFile\scrubVersion().

◆ getTitle()

ArchivedFile::getTitle ( )

Return the associated title object.

Returns
Title

Definition at line 369 of file ArchivedFile.php.

References $title, and load().

◆ getUploader()

ArchivedFile::getUploader ( int  $audience = self::FOR_PUBLIC,
Authority  $performer = null 
)
Since
1.37
Stability: stable
to override
Parameters
int$audienceOne of: File::FOR_PUBLIC to be displayed to all users File::FOR_THIS_USER to be displayed to the given user File::RAW get the description regardless of permissions
Authority | null$performerto check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns
UserIdentity|null

Definition at line 733 of file ArchivedFile.php.

◆ getVisibility()

ArchivedFile::getVisibility ( )

Returns the deletion bitfield.

Returns
int

Definition at line 771 of file ArchivedFile.php.

◆ getWidth()

ArchivedFile::getWidth ( )

Return the width of the image.

Returns
int

Definition at line 437 of file ArchivedFile.php.

References load().

◆ isDeleted()

ArchivedFile::isDeleted (   $field)

for file or revision rows

Parameters
int$fieldOne of DELETED_* bitfield constants
Returns
bool

Definition at line 783 of file ArchivedFile.php.

◆ load()

ArchivedFile::load ( )

Loads a file object from the filearchive table.

Stability: stable
to override
Exceptions
MWException
Returns
bool|null True on success or null

Definition at line 208 of file ArchivedFile.php.

References $dbr, DB_REPLICA, exists(), getQueryInfo(), loadFromRow(), NS_FILE, and wfGetDB().

Referenced by exists(), getHeight(), getID(), getKey(), getName(), getTitle(), and getWidth().

◆ loadFromRow()

ArchivedFile::loadFromRow (   $row)

Load ArchivedFile object fields from a DB row.

Stability: stable
to override
Parameters
stdClass$rowObject database row
Since
1.21

Definition at line 331 of file ArchivedFile.php.

References DB_REPLICA, LocalRepo\getHashFromKey(), loadMetadataFromDbFieldValue(), Title\makeTitleSafe(), NS_FILE, and wfGetDB().

Referenced by load().

◆ loadMetadataFromDbFieldValue()

ArchivedFile::loadMetadataFromDbFieldValue ( IDatabase  $db,
  $metadataBlob 
)
protected

Unserialize a metadata blob which came from the database and store it in $this.

Since
1.39
Parameters
IDatabase$db
string | Blob$metadataBlob

Definition at line 575 of file ArchivedFile.php.

References Wikimedia\Rdbms\IDatabase\decodeBlob().

Referenced by loadFromRow().

◆ loadMetadataFromString()

ArchivedFile::loadMetadataFromString (   $metadataString)
protected

Unserialize a metadata string which came from some non-DB source, or is the return value of IDatabase::decodeBlob().

Since
1.37
Parameters
string$metadataString

Definition at line 586 of file ArchivedFile.php.

References unserialize().

◆ newFromRow()

static ArchivedFile::newFromRow (   $row)
static

Loads a file object from the filearchive table.

Stability: stable
to override
Parameters
stdClass$row
Returns
ArchivedFile

Definition at line 266 of file ArchivedFile.php.

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

Referenced by ApiQueryFilearchive\execute(), EraseArchivedFile\execute(), RevDelArchivedFileItem\initFile(), and EraseArchivedFile\scrubAllVersions().

◆ pageCount()

ArchivedFile::pageCount ( )

Returns the number of pages of a multipage document, or false for documents which aren't multipage documents.

Stability: stable
to override
Returns
int|false

Definition at line 673 of file ArchivedFile.php.

◆ userCan()

ArchivedFile::userCan (   $field,
Authority  $performer 
)

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

Parameters
int$field
Authority$performer
Returns
bool

Definition at line 796 of file ArchivedFile.php.

References $title, and getTitle().

Member Data Documentation

◆ $exists

bool ArchivedFile::$exists
protected

Definition at line 141 of file ArchivedFile.php.

Referenced by exists().

◆ $extraDataLoaded

bool ArchivedFile::$extraDataLoaded = false
protected

Whether or not lazy-loaded data has been loaded from the database.

Definition at line 81 of file ArchivedFile.php.

◆ $handler

MediaHandler ArchivedFile::$handler
protected

Definition at line 135 of file ArchivedFile.php.

◆ $metadataArray

array ArchivedFile::$metadataArray = []
protected

Unserialized metadata.

Definition at line 78 of file ArchivedFile.php.

◆ $metadataBlobs

string [] ArchivedFile::$metadataBlobs = []
protected

Map of metadata item name to blob address.

Definition at line 92 of file ArchivedFile.php.

◆ $metadataSerializationFormat

string null ArchivedFile::$metadataSerializationFormat
protected

One of the MDS_* constants, giving the format of the metadata as stored in the DB, or null if the data was not loaded from the DB.

Definition at line 89 of file ArchivedFile.php.

◆ $title

Title null ArchivedFile::$title
protected

Definition at line 138 of file ArchivedFile.php.

Referenced by __construct(), and getTitle().

◆ $unloadedMetadataBlobs

string [] ArchivedFile::$unloadedMetadataBlobs = []
protected

Map of metadata item name to blob address for items that exist but have not yet been loaded into $this->metadataArray.

Definition at line 100 of file ArchivedFile.php.

◆ FOR_PUBLIC

const ArchivedFile::FOR_PUBLIC = 1

Definition at line 37 of file ArchivedFile.php.

◆ FOR_THIS_USER

const ArchivedFile::FOR_THIS_USER = 2

Definition at line 38 of file ArchivedFile.php.

Referenced by RevDelArchivedFileItem\getApiData().

◆ RAW

const ArchivedFile::RAW = 3

Definition at line 39 of file ArchivedFile.php.


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