Class to represent a local file in the wiki's own database. More...

Inheritance diagram for LocalFile:

Collaboration diagram for LocalFile:

Public Member Functions
	__construct ($title, $repo)
	Constructor.
	__destruct ()
	Clean up any dangling locks.
	decodeRow ($row, $prefix= 'img_')
	Decode a row from the database (either object or array) to an array with timestamps and MIME types decoded, and the field prefix removed.
	delete ($reason, $suppress=false, $user=null)
	Delete all versions of the file.
	deleteOld ($archiveName, $reason, $suppress=false, $user=null)
	Delete an old version of the file.
	exists ()
	canRender inherited
	getBitDepth ()
	getCacheFields ($prefix= 'img_')
	getCacheKey ()
	Get the memcached key for the main data for this file, or false if there is no access to the shared cache.
	getDescription ($audience=self::FOR_PUBLIC, User $user=null)
	getDescriptionText ($lang=null)
	Get the HTML text of the description page This is not used by ImagePage for local files, since (among other things) it skips the parser cache.
	getDescriptionUrl ()
	isMultipage inherited
	getHeight ($page=1)
	Return the height of the image.
	getHistory ($limit=null, $start=null, $end=null, $inc=true)
	purgeDescription inherited
	getLazyCacheFields ($prefix= 'img_')
	getMediaType ()
	Returns the type of the media in the file.
	getMetadata ()
	Get handler-specific metadata.
	getMimeType ()
	Returns the MIME type of the file.
	getSha1 ()
	getSize ()
	Returns the size of the image file, in bytes.
	getThumbnails ($archiveName=false)
	getTransformScript inherited
	getTimestamp ()
	getUpgraded ()
	getUser ($type= 'text')
	Returns ID or name of user who uploaded the file.
	getWidth ($page=1)
	Return the width of the image.
	isCacheable ()
	isMissing ()
	splitMime inherited
	load ($flags=0)
	Load file metadata from cache or DB, unless already loaded.
	loadFromCache ()
	Try to load file metadata from memcached.
	loadFromDB ($flags=0)
	Load file metadata from the DB.
	loadFromFile ()
	Load metadata from the file itself.
	loadFromRow ($row, $prefix= 'img_')
	Load file metadata from a DB result row.
	lock ()
	Start a transaction and lock the image for update Increments a reference counter if the lock is already held.
	maybeUpgradeRow ()
	Upgrade a row if it needs it.
	move ($target)
	getLinksTo inherited
	nextHistoryLine ()
	Returns the history of this file, line by line.
	publish ($srcPath, $flags=0, array $options=array())
	Move or copy a file to its public location.
	publishTo ($srcPath, $dstRel, $flags=0, array $options=array())
	Move or copy a file to a specified location.
	purgeCache ($options=array())
	Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid.
	purgeHistory ()
	Purge the shared history (OldLocalFile) cache.
	purgeMetadataCache ()
	Refresh metadata in memcached, but don't touch thumbnails or squid.
	purgeOldThumbnails ($archiveName)
	Delete cached transformed files for an archived version only.
	purgeThumbnails ($options=array())
	Delete cached transformed files for the current version only.
	recordUpload ($oldver, $desc, $license= '', $copyStatus= '', $source= '', $watch=false, $timestamp=false, User $user=null)
	Record a file upload in the upload log and the image table.
	recordUpload2 ($oldver, $comment, $pageText, $props=false, $timestamp=false, $user=null)
	Record a file upload in the upload log and the image table.
	resetHistory ()
	Reset the history pointer to the first element of the history.
	restore ($versions=array(), $unsuppress=false)
	Restore all or specified deleted revisions to the given file.
	saveToCache ()
	Save the file metadata to memcached.
	setProps ($info)
	Set properties in this object to be equal to those given in the associative array $info.
	unlock ()
	Decrement the lock reference count.
	unlockAndRollback ()
	Roll back the DB transaction and mark the image unlocked.
	upgradeRow ()
	Fix assorted version-related problems with the image row by reloading it from the file.
	upload ($srcPath, $comment, $pageText, $flags=0, $props=false, $timestamp=false, $user=null)
	getHashPath inherited
Static Public Member Functions
static	newFromKey ($sha1, $repo, $timestamp=false)
	Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class.
static	newFromRow ($row, $repo)
	Create a LocalFile from a title Do not call this except from inside a repo class.
static	newFromTitle ($title, $repo, $unused=null)
	Create a LocalFile from a title Do not call this except from inside a repo class.
static	selectFields ()
	Fields in the image table.
Public Attributes
const	CACHE_FIELD_MAX_LEN = 1000
const	LOAD_ALL = 1
const	LOAD_VIA_SLAVE = 2
const	VOLATILE_TTL = 300
Protected Member Functions
	isVolatile ()
	Check if a file is about to be changed or has been changed recently.
	loadExtraFromDB ()
	Load lazy file metadata from the DB.
	markVolatile ()
	Mark a file as about to be changed.
	purgeThumbList ($dir, $files)
	Delete a list of thumbnails visible at urls.
	readOnlyFatalStatus ()
	unprefixRow ($row, $prefix= 'img_')
Protected Attributes
int	$bits
	Returned by getimagesize (loadFromXxx) *.
bool	$dataLoaded
	Whether or not core data has been loaded from the database (loadFromXxx) *.
int	$deleted
	Bitfield akin to rev_deleted *.
bool	$extraDataLoaded
	Whether or not lazy-loaded data has been loaded from the database *.
bool	$fileExists
	Does the file exist on disk? (loadFromXxx) *.
int	$height
	Image height *.
string	$media_type
	MEDIATYPE_xxx (bitmap, drawing, audio...) *.
string	$metadata
	Handler-specific metadata *.
string	$mime
	MIME type, determined by MimeMagic::guessMimeType *.
string	$repoClass = 'LocalRepo'
	*
string	$sha1
	SHA-1 base 36 content hash *.
int	$size
	Size in bytes (loadFromXxx) *.
int	$width
	Image width *.
Private Member Functions
	loadFieldsWithTimestamp ($dbr, $fname)
Private Attributes
string	$description
	Description of current revision of the file *.
int	$historyLine
	Number of line to return by nextHistoryLine() (constructor) *.
int	$historyRes
	Result of the query for the file's history (nextHistoryLine) *.
int	$lastMarkedVolatile = 0
	UNIX timestamp of last markVolatile() call *.
bool	$locked
	True if the image row is locked *.
bool	$lockedOwnTrx
	True if the image row is locked with a lock initiated transaction *.
string	$major_mime
	Major MIME type *.
string	$minor_mime
	Minor MIME type *.
bool	$missing
	True if file is not present in file system.
string	$timestamp
	Upload timestamp *.
bool	$upgraded
	Whether the row was upgraded on load *.
int	$user
	User ID of uploader *.
string	$user_text
	User name of uploader *.

Detailed Description

Class to represent a local file in the wiki's own database.

Provides methods to retrieve paths (physical, logical, URL), to generate image thumbnails or for uploading.

Note that only the repo object knows what its file class is called. You should never name a file class explictly outside of the repo class. Instead use the repo's factory functions to generate file objects, for example:

RepoGroup::singleton()->getLocalRepo()->newFile( $title );

The convenience functions wfLocalFile() and wfFindFile() should be sufficient in most cases.

Definition at line 46 of file LocalFile.php.

Constructor & Destructor Documentation

LocalFile::__construct	(	$	title,
		$	repo
	)

Constructor.

Do not call this except from inside a repo class.

Parameters:

Title	$title
FileRepo	$repo

Reimplemented from File.

Definition at line 193 of file LocalFile.php.

LocalFile::__destruct ( )

Clean up any dangling locks.

Definition at line 1935 of file LocalFile.php.

Member Function Documentation

LocalFile::decodeRow	(	$	row,
		$	prefix = `'img_'`
	)

Decode a row from the database (either object or array) to an array with timestamps and MIME types decoded, and the field prefix removed.

Parameters:

object	$row
string	$prefix

Exceptions:

MWException

Returns:: array

Definition at line 469 of file LocalFile.php.

LocalFile::delete	(	$	reason,
		$	suppress = `false`,
		$	user = `null`
	)

Delete all versions of the file.

Moves the files into an archive directory (or deletes them) and removes the database rows.

Cache purging is done; logging is caller's responsibility.

Parameters:

string	$reason
bool	$suppress
User \| null	$user

Returns:: FileRepoStatus

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1603 of file LocalFile.php.

References name, and title.

LocalFile::deleteOld	(	$	archiveName,
		$	reason,
		$	suppress = `false`,
		$	user = `null`
	)

Delete an old version of the file.

Moves the file into an archive directory (or deletes it) and removes the database row.

Cache purging is done; logging is caller's responsibility.

Parameters:

string	$archiveName
string	$reason
bool	$suppress
User \| null	$user

Exceptions:

MWException Exception on database or file store failure

Returns:: FileRepoStatus

Definition at line 1662 of file LocalFile.php.

LocalFile::exists ( )

canRender inherited

mustRender inherited allowInlineDisplay inherited isSafeFile inherited isTrustedFile inherited Returns true if the file exists on disk.

Returns:: bool Whether file exist on disk.

Reimplemented from File.

Reimplemented in OldLocalFile.

Definition at line 792 of file LocalFile.php.

LocalFile::getBitDepth ( )

Returns:: int

Reimplemented from File.

Definition at line 745 of file LocalFile.php.

LocalFile::getCacheFields ( $ prefix = 'img_' )

Parameters:

string $prefix

Returns:: array

Reimplemented in OldLocalFile.

Definition at line 310 of file LocalFile.php.

References $cache.

LocalFile::getCacheKey ( )

Get the memcached key for the main data for this file, or false if there is no access to the shared cache.

Returns:: string|bool

Reimplemented in OldLocalFile.

Definition at line 211 of file LocalFile.php.

LocalFile::getDescription	(	$	audience = `self::FOR_PUBLIC`,
		User $	user = `null`
	)

Parameters:

int	$audience
User	$user

Returns:: string

Reimplemented from File.

Definition at line 1765 of file LocalFile.php.

LocalFile::getDescriptionText ( $ lang = null )

Get the HTML text of the description page This is not used by ImagePage for local files, since (among other things) it skips the parser cache.

Parameters:

Language $lang What language to get description in (Optional)

Returns:: bool|mixed

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1746 of file LocalFile.php.

LocalFile::getDescriptionUrl ( )

isMultipage inherited

pageCount inherited scaleHeight inherited getImageSize inherited Get the URL of the file description page.

Returns:: string

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1734 of file LocalFile.php.

LocalFile::getHeight ( $ page = 1 )

Return the height of the image.

Parameters:

int $page

Returns:: int

Reimplemented from File.

Definition at line 696 of file LocalFile.php.

LocalFile::getHistory	(	$	limit = `null`,
		$	start = `null`,
		$	end = `null`,
		$	inc = `true`
	)

purgeDescription inherited

purgeEverything inherited

Parameters:

int	$limit	Optional: Limit to number of results
int	$start	Optional: Timestamp, start from
int	$end	Optional: Timestamp, end at
bool	$inc

Returns:: array

Reimplemented from File.

Definition at line 987 of file LocalFile.php.

References File\getName().

LocalFile::getLazyCacheFields ( $ prefix = 'img_' )

Parameters:

string $prefix

Returns:: array

Definition at line 335 of file LocalFile.php.

LocalFile::getMediaType ( )

Returns the type of the media in the file.

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

Returns:: string

Reimplemented from File.

Definition at line 776 of file LocalFile.php.

References load().

LocalFile::getMetadata ( )

Get handler-specific metadata.

Returns:: string

Reimplemented from File.

Definition at line 737 of file LocalFile.php.

LocalFile::getMimeType ( )

Returns the MIME type of the file.

Returns:: string

Reimplemented from File.

Definition at line 765 of file LocalFile.php.

LocalFile::getSha1 ( )

Returns:: string

Reimplemented from File.

Definition at line 1790 of file LocalFile.php.

LocalFile::getSize ( )

Returns the size of the image file, in bytes.

Returns:: int

Reimplemented from File.

Definition at line 755 of file LocalFile.php.

LocalFile::getThumbnails ( $ archiveName = false )

getTransformScript inherited

getUnscaledThumb inherited thumbName inherited createThumb inherited transform inherited getHandler inherited iconThumb inherited getLastError inherited Get all thumbnail names previously generated for this file

Parameters:

string | bool $archiveName Name of an archive file, default false

Returns:: array First element is the base dir, then files in that base dir.

Definition at line 813 of file LocalFile.php.

LocalFile::getTimestamp ( )

Returns:: bool|string

Reimplemented from File.

Definition at line 1781 of file LocalFile.php.

LocalFile::getUpgraded ( )

Definition at line 556 of file LocalFile.php.

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

Returns ID or name of user who uploaded the file.

Parameters:

string $type 'text' or 'id'

Returns:: int|string

Reimplemented from File.

Definition at line 723 of file LocalFile.php.

LocalFile::getWidth ( $ page = 1 )

Return the width of the image.

Parameters:

int $page

Returns:: int

Reimplemented from File.

Definition at line 669 of file LocalFile.php.

LocalFile::isCacheable ( )

Returns:: bool Whether to cache in RepoGroup (this avoids OOMs)

Reimplemented from File.

Definition at line 1815 of file LocalFile.php.

LocalFile::isMissing ( )

splitMime inherited

getName inherited getTitle inherited getURL inherited getViewURL inherited getPath inherited isVisible inhereted

Returns:: bool

Reimplemented from File.

Definition at line 654 of file LocalFile.php.

LocalFile::isVolatile ( ) [protected]

Check if a file is about to be changed or has been changed recently.

See also:: LocalFile::isVolatile()

Returns:: bool Whether the file is volatile

Definition at line 1897 of file LocalFile.php.

References $key, $wgMemc, File\getName(), and global.

LocalFile::load ( $ flags = 0 )

Load file metadata from cache or DB, unless already loaded.

Parameters:

int $flags

Definition at line 515 of file LocalFile.php.

Referenced by getMediaType().

LocalFile::loadExtraFromDB ( ) [protected]

Load lazy file metadata from the DB.

This covers fields that are sometimes not cached.

Reimplemented in OldLocalFile.

Definition at line 387 of file LocalFile.php.

LocalFile::loadFieldsWithTimestamp	(	$	dbr,
		$	fname
	)		`[private]`

Parameters:

DatabaseBase	$dbr
string	$fname

Returns:: array|bool

Definition at line 417 of file LocalFile.php.

References $fname.

LocalFile::loadFromCache ( )

Try to load file metadata from memcached.

Returns true on success.

Returns:: bool

Definition at line 221 of file LocalFile.php.

LocalFile::loadFromDB ( $ flags = 0 )

Load file metadata from the DB.

Parameters:

int $flags

Reimplemented in OldLocalFile.

Definition at line 358 of file LocalFile.php.

LocalFile::loadFromFile ( )

Load metadata from the file itself.

Definition at line 301 of file LocalFile.php.

LocalFile::loadFromRow	(	$	row,
		$	prefix = `'img_'`
	)

Load file metadata from a DB result row.

Parameters:

object	$row
string	$prefix

Definition at line 497 of file LocalFile.php.

LocalFile::lock ( )

Start a transaction and lock the image for update Increments a reference counter if the lock is already held.

Exceptions:

MWException Throws an error if the lock was not acquired

Returns:: bool Success

Definition at line 1829 of file LocalFile.php.

LocalFile::markVolatile ( ) [protected]

Mark a file as about to be changed.

This sets a cache key that alters master/slave DB loading behavior

Returns:: bool Success

Definition at line 1879 of file LocalFile.php.

LocalFile::maybeUpgradeRow ( )

Upgrade a row if it needs it.

Definition at line 531 of file LocalFile.php.

LocalFile::move ( $ target )

getLinksTo inherited

getExifData inherited isLocal inherited wasDeleted inherited Move file to the new title

Move current, old version and all thumbnails to the new filename. Old file is deleted.

Cache purging is done; checks for validity and logging are caller's responsibility

Parameters:

Title $target New file name

Returns:: FileRepoStatus

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1548 of file LocalFile.php.

static LocalFile::newFromKey	(	$	sha1,
		$	repo,
		$	timestamp = `false`
	)		`[static]`

Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class.

Parameters:

string	$sha1	Base-36 SHA-1
LocalRepo	$repo
string \| bool	$timestamp	MW_timestamp (optional)

Returns:: bool|LocalFile

Reimplemented in OldLocalFile.

Definition at line 148 of file LocalFile.php.

static LocalFile::newFromRow	(	$	row,
		$	repo
	)		`[static]`

Create a LocalFile from a title Do not call this except from inside a repo class.

Parameters:

stdClass	$row
FileRepo	$repo

Returns:: LocalFile

Reimplemented in OldLocalFile, and ForeignDBFile.

Definition at line 131 of file LocalFile.php.

References File\$repo, and File\$title.

static LocalFile::newFromTitle	(	$	title,
		$	repo,
		$	unused = `null`
	)		`[static]`

Create a LocalFile from a title Do not call this except from inside a repo class.

Note: $unused param is only here to avoid an E_STRICT

Parameters:

Title	$title
FileRepo	$repo
null	$unused

Returns:: LocalFile

Reimplemented in OldLocalFile, and ForeignDBFile.

Definition at line 118 of file LocalFile.php.

LocalFile::nextHistoryLine ( )

Returns the history of this file, line by line.

starts with current version, then old versions. uses $this->historyLine to check which line to return: 0 return line for current version 1 query for old versions, return first one 2, ... return next old version from above query

Returns:: bool

Reimplemented from File.

Definition at line 1038 of file LocalFile.php.

LocalFile::publish	(	$	srcPath,
		$	flags = `0`,
		array $	options = `array()`
	)

Move or copy a file to its public location.

If a file exists at the destination, move it to an archive. Returns a FileRepoStatus object with the archive name in the "value" member on success.

The archive name should be passed through to recordUpload for database registration.

Parameters:

string	$srcPath	Local filesystem path to the source image
int	$flags	A bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
array	$options	Optional additional parameters

Returns:: FileRepoStatus On success, the value member contains the archive name, or an empty string if it was a new file.

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1489 of file LocalFile.php.

LocalFile::publishTo	(	$	srcPath,
		$	dstRel,
		$	flags = `0`,
		array $	options = `array()`
	)

Move or copy a file to a specified location.

Returns a FileRepoStatus object with the archive name in the "value" member on success.

The archive name should be passed through to recordUpload for database registration.

Parameters:

string	$srcPath	Local filesystem path to the source image
string	$dstRel	Target relative path
int	$flags	A bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
array	$options	Optional additional parameters

Returns:: FileRepoStatus On success, the value member contains the archive name, or an empty string if it was a new file.

Definition at line 1508 of file LocalFile.php.

LocalFile::purgeCache ( $ options = array() )

Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid.

Parameters:

array $options An array potentially with the key forThumbRefresh.

Note:: This used to purge old thumbnails by default as well, but doesn't anymore.

Reimplemented from File.

Definition at line 865 of file LocalFile.php.

LocalFile::purgeHistory ( )

Purge the shared history (OldLocalFile) cache.

Note:: This used to purge old thumbnails as well.

Definition at line 847 of file LocalFile.php.

LocalFile::purgeMetadataCache ( )

Refresh metadata in memcached, but don't touch thumbnails or squid.

Definition at line 836 of file LocalFile.php.

LocalFile::purgeOldThumbnails ( $ archiveName )

Delete cached transformed files for an archived version only.

Parameters:

string $archiveName Name of the archived file

Definition at line 882 of file LocalFile.php.

LocalFile::purgeThumbList	(	$	dir,
		$	files
	)		`[protected]`

Delete a list of thumbnails visible at urls.

Parameters:

string	$dir	Base dir of the files.
array	$files	Array of strings: relative filenames (to $dir)

Definition at line 953 of file LocalFile.php.

References $files, File\$handler, $options, MediaHandler\filterThumbnailPurgeList(), and File\getHandler().

LocalFile::purgeThumbnails ( $ options = array() )

Delete cached transformed files for the current version only.

Parameters:

array $options

Definition at line 911 of file LocalFile.php.

LocalFile::readOnlyFatalStatus ( ) [protected]

Returns:: Status

Definition at line 1927 of file LocalFile.php.

LocalFile::recordUpload	(	$	oldver,
		$	desc,
		$	license = `''`,
		$	copyStatus = `''`,
		$	source = `''`,
		$	watch = `false`,
		$	timestamp = `false`,
		User $	user = `null`
	)

Record a file upload in the upload log and the image table.

Parameters:

string	$oldver
string	$desc
string	$license
string	$copyStatus
string	$source
bool	$watch
string \| bool	$timestamp
User \| null	$user	User object or null to use $wgUser

Returns:: bool

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1180 of file LocalFile.php.

LocalFile::recordUpload2	(	$	oldver,
		$	comment,
		$	pageText,
		$	props = `false`,
		$	timestamp = `false`,
		$	user = `null`
	)

Record a file upload in the upload log and the image table.

Parameters:

string	$oldver
string	$comment
string	$pageText
bool \| array	$props
string \| bool	$timestamp
null \| User	$user

Returns:: bool

Definition at line 1210 of file LocalFile.php.

LocalFile::resetHistory ( )

Reset the history pointer to the first element of the history.

Reimplemented from File.

Definition at line 1076 of file LocalFile.php.

LocalFile::restore	(	$	versions = `array()`,
		$	unsuppress = `false`
	)

Restore all or specified deleted revisions to the given file.

Permissions and logging are left to the caller.

May throw database exceptions on error.

Parameters:

array	$versions	Set of record ids of deleted items to restore, or empty to restore all revisions.
bool	$unsuppress

Returns:: FileRepoStatus

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1700 of file LocalFile.php.

LocalFile::saveToCache ( )

Save the file metadata to memcached.

Definition at line 265 of file LocalFile.php.

static LocalFile::selectFields ( ) [static]

Fields in the image table.

Returns:: array

Reimplemented in OldLocalFile.

Definition at line 168 of file LocalFile.php.

Referenced by ApiQueryAllImages\run().

LocalFile::setProps ( $ info )

Set properties in this object to be equal to those given in the associative array $info.

Only cacheable fields can be set. All fields *must* be set in $info except for getLazyCacheFields().

If 'mime' is given, it will be split into major_mime/minor_mime. If major_mime/minor_mime are given, $this->mime will also be set.

Parameters:

array $info

Definition at line 623 of file LocalFile.php.

LocalFile::unlock ( )

Decrement the lock reference count.

If the reference count is reduced to zero, commits the transaction and thereby releases the image lock.

Definition at line 1861 of file LocalFile.php.

LocalFile::unlockAndRollback ( )

Roll back the DB transaction and mark the image unlocked.

Definition at line 1917 of file LocalFile.php.

LocalFile::unprefixRow	(	$	row,
		$	prefix = `'img_'`
	)		`[protected]`

Parameters:

array	$row	Row
string	$prefix

Exceptions:

MWException

Returns:: array

Definition at line 444 of file LocalFile.php.

LocalFile::upgradeRow ( )

Fix assorted version-related problems with the image row by reloading it from the file.

Reimplemented from File.

Reimplemented in OldLocalFile.

Definition at line 563 of file LocalFile.php.

LocalFile::upload	(	$	srcPath,
		$	comment,
		$	pageText,
		$	flags = `0`,
		$	props = `false`,
		$	timestamp = `false`,
		$	user = `null`
	)

getHashPath inherited

getRel inherited getUrlRel inherited getArchiveRel inherited getArchivePath inherited getThumbPath inherited getArchiveUrl inherited getThumbUrl inherited getArchiveVirtualUrl inherited getThumbVirtualUrl inherited isHashed inherited Upload a file and record it in the DB

Parameters:

string	$srcPath	Source storage path, virtual URL, or filesystem path
string	$comment	Upload description
string	$pageText	Text to use for the new description page, if a new description page is created
int \| bool	$flags	Flags for publish()
array \| bool	$props	File properties, if known. This can be used to reduce the upload time when uploading virtual URLs for which the file info is already known
string \| bool	$timestamp	Timestamp for img_timestamp, or false to use the current time
User \| null	$user	User object or null to use $wgUser

Returns:: FileRepoStatus On success, the value member contains the archive name, or an empty string if it was a new file.

Definition at line 1113 of file LocalFile.php.

Member Data Documentation

int LocalFile::$bits [protected]

Returned by getimagesize (loadFromXxx) *.

Definition at line 55 of file LocalFile.php.

bool LocalFile::$dataLoaded [protected]

Whether or not core data has been loaded from the database (loadFromXxx) *.

Definition at line 67 of file LocalFile.php.

int LocalFile::$deleted [protected]

Bitfield akin to rev_deleted *.

Definition at line 71 of file LocalFile.php.

string LocalFile::$description [private]

Description of current revision of the file *.

Definition at line 89 of file LocalFile.php.

bool LocalFile::$extraDataLoaded [protected]

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

Definition at line 69 of file LocalFile.php.

bool LocalFile::$fileExists [protected]

Does the file exist on disk? (loadFromXxx) *.

Definition at line 49 of file LocalFile.php.

int LocalFile::$height [protected]

Image height *.

Definition at line 53 of file LocalFile.php.

int LocalFile::$historyLine [private]

Number of line to return by nextHistoryLine() (constructor) *.

Definition at line 75 of file LocalFile.php.

int LocalFile::$historyRes [private]

Result of the query for the file's history (nextHistoryLine) *.

Definition at line 77 of file LocalFile.php.

int LocalFile::$lastMarkedVolatile = 0 [private]

UNIX timestamp of last markVolatile() call *.

Definition at line 99 of file LocalFile.php.

bool LocalFile::$locked [private]

True if the image row is locked *.

Definition at line 93 of file LocalFile.php.

bool LocalFile::$lockedOwnTrx [private]

True if the image row is locked with a lock initiated transaction *.

Definition at line 95 of file LocalFile.php.

string LocalFile::$major_mime [private]

Major MIME type *.

Definition at line 79 of file LocalFile.php.

string LocalFile::$media_type [protected]

MEDIATYPE_xxx (bitmap, drawing, audio...) *.

Definition at line 57 of file LocalFile.php.

string LocalFile::$metadata [protected]

Handler-specific metadata *.

Definition at line 63 of file LocalFile.php.

string LocalFile::$mime [protected]

MIME type, determined by MimeMagic::guessMimeType *.

Definition at line 59 of file LocalFile.php.

string LocalFile::$minor_mime [private]

Minor MIME type *.

Definition at line 81 of file LocalFile.php.

bool LocalFile::$missing [private]

True if file is not present in file system.

Not to be cached in memcached *

Definition at line 97 of file LocalFile.php.

string LocalFile::$repoClass = 'LocalRepo' [protected]

*

Reimplemented from File.

Definition at line 73 of file LocalFile.php.

string LocalFile::$sha1 [protected]

SHA-1 base 36 content hash *.

Definition at line 65 of file LocalFile.php.

int LocalFile::$size [protected]

Size in bytes (loadFromXxx) *.

Definition at line 61 of file LocalFile.php.

string LocalFile::$timestamp [private]

Upload timestamp *.

Definition at line 83 of file LocalFile.php.

bool LocalFile::$upgraded [private]

Whether the row was upgraded on load *.

Definition at line 91 of file LocalFile.php.

int LocalFile::$user [private]

User ID of uploader *.

Definition at line 85 of file LocalFile.php.

string LocalFile::$user_text [private]

User name of uploader *.

Definition at line 87 of file LocalFile.php.

int LocalFile::$width [protected]

Image width *.

Definition at line 51 of file LocalFile.php.

const LocalFile::CACHE_FIELD_MAX_LEN = 1000

Definition at line 47 of file LocalFile.php.

const LocalFile::LOAD_ALL = 1

Definition at line 101 of file LocalFile.php.

const LocalFile::LOAD_VIA_SLAVE = 2

Definition at line 102 of file LocalFile.php.

const LocalFile::VOLATILE_TTL = 300

Definition at line 104 of file LocalFile.php.

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

includes/filerepo/file/LocalFile.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation