[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/filerepo/file/ -> ArchivedFile.php (summary)

Deleted file in the 'filearchive' table. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 584 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ArchivedFile:: (32 methods):
  __construct()
  load()
  newFromRow()
  selectFields()
  loadFromRow()
  getTitle()
  getName()
  getID()
  exists()
  getKey()
  getStorageKey()
  getGroup()
  getWidth()
  getHeight()
  getMetadata()
  getSize()
  getBits()
  getMimeType()
  getHandler()
  pageCount()
  getMediaType()
  getTimestamp()
  getSha1()
  getUser()
  getUserText()
  getDescription()
  getRawUser()
  getRawUserText()
  getRawDescription()
  getVisibility()
  isDeleted()
  userCan()


Class: ArchivedFile  - X-Ref

Class representing a row of the 'filearchive' table

__construct( $title, $id = 0, $key = '' )   X-Ref

param: Title $title
param: int $id
param: string $key

load()   X-Ref
Loads a file object from the filearchive table

return: bool|null True on success or null

newFromRow( $row )   X-Ref
Loads a file object from the filearchive table

param: stdClass $row
return: ArchivedFile

selectFields()   X-Ref
Fields in the filearchive table

return: array

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

param: stdClass $row Object database row

getTitle()   X-Ref
Return the associated title object

return: Title

getName()   X-Ref
Return the file name

return: string

getID()   X-Ref

return: int

exists()   X-Ref

return: bool

getKey()   X-Ref
Return the FileStore key

return: string

getStorageKey()   X-Ref
Return the FileStore key (overriding base File class)

return: string

getGroup()   X-Ref
Return the FileStore storage group

return: string

getWidth()   X-Ref
Return the width of the image

return: int

getHeight()   X-Ref
Return the height of the image

return: int

getMetadata()   X-Ref
Get handler-specific metadata

return: string

getSize()   X-Ref
Return the size of the image file, in bytes

return: int

getBits()   X-Ref
Return the bits of the image file, in bytes

return: int

getMimeType()   X-Ref
Returns the MIME type of the file.

return: string

getHandler()   X-Ref
Get a MediaHandler instance for this file

return: MediaHandler

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

return: bool|int

getMediaType()   X-Ref
Return the type of the media in the file.
Use the value returned by this function with the MEDIATYPE_xxx constants.

return: string

getTimestamp()   X-Ref
Return upload timestamp.

return: string

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

return: string

getUser( $type = 'text' )   X-Ref
Returns ID or name of user who uploaded the file

param: string $type 'text' or 'id'
return: int|string

getUserText()   X-Ref
Return the user name of the uploader.

return: string

getDescription()   X-Ref
Return upload description.

return: string

getRawUser()   X-Ref
Return the user ID of the uploader.

return: int

getRawUserText()   X-Ref
Return the user name of the uploader.

return: string

getRawDescription()   X-Ref
Return upload description.

return: string

getVisibility()   X-Ref
Returns the deletion bitfield

return: int

isDeleted( $field )   X-Ref
for file or revision rows

param: int $field One of DELETED_* bitfield constants
return: bool

userCan( $field, User $user = null )   X-Ref
Determine if the current user is allowed to view a particular
field of this FileStore image file, if it's marked as deleted.

param: int $field
param: null|User $user User object to check, or null to use $wgUser
return: bool



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1