Update some deprecated code

[lhc/web/wiklou.git] / includes / upload / UploadFromStash.php

diff --git a/includes/upload/UploadFromStash.php b/includes/upload/UploadFromStash.php
index 62c6723..8392270 100644 (file)
--- a/includes/upload/UploadFromStash.php
+++ b/includes/upload/UploadFromStash.php
@@ -9,13 +9,18 @@
 
 class UploadFromStash extends UploadBase {
        protected $mFileKey, $mVirtualTempPath, $mFileProps, $mSourceType;
-       
+
        // an instance of UploadStash
        private $stash;
-       
+
        //LocalFile repo
        private $repo;
-       
+
+       /**
+        * @param $user User
+        * @param $stash UploadStash
+        * @param $repo FileRepo
+        */
        public function __construct( $user = false, $stash = false, $repo = false ) {
                // user object. sometimes this won't exist, as when running from cron.
                $this->user = $user;
@@ -40,7 +45,11 @@ class UploadFromStash extends UploadBase {
 
                return true;
        }
-       
+
+       /**
+        * @param $key string
+        * @return bool
+        */
        public static function isValidKey( $key ) {
                // this is checked in more detail in UploadStash
                return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
@@ -58,13 +67,17 @@ class UploadFromStash extends UploadBase {
                return self::isValidKey( $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) ) );
        }
 
+       /**
+        * @param $key string
+        * @param $name string
+        */
        public function initialize( $key, $name = 'upload_file' ) {
                /**
                 * Confirming a temporarily stashed upload.
                 * We don't want path names to be forged, so we keep
                 * them in the session on the server and just give
                 * an opaque key to the user agent.
-                */             
+                */
                $metadata = $this->stash->getMetadata( $key );
                $this->initializePathInfo( $name,
                        $this->getRealPath ( $metadata['us_path'] ),
@@ -91,8 +104,11 @@ class UploadFromStash extends UploadBase {
                return $this->initialize( $fileKey, $desiredDestName );
        }
 
-       public function getSourceType() { 
-               return $this->mSourceType; 
+       /**
+        * @return string
+        */
+       public function getSourceType() {
+               return $this->mSourceType;
        }
 
        /**
@@ -106,6 +122,8 @@ class UploadFromStash extends UploadBase {
 
        /**
         * Stash the file.
+        *
+        * @return UploadStashFile
         */
        public function stashFile() {
                // replace mLocalFile with an instance of UploadStashFile, which adds some methods
@@ -131,6 +149,11 @@ class UploadFromStash extends UploadBase {
 
        /**
         * Perform the upload, then remove the database record afterward.
+        * @param $comment string
+        * @param $pageText string
+        * @param $watch bool
+        * @param $user User
+        * @return Status
         */
        public function performUpload( $comment, $pageText, $watch, $user ) {
                $rv = parent::performUpload( $comment, $pageText, $watch, $user );
@@ -141,7 +164,7 @@ class UploadFromStash extends UploadBase {
        /**
         * Append a chunk to the temporary file.
         *
-        * @return void
+        * @return Status
         */
        public function appendChunk($chunk, $chunkSize, $offset) {
                //to use $this->getFileSize() here, db needs to be updated
@@ -153,7 +176,7 @@ class UploadFromStash extends UploadBase {
                        //append chunk
                        if ( $fileSize == $offset ) {
                                $status = $this->appendToUploadFile( $chunk,
-                                                                                                        $this->mVirtualTempPath );
+                                       $this->mVirtualTempPath );
                        } else {
                                $status = Status::newFatal( 'invalid-chunk-offset' );
                        }