andela-iadeniyi / Potato-ORM

src/Helper/Upload.php

Doc Comments +22 added lines, -12 removed lines

@@ -62,8 +62,8 @@ 
     /**
      *@method bool ValidateExtension() returns whether the extension of file to be uploaded
      *    is allowable or not.
-     *@return true the extension is valid.
-     *@return false the extension is invalid.
+     *@return boolean the extension is valid.
+     *@return boolean the extension is invalid.
      */
     public function ValidateExtension()
     {
@@ -95,8 +95,8 @@ 
 
     /**
      *@method bool ValidateSize() returns whether the file size is acceptable.
-     *@return true the size is smaller than the alloted value.
-     *@return false the size is larger than the alloted value.
+     *@return boolean the size is smaller than the alloted value.
+     *@return boolean the size is larger than the alloted value.
      */
     public function ValidateSize()
     {
@@ -120,8 +120,8 @@ 
 
     /**
      *@method bool ValidateExistance() determins whether the file already exists. If so, rename $FileName.
-     *@return true can never be returned as all file names must be unique.
-     *@return false the file name does not exist.
+     *@return null|false can never be returned as all file names must be unique.
+     *@return null|false the file name does not exist.
      */
     public function ValidateExistance()
     {
@@ -142,8 +142,8 @@ 
 
     /**
      *@method bool ValidateDirectory()
-     *@return true the UploadDirectory exists, writable, and has a traling slash.
-     *@return false the directory was never set, does not exist, or is not writable.
+     *@return null|boolean the UploadDirectory exists, writable, and has a traling slash.
+     *@return null|boolean the directory was never set, does not exist, or is not writable.
      */
     public function ValidateDirectory()
     {
@@ -177,8 +177,8 @@ 
 
     /**
      *@method bool ValidateImage()
-     *@return true the image is smaller than the alloted dimensions.
-     *@return false the width and/or height is larger then the alloted dimensions.
+     *@return boolean the image is smaller than the alloted dimensions.
+     *@return boolean the width and/or height is larger then the alloted dimensions.
      */
     public function ValidateImage() {
         $MaximumWidth = $this->MaximumWidth;
@@ -206,8 +206,8 @@ 
 
     /**
      *@method bool UploadFile() uploads the file to the server after passing all the validations.
-     *@return true the file was uploaded.
-     *@return false the upload failed.
+     *@return null|boolean the file was uploaded.
+     *@return null|boolean the upload failed.
      */
     public function uploadFile()
     {
@@ -251,11 +251,18 @@ 
 
     #Accessors and Mutators beyond this point.
     #Siginificant documentation is not needed.
+
+    /**
+     * @param string $argv
+     */
     public function SetFileName($argv)
     {
         $this->FileName = $argv;
     }
 
+    /**
+     * @param string $argv
+     */
     public function SetUploadDirectory($argv)
     {
         $this->UploadDirectory = $argv;
@@ -310,6 +317,9 @@ 
         return $this->UploadDirectory;
     }
 
+    /**
+     * @return string
+     */
     public function GetTempName()
     {
         return $this->TempFileName;