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

Collaboration diagram for ArchivedFile:

[legend]

Public Member Functions
	__construct ( $title, $id=0, $key='', $sha1='')

	exists ()

	getBits ()

	getDescription (int $audience=self::FOR_PUBLIC, ?Authority $performer=null)
	Return upload description.

	getGroup ()
	Return the FileStore storage group.

	getHeight ()
	Return the height of the image.

	getID ()

	getKey ()
	Return the FileStore key.

	getMediaType ()
	Return the type of the media in the file.

	getMetadata ()
	Get handler-specific metadata as a serialized string.

	getMetadataArray ()
	Get unserialized handler-specific metadata.

	getMetadataForDb (IReadableDatabase $db)
	Serialize the metadata array for insertion into img_metadata, oi_metadata or fa_metadata.

	getMetadataItems (array $itemNames)

	getMimeType ()
	Returns the MIME type of the file.

	getName ()
	Return the file name.

	getSha1 ()
	Get the SHA-1 base 36 hash of the file.

	getSize ()
	Return the size of the image file, in bytes.

	getStorageKey ()
	Return the FileStore key (overriding base File class)

	getTimestamp ()
	Return upload timestamp.

	getTitle ()
	Return the associated title object.

	getUploader (int $audience=self::FOR_PUBLIC, ?Authority $performer=null)

	getVisibility ()
	Returns the deletion bitfield.

	getWidth ()
	Return the width of the image.

	isDeleted ( $field)
	for file or revision rows

	load ()
	Loads a file object from the filearchive table.

	loadFromRow ( $row)
	Load ArchivedFile object fields from a DB row.

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

	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.

Static Public Member Functions
static	getQueryInfo ()
	Return the tables, fields, and join conditions to be selected to create a new archivedfile object.

static	newFromRow ( $row)
	Loads a file object from the filearchive table.

Public Attributes
const	FOR_PUBLIC = 1

const	FOR_THIS_USER = 2

const	RAW = 3

Protected Member Functions
	loadMetadataFromDbFieldValue (IReadableDatabase $db, $metadataBlob)
	Unserialize a metadata blob which came from the database and store it in $this.

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

Protected Attributes
bool	$exists

bool	$extraDataLoaded = false
	Whether or not lazy-loaded data has been loaded from the database.

MediaHandler	$handler

array	$metadataArray = []
	Unserialized metadata.

string[]	$metadataBlobs = []
	Map of metadata item name to blob address.

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.

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.

Detailed Description

Deleted file in the 'filearchive' table.

Stability: stable: to extend

Definition at line 37 of file ArchivedFile.php.

Constructor & Destructor Documentation

◆ __construct()

ArchivedFile::__construct	(	$title,
		$id = 0,
		$key = '',
		$sha1 = '' )

Stability: stable: to call

Parameters

Title \| null	$title
int	$id
string	$key
string	$sha1

Definition at line 159 of file ArchivedFile.php.

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

Member Function Documentation

◆ exists()

ArchivedFile::exists ( )

Returns: bool

Definition at line 373 of file ArchivedFile.php.

References load().

Referenced by __construct(), and loadFromRow().

◆ getBits()

ArchivedFile::getBits ( )

Returns: int

Definition at line 610 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	$audience	One 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	$performer	to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: string

Definition at line 727 of file ArchivedFile.php.

◆ getGroup()

ArchivedFile::getGroup ( )

Return the FileStore storage group.

Returns: string

Definition at line 401 of file ArchivedFile.php.

◆ getHeight()

ArchivedFile::getHeight ( )

Return the height of the image.

Returns: int

Definition at line 419 of file ArchivedFile.php.

References load().

◆ getID()

ArchivedFile::getID ( )

Returns: int

Definition at line 364 of file ArchivedFile.php.

References load().

◆ getKey()

ArchivedFile::getKey ( )

Return the FileStore key.

Returns: string

Definition at line 383 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 664 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 431 of file ArchivedFile.php.

References getMetadataArray().

◆ getMetadataArray()

ArchivedFile::getMetadataArray ( )

Get unserialized handler-specific metadata.

Since: 1.39

Returns: array

Definition at line 449 of file ArchivedFile.php.

References getMetadataItems(), and load().

Referenced by getMetadata().

◆ getMetadataForDb()

ArchivedFile::getMetadataForDb ( IReadableDatabase $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

IReadableDatabase $db

Returns: string|Blob

Definition at line 499 of file ArchivedFile.php.

References Wikimedia\Rdbms\IReadableDatabase\encodeBlob().

◆ getMetadataItems()

ArchivedFile::getMetadataItems ( array $itemNames )

Definition at line 462 of file ArchivedFile.php.

Referenced by getMetadataArray().

◆ getMimeType()

ArchivedFile::getMimeType ( )

Returns the MIME type of the file.

Returns: string

Definition at line 620 of file ArchivedFile.php.

◆ getName()

ArchivedFile::getName ( )

Return the file name.

Returns: string

Definition at line 353 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

Deprecated: since 1.41 use FileSelectQueryBuilder instead

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 285 of file ArchivedFile.php.

References getQueryInfo().

Referenced by MediaWiki\Api\ApiQueryFilearchive\execute(), and getQueryInfo().

◆ getSha1()

ArchivedFile::getSha1 ( )

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

Returns: string

Since: 1.21

Definition at line 687 of file ArchivedFile.php.

◆ getSize()

ArchivedFile::getSize ( )

Return the size of the image file, in bytes.

Returns: int

Definition at line 601 of file ArchivedFile.php.

◆ getStorageKey()

ArchivedFile::getStorageKey ( )

Return the FileStore key (overriding base File class)

Returns: string

Definition at line 393 of file ArchivedFile.php.

References getKey().

Referenced by EraseArchivedFile\scrubVersion().

◆ getTimestamp()

ArchivedFile::getTimestamp ( )

Return upload timestamp.

Returns: string

Definition at line 675 of file ArchivedFile.php.

References wfTimestamp().

Referenced by EraseArchivedFile\scrubVersion().

◆ getTitle()

ArchivedFile::getTitle ( )

Return the associated title object.

Returns: Title

Definition at line 341 of file ArchivedFile.php.

References load().

◆ getUploader()

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

Since: 1.37

Stability: stable: to override

Parameters

int	$audience	One 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	$performer	to check for, only if FOR_THIS_USER is passed to the $audience parameter

Returns: UserIdentity|null

Definition at line 704 of file ArchivedFile.php.

◆ getVisibility()

ArchivedFile::getVisibility ( )

Returns the deletion bitfield.

Returns: int

Definition at line 742 of file ArchivedFile.php.

◆ getWidth()

ArchivedFile::getWidth ( )

Return the width of the image.

Returns: int

Definition at line 409 of file ArchivedFile.php.

References load().

◆ isDeleted()

ArchivedFile::isDeleted ( $field )

for file or revision rows

Parameters

int $field One of DELETED_* bitfield constants

Returns: bool

Definition at line 754 of file ArchivedFile.php.

◆ load()

ArchivedFile::load ( )

Loads a file object from the filearchive table.

Stability: stable: to override

Returns: bool|null True on success or null

Definition at line 209 of file ArchivedFile.php.

References loadFromRow(), and NS_FILE.

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

◆ loadFromRow()

ArchivedFile::loadFromRow ( $row )

Load ArchivedFile object fields from a DB row.

Stability: stable: to override

Parameters

stdClass $row Object database row

Since: 1.21

Definition at line 302 of file ArchivedFile.php.

References exists(), loadMetadataFromDbFieldValue(), and NS_FILE.

Referenced by load().

◆ loadMetadataFromDbFieldValue()

ArchivedFile::loadMetadataFromDbFieldValue	(	IReadableDatabase	$db,
			$metadataBlob )

protected

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

Since: 1.39

Parameters

IReadableDatabase	$db
string \| Blob	$metadataBlob

Definition at line 547 of file ArchivedFile.php.

References Wikimedia\Rdbms\IReadableDatabase\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 IReadableDatabase::decodeBlob().

Since: 1.37

Parameters

string $metadataString

Definition at line 558 of file ArchivedFile.php.

◆ 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 261 of file ArchivedFile.php.

References NS_FILE.

Referenced by MediaWiki\Api\ApiQueryFilearchive\execute().

◆ 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 644 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 767 of file ArchivedFile.php.

References getTitle().

Member Data Documentation

◆ $exists

bool ArchivedFile::$exists

protected

Definition at line 144 of file ArchivedFile.php.

◆ $extraDataLoaded

bool ArchivedFile::$extraDataLoaded = false

protected

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

Definition at line 84 of file ArchivedFile.php.

◆ $handler

MediaHandler ArchivedFile::$handler

protected

Definition at line 138 of file ArchivedFile.php.

◆ $metadataArray

array ArchivedFile::$metadataArray = []

protected

Unserialized metadata.

Definition at line 81 of file ArchivedFile.php.

◆ $metadataBlobs

string [] ArchivedFile::$metadataBlobs = []

protected

Map of metadata item name to blob address.

Definition at line 95 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 92 of file ArchivedFile.php.

◆ $title

Title null ArchivedFile::$title

protected

Definition at line 141 of file ArchivedFile.php.

Referenced by __construct().

◆ $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 103 of file ArchivedFile.php.

◆ FOR_PUBLIC

const ArchivedFile::FOR_PUBLIC = 1

Definition at line 40 of file ArchivedFile.php.

◆ FOR_THIS_USER

const ArchivedFile::FOR_THIS_USER = 2

Definition at line 41 of file ArchivedFile.php.

◆ RAW

const ArchivedFile::RAW = 3

Definition at line 42 of file ArchivedFile.php.

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

includes/filerepo/file/ArchivedFile.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ exists()

◆ getBits()

◆ getDescription()

◆ getGroup()

◆ getHeight()

◆ getID()

◆ getKey()

◆ getMediaType()

◆ getMetadata()

◆ getMetadataArray()

◆ getMetadataForDb()

◆ getMetadataItems()

◆ getMimeType()

◆ getName()

◆ getQueryInfo()

◆ getSha1()

◆ getSize()

◆ getStorageKey()

◆ getTimestamp()

◆ getTitle()

◆ getUploader()

◆ getVisibility()

◆ getWidth()

◆ isDeleted()

◆ load()

◆ loadFromRow()

◆ loadMetadataFromDbFieldValue()

◆ loadMetadataFromString()

◆ newFromRow()

◆ pageCount()

◆ userCan()

Member Data Documentation

◆ $exists

◆ $extraDataLoaded

◆ $handler

◆ $metadataArray

◆ $metadataBlobs

◆ $metadataSerializationFormat

◆ $title

◆ $unloadedMetadataBlobs

◆ FOR_PUBLIC

◆ FOR_THIS_USER

◆ RAW