MediaWiki  1.23.12
ArchivedFile Class Reference

Class representing a row of the 'filearchive' table. More...

Collaboration diagram for ArchivedFile:

Public Member Functions

 __construct ( $title, $id=0, $key='')
 
 exists ()
 
 getBits ()
 Return the bits of the image file, in bytes. More...
 
 getDescription ()
 Return upload description. More...
 
 getGroup ()
 Return the FileStore storage group. More...
 
 getHandler ()
 Get a MediaHandler instance for this file. 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. More...
 
 getMimeType ()
 Returns the mime type of the file. More...
 
 getName ()
 Return the file name. More...
 
 getRawDescription ()
 Return upload description. More...
 
 getRawUser ()
 Return the user ID of the uploader. More...
 
 getRawUserText ()
 Return the user name of the uploader. 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...
 
 getUser ( $type='text')
 Returns ID or name of user who uploaded the file. More...
 
 getUserText ()
 Return the user name of the uploader. More...
 
 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, User $user=null)
 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 newFromRow ( $row)
 Loads a file object from the filearchive table. More...
 
static selectFields ()
 Fields in the filearchive table. More...
 

Protected Attributes

MediaHandler $handler
 
Title $title
 

Private Attributes

string $archive_name
 Original base filename *. More...
 
int $bits
 size in bytes * More...
 
bool $dataLoaded
 Whether or not all this has been loaded from the database (loadFromXxx) *. More...
 
int $deleted
 Bitfield akin to rev_deleted *. More...
 
string $description
 Upload description *. More...
 
string $group
 FileStore storage group *. More...
 
int $height
 Height *. More...
 
int $id
 filearchive row ID * More...
 
string $key
 FileStore SHA-1 key *. More...
 
string $media_type
 Media type *. More...
 
string $metadata
 Metadata string *. More...
 
string $mime
 MIME type *. More...
 
string $name
 File name *. More...
 
string $pageCount
 Number of pages of a multipage document, or false for documents which aren't multipage documents. More...
 
string $sha1
 SHA-1 hash of file content *. More...
 
int $size
 File size in bytes *. More...
 
string $timestamp
 Time of upload *. More...
 
int $user
 User ID of uploader *. More...
 
string $user_text
 User name of uploader *. More...
 
int $width
 Width *. More...
 

Detailed Description

Class representing a row of the 'filearchive' table.

Definition at line 29 of file ArchivedFile.php.

Constructor & Destructor Documentation

◆ __construct()

ArchivedFile::__construct (   $title,
  $id = 0,
  $key = '' 
)
Exceptions
MWException
Parameters
Title$title
int$id
string$key

Definition at line 82 of file ArchivedFile.php.

References $id, $key, $title, exists(), Title\getDBkey(), key, name, File\normalizeTitle(), title, and user.

Member Function Documentation

◆ exists()

ArchivedFile::exists ( )
Returns
bool

Definition at line 277 of file ArchivedFile.php.

References load().

Referenced by __construct(), and load().

◆ getBits()

ArchivedFile::getBits ( )

Return the bits of the image file, in bytes.

Returns
int

Definition at line 353 of file ArchivedFile.php.

References $bits, and load().

◆ getDescription()

ArchivedFile::getDescription ( )

Return upload description.

Returns
string

Definition at line 474 of file ArchivedFile.php.

References $description, File\DELETED_COMMENT, isDeleted(), and load().

◆ getGroup()

ArchivedFile::getGroup ( )

Return the FileStore storage group.

Returns
string

Definition at line 305 of file ArchivedFile.php.

References $group.

◆ getHandler()

ArchivedFile::getHandler ( )

Get a MediaHandler instance for this file.

Returns
MediaHandler

Definition at line 373 of file ArchivedFile.php.

References $handler, MediaHandler\getHandler(), and getMimeType().

Referenced by pageCount().

◆ getHeight()

ArchivedFile::getHeight ( )

Return the height of the image.

Returns
int

Definition at line 323 of file ArchivedFile.php.

References $height, and load().

◆ getID()

ArchivedFile::getID ( )
Returns
int

Definition at line 268 of file ArchivedFile.php.

References $id, and load().

◆ getKey()

ArchivedFile::getKey ( )

Return the FileStore key.

Returns
string

Definition at line 287 of file ArchivedFile.php.

References $key, and 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 402 of file ArchivedFile.php.

References $media_type, and load().

◆ getMetadata()

ArchivedFile::getMetadata ( )

Get handler-specific metadata.

Returns
string

Definition at line 333 of file ArchivedFile.php.

References $metadata, and load().

◆ getMimeType()

ArchivedFile::getMimeType ( )

Returns the mime type of the file.

Returns
string

Definition at line 363 of file ArchivedFile.php.

References $mime, and load().

Referenced by getHandler().

◆ getName()

ArchivedFile::getName ( )

Return the file name.

Returns
string

Definition at line 261 of file ArchivedFile.php.

References $name.

Referenced by EraseArchivedFile\scrubVersion().

◆ getRawDescription()

ArchivedFile::getRawDescription ( )

Return upload description.

Returns
string

Definition at line 510 of file ArchivedFile.php.

References $description, and load().

◆ getRawUser()

ArchivedFile::getRawUser ( )

Return the user ID of the uploader.

Returns
int

Definition at line 488 of file ArchivedFile.php.

References $user, and load().

◆ getRawUserText()

ArchivedFile::getRawUserText ( )

Return the user name of the uploader.

Returns
string

Definition at line 499 of file ArchivedFile.php.

References $user_text, and load().

◆ getSha1()

ArchivedFile::getSha1 ( )

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

Returns
string
Since
1.21

Definition at line 425 of file ArchivedFile.php.

References $sha1, and load().

◆ getSize()

ArchivedFile::getSize ( )

Return the size of the image file, in bytes.

Returns
int

Definition at line 343 of file ArchivedFile.php.

References $size, and load().

◆ getStorageKey()

ArchivedFile::getStorageKey ( )

Return the FileStore key (overriding base File class)

Returns
string

Definition at line 297 of file ArchivedFile.php.

References getKey().

Referenced by EraseArchivedFile\scrubVersion().

◆ getTimestamp()

ArchivedFile::getTimestamp ( )

Return upload timestamp.

Returns
string

Definition at line 413 of file ArchivedFile.php.

References load(), TS_MW, and wfTimestamp().

Referenced by EraseArchivedFile\scrubVersion().

◆ getTitle()

ArchivedFile::getTitle ( )

Return the associated title object.

Returns
Title

Definition at line 252 of file ArchivedFile.php.

References $title.

◆ getUser()

ArchivedFile::getUser (   $type = 'text')

Returns ID or name of user who uploaded the file.

Note
Prior to MediaWiki 1.23, this method always returned the user id, and was inconsistent with the rest of the file classes.
Parameters
string$type'text' or 'id'
Returns
int|string
Exceptions
MWException

Definition at line 441 of file ArchivedFile.php.

References $type, $user, $user_text, and load().

◆ getUserText()

ArchivedFile::getUserText ( )

Return the user name of the uploader.

Deprecated:
1.23 Use getUser( 'text' ) instead.
Returns
string

Definition at line 459 of file ArchivedFile.php.

References $user_text, File\DELETED_USER, isDeleted(), load(), and wfDeprecated().

◆ getVisibility()

ArchivedFile::getVisibility ( )

Returns the deletion bitfield.

Returns
int

Definition at line 520 of file ArchivedFile.php.

References $deleted, and load().

◆ getWidth()

ArchivedFile::getWidth ( )

Return the width of the image.

Returns
int

Definition at line 313 of file ArchivedFile.php.

References $width, and load().

◆ isDeleted()

ArchivedFile::isDeleted (   $field)

for file or revision rows

Parameters
int$fieldOne of DELETED_* bitfield constants
Returns
bool

Definition at line 532 of file ArchivedFile.php.

References load().

Referenced by getDescription(), and getUserText().

◆ load()

ArchivedFile::load ( )

◆ loadFromRow()

ArchivedFile::loadFromRow (   $row)

Load ArchivedFile object fields from a DB row.

Parameters
stdClass$rowObject database row
Since
1.21

Definition at line 221 of file ArchivedFile.php.

References LocalRepo\getHashFromKey(), key, name, and user.

Referenced by load().

◆ newFromRow()

static ArchivedFile::newFromRow (   $row)
static

Loads a file object from the filearchive table.

Parameters
stdClass$row
Returns
ArchivedFile

Definition at line 179 of file ArchivedFile.php.

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

Referenced by RevDel_ArchivedFileItem\__construct(), ApiQueryFilearchive\execute(), EraseArchivedFile\execute(), SpecialUndelete\formatFileRow(), and EraseArchivedFile\scrubAllVersions().

◆ pageCount()

ArchivedFile::pageCount ( )

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

Definition at line 385 of file ArchivedFile.php.

References $pageCount, and getHandler().

◆ selectFields()

static ArchivedFile::selectFields ( )
static

Fields in the filearchive table.

Returns
array

Definition at line 190 of file ArchivedFile.php.

References array().

Referenced by RevDel_ArchivedFileList\doQuery(), ApiQueryFilearchive\execute(), LocalFileRestoreBatch\execute(), and PageArchive\listFiles().

◆ userCan()

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

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
null | User$userUser object to check, or null to use $wgUser
Returns
bool

Definition at line 545 of file ArchivedFile.php.

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

Member Data Documentation

◆ $archive_name

string ArchivedFile::$archive_name
private

Original base filename *.

Definition at line 70 of file ArchivedFile.php.

◆ $bits

int ArchivedFile::$bits
private

size in bytes *

Definition at line 40 of file ArchivedFile.php.

Referenced by getBits().

◆ $dataLoaded

bool ArchivedFile::$dataLoaded
private

Whether or not all this has been loaded from the database (loadFromXxx) *.

Definition at line 60 of file ArchivedFile.php.

◆ $deleted

int ArchivedFile::$deleted
private

Bitfield akin to rev_deleted *.

Definition at line 62 of file ArchivedFile.php.

Referenced by getVisibility().

◆ $description

string ArchivedFile::$description
private

Upload description *.

Definition at line 52 of file ArchivedFile.php.

Referenced by getDescription(), and getRawDescription().

◆ $group

string ArchivedFile::$group
private

FileStore storage group *.

Definition at line 34 of file ArchivedFile.php.

Referenced by getGroup(), and load().

◆ $handler

MediaHandler ArchivedFile::$handler
protected

Definition at line 72 of file ArchivedFile.php.

Referenced by getHandler().

◆ $height

int ArchivedFile::$height
private

Height *.

Definition at line 44 of file ArchivedFile.php.

Referenced by getHeight().

◆ $id

int ArchivedFile::$id
private

filearchive row ID *

Definition at line 30 of file ArchivedFile.php.

Referenced by __construct(), getID(), and load().

◆ $key

string ArchivedFile::$key
private

FileStore SHA-1 key *.

Definition at line 36 of file ArchivedFile.php.

Referenced by __construct(), getKey(), and load().

◆ $media_type

string ArchivedFile::$media_type
private

Media type *.

Definition at line 50 of file ArchivedFile.php.

Referenced by getMediaType().

◆ $metadata

string ArchivedFile::$metadata
private

Metadata string *.

Definition at line 46 of file ArchivedFile.php.

Referenced by getMetadata().

◆ $mime

string ArchivedFile::$mime
private

MIME type *.

Definition at line 48 of file ArchivedFile.php.

Referenced by getMimeType().

◆ $name

string ArchivedFile::$name
private

File name *.

Definition at line 32 of file ArchivedFile.php.

Referenced by getName().

◆ $pageCount

string ArchivedFile::$pageCount
private

Number of pages of a multipage document, or false for documents which aren't multipage documents.

Definition at line 68 of file ArchivedFile.php.

Referenced by pageCount().

◆ $sha1

string ArchivedFile::$sha1
private

SHA-1 hash of file content *.

Definition at line 64 of file ArchivedFile.php.

Referenced by getSha1().

◆ $size

int ArchivedFile::$size
private

File size in bytes *.

Definition at line 38 of file ArchivedFile.php.

Referenced by getSize().

◆ $timestamp

string ArchivedFile::$timestamp
private

Time of upload *.

Definition at line 58 of file ArchivedFile.php.

◆ $title

Title ArchivedFile::$title
protected

Definition at line 74 of file ArchivedFile.php.

Referenced by __construct(), and getTitle().

◆ $user

int ArchivedFile::$user
private

User ID of uploader *.

Definition at line 54 of file ArchivedFile.php.

Referenced by getRawUser(), getUser(), and userCan().

◆ $user_text

string ArchivedFile::$user_text
private

User name of uploader *.

Definition at line 56 of file ArchivedFile.php.

Referenced by getRawUserText(), getUser(), and getUserText().

◆ $width

int ArchivedFile::$width
private

Width *.

Definition at line 42 of file ArchivedFile.php.

Referenced by getWidth().


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