* @author Bryan Tong Minh
*/
class UploadFromStash extends UploadBase {
- protected $mFileKey, $mVirtualTempPath, $mFileProps, $mSourceType;
+ protected $mFileKey;
+ protected $mVirtualTempPath;
+ protected $mFileProps;
+ protected $mSourceType;
// an instance of UploadStash
private $stash;
private $repo;
/**
- * @param $user User
- * @param $stash UploadStash
- * @param $repo FileRepo
+ * @param User|bool $user Default: false
+ * @param UploadStash|bool $stash Default: false
+ * @param FileRepo|bool $repo Default: false
*/
public function __construct( $user = false, $stash = false, $repo = false ) {
// user object. sometimes this won't exist, as when running from cron.
}
/**
- * @param $key string
+ * @param string $key
* @return bool
*/
public static function isValidKey( $key ) {
}
/**
- * @param $request WebRequest
- *
- * @return Boolean
+ * @param WebRequest $request
+ * @return bool
*/
public static function isValidRequest( $request ) {
// this passes wpSessionKey to getText() as a default when wpFileKey isn't set.
}
/**
- * @param $key string
- * @param $name string
+ * @param string $key
+ * @param string $name
+ * @param bool $initTempFile
*/
public function initialize( $key, $name = 'upload_file', $initTempFile = true ) {
/**
}
/**
- * @param $request WebRequest
+ * @param WebRequest $request
*/
public function initializeFromRequest( &$request ) {
// sends wpSessionKey as a default when wpFileKey is missing
$fileKey = $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) );
// chooses one of wpDestFile, wpUploadFile, filename in that order.
- $desiredDestName = $request->getText( 'wpDestFile', $request->getText( 'wpUploadFile', $request->getText( 'filename' ) ) );
+ $desiredDestName = $request->getText(
+ 'wpDestFile',
+ $request->getText( 'wpUploadFile', $request->getText( 'filename' ) )
+ );
$this->initialize( $fileKey, $desiredDestName );
}
/**
* Stash the file.
*
- * @param $user User
+ * @param User $user
* @return UploadStashFile
*/
public function stashFile( User $user = null ) {
// replace mLocalFile with an instance of UploadStashFile, which adds some methods
// that are useful for stashed files.
$this->mLocalFile = parent::stashFile( $user );
+
return $this->mLocalFile;
}
/**
* This should return the key instead of the UploadStashFile instance, for backward compatibility.
- * @return String
+ * @return string
*/
public function stashSession() {
return $this->stashFile()->getFileKey();
/**
* Remove a temporarily kept file stashed by saveTempUploadedFile().
- * @return bool success
+ * @return bool Success
*/
public function unsaveUploadedFile() {
return $this->stash->removeFile( $this->mFileKey );
/**
* Perform the upload, then remove the database record afterward.
- * @param $comment string
- * @param $pageText string
- * @param $watch bool
- * @param $user User
+ * @param string $comment
+ * @param string $pageText
+ * @param bool $watch
+ * @param User $user
* @return Status
*/
public function performUpload( $comment, $pageText, $watch, $user ) {
$rv = parent::performUpload( $comment, $pageText, $watch, $user );
$this->unsaveUploadedFile();
+
return $rv;
}
}