Inheritance diagram for UploadStashFile:

Collaboration diagram for UploadStashFile:

Public Member Functions
	__construct ($repo, $path, $key)
	A LocalFile wrapper around a file that has been temporarily stashed, so we can do things like create thumbnails for it Arguably UnregisteredLocalFile should be handling its own file repo but that class is a bit retarded currently.
	exists ()
	Returns true if file exists in the repository.
	getDescriptionUrl ()
	A method needed by the file transforming and scaling routines in File.php We do not necessarily care about doing the description at this point However, we also can't return the empty string, as the rest of MediaWiki demands this (and calls to imagemagick convert require it to be there)
	getFileKey ()
	Getter for file key (the unique id by which this file's location & metadata is stored in the db)
	getFullUrl ()
	Parent classes use this method, for no obvious reason, to return the path (relative to wiki root, I assume).
	getThumbPath ($thumbName=false)
	Get the path for the thumbnail (actually any transformation of this file) The actual argument is the result of thumbName although we seem to have buggy code elsewhere that expects a boolean 'suffix'.
	getThumbUrl ($thumbName=false)
	Get a URL to access the thumbnail This is required because the model of how files work requires that the thumbnail urls be predictable.
	getUrl ()
	Return the URL of the file, if for some reason we wanted to download it We tend not to do this for the original file, but we do want thumb icons.
	getUrlName ()
	The basename for the URL, which we want to not be related to the filename.
	remove ()
	Remove the associated temporary file.
	thumbName ($params, $flags=0)
	Return the file/url base name of a thumbnail with the specified parameters.
Protected Attributes
	$url
Private Member Functions
	getSpecialUrl ($subPage)
	Helper function -- given a 'subpage', return the local URL e.g.
Private Attributes
	$fileKey
	$urlName

Detailed Description

Definition at line 506 of file UploadStash.php.

Constructor & Destructor Documentation

UploadStashFile::__construct	(	$	repo,
		$	path,
		$	key
	)

A LocalFile wrapper around a file that has been temporarily stashed, so we can do things like create thumbnails for it Arguably UnregisteredLocalFile should be handling its own file repo but that class is a bit retarded currently.

Parameters:

	$repo	FileRepo: repository where we should find the path
string	$path	path to file
string	$key	key to store the path and any stashed data under

Exceptions:

UploadStashBadPathException
UploadStashFileNotFoundException

Definition at line 521 of file UploadStash.php.

Member Function Documentation

UploadStashFile::exists ( )

Returns true if file exists in the repository.

Overridden by LocalFile to avoid unnecessary stat calls.

Returns:: boolean Whether file exists in the repository.

Reimplemented from File.

Definition at line 671 of file UploadStash.php.

UploadStashFile::getDescriptionUrl ( )

A method needed by the file transforming and scaling routines in File.php We do not necessarily care about doing the description at this point However, we also can't return the empty string, as the rest of MediaWiki demands this (and calls to imagemagick convert require it to be there)

Returns:: String: dummy value

Reimplemented from File.

Definition at line 557 of file UploadStash.php.

UploadStashFile::getFileKey ( )

Getter for file key (the unique id by which this file's location & metadata is stored in the db)

Returns:: String: file key

Definition at line 654 of file UploadStash.php.

UploadStashFile::getFullUrl ( )

Parent classes use this method, for no obvious reason, to return the path (relative to wiki root, I assume).

But with this class, the URL is unrelated to the path.

Returns:: String: url

Reimplemented from File.

Definition at line 645 of file UploadStash.php.

UploadStashFile::getSpecialUrl ( $ subPage ) [private]

Helper function -- given a 'subpage', return the local URL e.g.

/wiki/Special:UploadStash/subpage

Parameters:

$subPage String

Returns:: String: local URL for this subpage in the Special:UploadStash space.

Definition at line 595 of file UploadStash.php.

UploadStashFile::getThumbPath ( $ thumbName = false )

Get the path for the thumbnail (actually any transformation of this file) The actual argument is the result of thumbName although we seem to have buggy code elsewhere that expects a boolean 'suffix'.

Parameters:

string $thumbName name of thumbnail (e.g. "120px-123456.jpg" ), or false to just get the path

Returns:: String: path thumbnail should take on filesystem, or containing directory if thumbname is false

Reimplemented from File.

Definition at line 569 of file UploadStash.php.

UploadStashFile::getThumbUrl ( $ thumbName = false )

Get a URL to access the thumbnail This is required because the model of how files work requires that the thumbnail urls be predictable.

However, in our model the URL is not based on the filename (that's hidden in the db)

Parameters:

string $thumbName basename of thumbnail file -- however, we don't want to use the file exactly

Returns:: String: URL to access thumbnail, or URL with partial path

Reimplemented from File.

Definition at line 608 of file UploadStash.php.

UploadStashFile::getUrl ( )

Return the URL of the file, if for some reason we wanted to download it We tend not to do this for the original file, but we do want thumb icons.

Returns:: String: url

Reimplemented from File.

Definition at line 632 of file UploadStash.php.

UploadStashFile::getUrlName ( )

The basename for the URL, which we want to not be related to the filename.

Will also be used as the lookup key for a thumbnail file.

Returns:: String: base url name, like '120px-123456.jpg'

Definition at line 619 of file UploadStash.php.

UploadStashFile::remove ( )

Remove the associated temporary file.

Returns:: Status: success

Definition at line 662 of file UploadStash.php.

UploadStashFile::thumbName	(	$	params,
		$	flags = `0`
	)

Return the file/url base name of a thumbnail with the specified parameters.

We override this because we want to use the pretty url name instead of the ugly file name.

Parameters:

array	$params	handler-specific parameters
	$flags	integer Bitfield that supports THUMB_* constants

Returns:: String: base name for URL, like '120px-12345.jpg', or null if there is no handler

Reimplemented from File.

Definition at line 586 of file UploadStash.php.

Member Data Documentation

UploadStashFile::$fileKey [private]

Definition at line 507 of file UploadStash.php.

UploadStashFile::$url [protected]

Reimplemented from File.

Definition at line 509 of file UploadStash.php.

UploadStashFile::$urlName [private]

Definition at line 508 of file UploadStash.php.

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

includes/upload/UploadStash.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation