ArchivedFile Class Reference

List of all members.

Public Member Functions

 ArchivedFile ($title, $id=0, $key='')
 #@-
 load ()
 Loads a file object from the filearchive table.
 getTitle ()
 Return the associated title object.
 getName ()
 Return the file name.
 getID ()
 getKey ()
 Return the FileStore key.
 getGroup ()
 Return the FileStore storage group.
 getWidth ()
 Return the width of the image.
 getHeight ()
 Return the height of the image.
 getMetadata ()
 Get handler-specific metadata.
 getSize ()
 Return the size of the image file, in bytes.
 getBits ()
 Return the bits of the image file, in bytes.
 getMimeType ()
 Returns the mime type of the file.
 getMediaType ()
 Return the type of the media in the file.
 getTimestamp ()
 Return upload timestamp.
 getUser ()
 Return the user ID of the uploader.
 getUserText ()
 Return the user name of the uploader.
 getDescription ()
 Return upload description.
 getRawUser ()
 Return the user ID of the uploader.
 getRawUserText ()
 Return the user name of the uploader.
 getRawDescription ()
 Return upload description.
 isDeleted ($field)
 int $field one of DELETED_* bitfield constants for file or revision rows
 userCan ($field)
 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

 $id
 #@+
 $title
 $name
 $group
 $key
 $size
 $bits
 $width
 $height
 $metadata
 $mime
 $media_type
 $description
 $user
 $user_text
 $timestamp
 $dataLoaded
 $deleted


Detailed Description

Definition at line 6 of file ArchivedFile.php.


Member Function Documentation

ArchivedFile::ArchivedFile ( title,
id = 0,
key = '' 
)

#@-

Definition at line 32 of file ArchivedFile.php.

References $id, $key, and $title.

Referenced by newFromRow().

ArchivedFile::getBits (  ) 

Return the bits of the image file, in bytes.

Access:
public

Definition at line 249 of file ArchivedFile.php.

References load().

ArchivedFile::getDescription (  ) 

Return upload description.

Definition at line 306 of file ArchivedFile.php.

References File::DELETED_COMMENT, isDeleted(), and load().

ArchivedFile::getGroup (  ) 

Return the FileStore storage group.

Definition at line 208 of file ArchivedFile.php.

References $file.

ArchivedFile::getHeight (  ) 

Return the height of the image.

Definition at line 223 of file ArchivedFile.php.

References load().

ArchivedFile::getID (  ) 

Definition at line 192 of file ArchivedFile.php.

References load().

ArchivedFile::getKey (  ) 

Return the FileStore key.

Definition at line 200 of file ArchivedFile.php.

References load().

ArchivedFile::getMediaType (  ) 

Return the type of the media in the file.

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

Definition at line 266 of file ArchivedFile.php.

References load().

ArchivedFile::getMetadata (  ) 

Get handler-specific metadata.

Definition at line 231 of file ArchivedFile.php.

References load().

ArchivedFile::getMimeType (  ) 

Returns the mime type of the file.

Definition at line 257 of file ArchivedFile.php.

References load().

ArchivedFile::getName (  ) 

Return the file name.

Definition at line 188 of file ArchivedFile.php.

ArchivedFile::getRawDescription (  ) 

Return upload description.

Definition at line 334 of file ArchivedFile.php.

References load().

ArchivedFile::getRawUser (  ) 

Return the user ID of the uploader.

Definition at line 318 of file ArchivedFile.php.

References load().

ArchivedFile::getRawUserText (  ) 

Return the user name of the uploader.

Definition at line 326 of file ArchivedFile.php.

References load().

ArchivedFile::getSize (  ) 

Return the size of the image file, in bytes.

Access:
public

Definition at line 240 of file ArchivedFile.php.

References load().

ArchivedFile::getTimestamp (  ) 

Return upload timestamp.

Definition at line 274 of file ArchivedFile.php.

References load(), and wfTimestamp().

ArchivedFile::getTitle (  ) 

Return the associated title object.

Access:
public

Definition at line 181 of file ArchivedFile.php.

ArchivedFile::getUser (  ) 

Return the user ID of the uploader.

Definition at line 282 of file ArchivedFile.php.

References File::DELETED_USER, isDeleted(), and load().

ArchivedFile::getUserText (  ) 

Return the user name of the uploader.

Definition at line 294 of file ArchivedFile.php.

References File::DELETED_USER, isDeleted(), and load().

ArchivedFile::getWidth (  ) 

Return the width of the image.

Definition at line 215 of file ArchivedFile.php.

References load().

ArchivedFile::isDeleted ( field  ) 

int $field one of DELETED_* bitfield constants for file or revision rows

Returns:
bool

Definition at line 344 of file ArchivedFile.php.

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

ArchivedFile::load (  ) 

static ArchivedFile::newFromRow ( row  )  [static]

Loads a file object from the filearchive table.

Returns:
ResultWrapper

Definition at line 153 of file ArchivedFile.php.

References $file, $row, ArchivedFile(), and Title::makeTitle().

Referenced by UndeleteForm::formatFileRow(), RevisionDeleter::setArchFileVisibility(), and SpecialRevisionDelete::showImages().

ArchivedFile::userCan ( field  ) 

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
Returns:
bool

Definition at line 354 of file ArchivedFile.php.

References $wgUser, File::DELETED_RESTRICTED, and wfDebug().


Member Data Documentation

ArchivedFile::$bits

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$dataLoaded

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$deleted

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$description

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$group

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$height

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$id

#@+

Access:
private

Definition at line 11 of file ArchivedFile.php.

Referenced by ArchivedFile().

ArchivedFile::$key

Definition at line 11 of file ArchivedFile.php.

Referenced by ArchivedFile().

ArchivedFile::$media_type

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$metadata

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$mime

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$name

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$size

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$timestamp

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$title

Definition at line 11 of file ArchivedFile.php.

Referenced by ArchivedFile().

ArchivedFile::$user

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$user_text

Definition at line 11 of file ArchivedFile.php.

ArchivedFile::$width

Definition at line 11 of file ArchivedFile.php.


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

Generated on Sat Sep 5 02:08:33 2009 for MediaWiki by  doxygen 1.5.9