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.
	getDescription ()
	Return upload description.
	getGroup ()
	Return the FileStore storage group.
	getHandler ()
	Get a MediaHandler instance for this file.
	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.
	getMimeType ()
	Returns the mime type of the file.
	getName ()
	Return the file name.
	getRawDescription ()
	Return upload description.
	getRawUser ()
	Return the user ID of the uploader.
	getRawUserText ()
	Return the user name of the uploader.
	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.
	getUser ()
	Return the user ID of the uploader.
	getUserText ()
	Return the user name of the uploader.
	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.
	pageCount ()
	Returns the number of pages of a multipage document, or false for documents which aren't multipage documents.
	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.
Static Public Member Functions
static	newFromRow ($row)
	Loads a file object from the filearchive table.
Public Attributes
	$archive_name
	$bits
	$dataLoaded
	$deleted
	$description
	$group
MediaHandler	$handler
	$height
	$id
	#@+
	$key
	$media_type
	$metadata
	$mime
	$name
	$pageCount
	$size
	$timestamp
Title	$title
	$user
	$user_text
	$width

Detailed Description

Class representing a row of the 'filearchive' table.

Definition at line 29 of file ArchivedFile.php.

Constructor & Destructor Documentation

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

#@-

Exceptions:

MWException

Parameters:

Title	$title
int	$id
string	$key

Definition at line 68 of file ArchivedFile.php.

Member Function Documentation

ArchivedFile::exists ( )

Returns:: bool

Definition at line 251 of file ArchivedFile.php.

ArchivedFile::getBits ( )

Return the bits of the image file, in bytes.

Returns:: int

Definition at line 321 of file ArchivedFile.php.

ArchivedFile::getDescription ( )

Return upload description.

Returns:: string

Definition at line 414 of file ArchivedFile.php.

ArchivedFile::getGroup ( )

Return the FileStore storage group.

Returns:: string

Definition at line 277 of file ArchivedFile.php.

ArchivedFile::getHandler ( )

Get a MediaHandler instance for this file.

Returns:: MediaHandler

Definition at line 339 of file ArchivedFile.php.

ArchivedFile::getHeight ( )

Return the height of the image.

Returns:: int

Definition at line 294 of file ArchivedFile.php.

ArchivedFile::getID ( )

Returns:: int

Definition at line 243 of file ArchivedFile.php.

ArchivedFile::getKey ( )

Return the FileStore key.

Returns:: string

Definition at line 260 of file ArchivedFile.php.

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

ArchivedFile::getMetadata ( )

Get handler-specific metadata.

Returns:: string

Definition at line 303 of file ArchivedFile.php.

ArchivedFile::getMimeType ( )

Returns the mime type of the file.

Returns:: string

Definition at line 330 of file ArchivedFile.php.

ArchivedFile::getName ( )

Return the file name.

Returns:: string

Definition at line 236 of file ArchivedFile.php.

ArchivedFile::getRawDescription ( )

Return upload description.

Returns:: string

Definition at line 448 of file ArchivedFile.php.

ArchivedFile::getRawUser ( )

Return the user ID of the uploader.

Returns:: int

Definition at line 428 of file ArchivedFile.php.

ArchivedFile::getRawUserText ( )

Return the user name of the uploader.

Returns:: string

Definition at line 438 of file ArchivedFile.php.

ArchivedFile::getSize ( )

Return the size of the image file, in bytes.

Returns:: int

Definition at line 312 of file ArchivedFile.php.

ArchivedFile::getStorageKey ( )

Return the FileStore key (overriding base File class)

Returns:: string

Definition at line 269 of file ArchivedFile.php.

ArchivedFile::getTimestamp ( )

Return upload timestamp.

Returns:: string

Definition at line 376 of file ArchivedFile.php.

ArchivedFile::getTitle ( )

Return the associated title object.

Returns:: Title

Definition at line 227 of file ArchivedFile.php.

ArchivedFile::getUser ( )

Return the user ID of the uploader.

Returns:: int

Definition at line 386 of file ArchivedFile.php.

ArchivedFile::getUserText ( )

Return the user name of the uploader.

Returns:: string

Definition at line 400 of file ArchivedFile.php.

ArchivedFile::getVisibility ( )

Returns the deletion bitfield.

Returns:: int

Definition at line 457 of file ArchivedFile.php.

ArchivedFile::getWidth ( )

Return the width of the image.

Returns:: int

Definition at line 285 of file ArchivedFile.php.

ArchivedFile::isDeleted ( $ field )

for file or revision rows

Parameters:

$field Integer: one of DELETED_* bitfield constants

Returns:: bool

Definition at line 468 of file ArchivedFile.php.

ArchivedFile::load ( )

Loads a file object from the filearchive table.

Returns:: bool|null True on success or null

Definition at line 111 of file ArchivedFile.php.

static ArchivedFile::newFromRow ( $ row ) [static]

Loads a file object from the filearchive table.

Parameters:

$row

Returns:: ArchivedFile

Definition at line 198 of file ArchivedFile.php.

Referenced by RevDel_ArchivedFileItem\__construct(), and ApiQueryFilearchive\execute().

ArchivedFile::pageCount ( )

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

Definition at line 350 of file ArchivedFile.php.

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:

$field	Integer
$user	User object to check, or null to use $wgUser

Returns:: bool

Definition at line 480 of file ArchivedFile.php.

Member Data Documentation

ArchivedFile::$archive_name

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$bits

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$dataLoaded

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$deleted

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$description

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$group

Definition at line 33 of file ArchivedFile.php.

MediaHandler ArchivedFile::$handler

Definition at line 55 of file ArchivedFile.php.

ArchivedFile::$height

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$id

#@+

Access:: private

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$key

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$media_type

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$metadata

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$mime

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$name

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$pageCount

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$size

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$timestamp

Definition at line 33 of file ArchivedFile.php.

Title ArchivedFile::$title

Definition at line 58 of file ArchivedFile.php.

ArchivedFile::$user

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$user_text

Definition at line 33 of file ArchivedFile.php.

ArchivedFile::$width

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation