UploadFromStash Class Reference

Implements uploading from previously stored file. More...

Inheritance diagram for UploadFromStash:

Collaboration diagram for UploadFromStash:

List of all members.

Public Member Functions
	__construct ($user=false, $stash=false, $repo=false)
	getSourceType ()
	initialize ($key, $name= 'upload_file')
	initializeFromRequest (&$request)
	performUpload ($comment, $pageText, $watch, $user)
	Perform the upload, then remove the database record afterward.
	stashFile ()
	Stash the file.
	stashSession ()
	This should return the key instead of the UploadStashFile instance, for backward compatibility.
	unsaveUploadedFile ()
	Remove a temporarily kept file stashed by saveTempUploadedFile().
Static Public Member Functions
static	isValidKey ($key)
static	isValidRequest ($request)
Public Attributes
	$mFileProps
	$mSourceType
	$mVirtualTempPath
Protected Attributes
	$mFileKey
Private Attributes
	$repo
	$stash

---

Detailed Description

Implements uploading from previously stored file.

Author:

Bryan Tong Minh

Definition at line 30 of file UploadFromStash.php.

---

Constructor & Destructor Documentation

UploadFromStash::__construct	(	$	user = false,
		$	stash = false,
		$	repo = false
	)

Parameters:

$user	User
$stash	UploadStash
$repo	FileRepo

Definition at line 44 of file UploadFromStash.php.

References $repo, $stash, $user, RepoGroup\singleton(), and wfDebug().

---

Member Function Documentation

UploadFromStash::getSourceType

(

)

Returns:

string

Reimplemented from UploadBase.

Definition at line 128 of file UploadFromStash.php.

UploadFromStash::initialize	(	$	key,
		$	name = 'upload_file'
	)

Parameters:

$key	string
$name	string

Definition at line 92 of file UploadFromStash.php.

References UploadBase\getRealPath(), and UploadBase\initializePathInfo().

Referenced by initializeFromRequest().

UploadFromStash::initializeFromRequest

(

&$

request

)

Parameters:

$request

WebRequest

Reimplemented from UploadBase.

Definition at line 115 of file UploadFromStash.php.

References initialize().

static UploadFromStash::isValidKey

(

$

key

)

[static]

Parameters:

$key

string

Returns:

bool

Definition at line 71 of file UploadFromStash.php.

References UploadStash\KEY_FORMAT_REGEX.

Referenced by isValidRequest().

static UploadFromStash::isValidRequest

(

$

request

)

[static]

Parameters:

$request

WebRequest

Returns:

Boolean

Reimplemented from UploadBase.

Definition at line 81 of file UploadFromStash.php.

References isValidKey().

Referenced by UploadStashTest\testValidRequest().

UploadFromStash::performUpload	(	$	comment,
		$	pageText,
		$	watch,
		$	user
	)

Perform the upload, then remove the database record afterward.

Parameters:

$comment	string
$pageText	string
$watch	bool
$user	User

Returns:

Status

Reimplemented from UploadBase.

Definition at line 172 of file UploadFromStash.php.

References $comment, $user, and unsaveUploadedFile().

UploadFromStash::stashFile

(

)

Stash the file.

Returns:

UploadStashFile

Reimplemented from UploadBase.

Definition at line 141 of file UploadFromStash.php.

Referenced by stashSession().

UploadFromStash::stashSession

(

)

This should return the key instead of the UploadStashFile instance, for backward compatibility.

Returns:

String

Reimplemented from UploadBase.

Definition at line 152 of file UploadFromStash.php.

References stashFile().

UploadFromStash::unsaveUploadedFile

(

)

Remove a temporarily kept file stashed by saveTempUploadedFile().

Returns:

bool success

Definition at line 160 of file UploadFromStash.php.

Referenced by performUpload().

---

Member Data Documentation

UploadFromStash::$mFileKey [protected]

Definition at line 31 of file UploadFromStash.php.

UploadFromStash::$mFileProps

Reimplemented from UploadBase.

Definition at line 31 of file UploadFromStash.php.

UploadFromStash::$mSourceType

Reimplemented from UploadBase.

Definition at line 31 of file UploadFromStash.php.

UploadFromStash::$mVirtualTempPath

Definition at line 31 of file UploadFromStash.php.

UploadFromStash::$repo [private]

Definition at line 37 of file UploadFromStash.php.

Referenced by __construct().

UploadFromStash::$stash [private]

Definition at line 34 of file UploadFromStash.php.

Referenced by __construct().

---

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

• includes/upload/UploadFromStash.php