XoopsModules25x / smallworld

class/adminclass.php

Doc Comments +4 added lines, -4 removed lines

@@ -330,7 +330,7 @@ 
      * Fetch content of comma separated text file
      * will attempt to use the fopen method first, then curl, then socket
      * @param string $url
-     * @param array $methods
+     * @param string[] $methods
      * @returns string
      */
     public function fetchURL($url, $methods = ['fopen', 'curl', 'socket'])
@@ -522,8 +522,8 @@ 
      * - Remove user image dir in uploads.
      * @param  int $userid
      * @param  string $directory
-     * @param bool|int $empty
-     * @return true
+     * @param boolean $empty
+     * @return boolean|null
      */
     public function smallworld_remDir($userid, $directory, $empty = false)
     {
@@ -564,7 +564,7 @@ 
      * SmallworldDeleteDirectory function
      * - Delete images from users on delete
      * @param  int $userid
-     * @return true
+     * @return boolean
      */
     public function SmallworldDeleteDirectory($userid)
     {

class/db.php

Doc Comments +8 added lines, -7 removed lines

@@ -146,7 +146,7 @@ 
 
     /**
      * saveImage function
-     * @param $values
+     * @param string $values
      * @return void
      */
     public function saveImage($values)
@@ -456,7 +456,7 @@ 
      * deleteWallMsg function
      * @param int $id
      * @param int $smallworld_msg_id
-     * @return true
+     * @return boolean
      */
     public function deleteWallMsg($id, $smallworld_msg_id)
     {
@@ -475,7 +475,7 @@ 
      * deleteWallComment function
      * - Delete Comments
      * @param int $smallworld_com_id
-     * @return true
+     * @return boolean
      */
     public function deleteWallComment($smallworld_com_id)
     {
@@ -550,7 +550,7 @@ 
      * SmallworldDeleteDirectory function
      * - Delete images from users on delete
      * @param int $userid
-     * @return true
+     * @return boolean
      */
     public function SmallworldDeleteDirectory($userid)
     {
@@ -580,8 +580,8 @@ 
      * - Remove user image dir in uploads.
      * @param int    $userid
      * @param string $directory
-     * @param bool|int $empty
-     * @return true
+     * @param boolean $empty
+     * @return boolean|null
      */
     public function smallworld_remDir($userid, $directory, $empty = false)
     {
@@ -621,6 +621,7 @@ 
      * Update private settings
      * @param int id ($userid)
      * @param string posts (serialized values)
+     * @param string $posts
      * @return void
      */
     public function saveSettings($id, $posts)
@@ -641,7 +642,7 @@ 
     /**
      * Retrieve private settings
      * @param int userid
-     * @return serialized|string
+     * @return null|string
      */
     public function GetSettings($userid)
     {

class/uploadclass.php

Doc Comments +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
     }
 
     /**
-     * @param $file_name
+     * @param string $file_name
      * @return null|\stdClass
      */
     private function get_file_object($file_name)
@@ -63,7 +63,7 @@ 
     }
 
     /**
-     * @param $file_name
+     * @param string $file_name
      * @return bool
      */
     private function create_thumbnail($file_name)

class/user.php

Doc Comments +1 added lines, -1 removed lines

@@ -135,7 +135,7 @@
      * @Check if user is follower
      * @param int $userid
      * @param int $friendid
-     * @return int
+     * @return integer[]
      */
     public function following_or($userid, $friendid)
     {

include/functions.php

Doc Comments +10 added lines, -10 removed lines

@@ -40,7 +40,7 @@ 
 // If array check for magicQuotes.
 // Pass string to Smallworld_cleanup_string
 /**
- * @param $text
+ * @param string $text
  * @return array|mixed
  */
 function Smallworld_cleanup($text)
@@ -127,7 +127,7 @@ 
 }
 
 /**
- * @param $folderUrl
+ * @param string $folderUrl
  */
 function Smallworld_CreateIndexFiles($folderUrl)
 {
@@ -273,7 +273,7 @@ 
 // Return only url/link
 // If url is image link return <img>
 /**
- * @param $text
+ * @param string $text
  * @param $uid
  * @return string
  */
@@ -933,7 +933,7 @@ 
 /**
  * @param $width
  * @param $height
- * @param $target
+ * @param integer $target
  * @return string
  */
 function smallworld_imageResize($width, $height, $target)
@@ -960,7 +960,7 @@ 
  * will attempt to use the getimagesiz method first, then curl
  * @param int $w
  * @param int $h
- * @param url $url
+ * @param string $url
  * @returns array
  */
 function smallworld_getImageSize($w, $h, $url)
@@ -1050,7 +1050,7 @@ 
 /**
  * @Get htmlentities
  * @param $text
- * @return translated string to utf-8
+ * @return string string to utf-8
  */
 function smallworld_decodeEntities($text)
 {
@@ -1063,7 +1063,7 @@ 
 /**
  * @Get string and shorten so contains only ? chars
  * @param $text
- * @param $chars
+ * @param integer $chars
  * @return string
  */
 function smallworld_shortenText($text, $chars)
@@ -1077,8 +1077,8 @@ 
 
 /**
  * @Get languagefile if constants are not defined
- * @param $def
- * @param $file
+ * @param string $def
+ * @param string $file
  * return file include
  */
 function smallworld_isDefinedLanguage($def, $file)
@@ -1128,7 +1128,7 @@ 
 }
 
 /**
- * @return array of groups
+ * @return string[] of groups
  * return array
  *
  */

class/UploadHandler.php

Doc Comments +14 added lines, -14 removed lines

@@ -226,7 +226,7 @@ 
     }
 
     /**
-     * @param $file
+     * @param \stdClass $file
      */
     protected function set_file_delete_properties($file)
     {
@@ -244,7 +244,7 @@ 
     // works for sizes up to 2^32-1 bytes (4 GiB - 1):
     /**
      * @param $size
-     * @return float|int
+     * @return null|string
      */
     protected function fix_integer_overflow($size)
     {
@@ -278,7 +278,7 @@ 
     }
 
     /**
-     * @param $file_name
+     * @param string $file_name
      * @return null|\stdClass
      */
     protected function get_file_object($file_name)
@@ -323,7 +323,7 @@ 
     }
 
     /**
-     * @param $file_name
+     * @param string $file_name
      * @param $version
      * @param $options
      * @return bool
@@ -397,7 +397,7 @@ 
     }
 
     /**
-     * @param $val
+     * @param string $val
      * @return float|int
      */
     public function get_config_bytes($val)
@@ -419,7 +419,7 @@ 
 
     /**
      * @param $uploaded_file
-     * @param $file
+     * @param \stdClass $file
      * @param $error
      * @param $index
      * @return bool
@@ -500,7 +500,7 @@ 
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @param $type
      * @param $index
      * @param $content_range
@@ -527,7 +527,7 @@ 
      * @param $type
      * @param $index
      * @param $content_range
-     * @return mixed|string
+     * @return string
      */
     protected function trim_file_name($name, $type, $index, $content_range)
     {
@@ -559,7 +559,7 @@ 
     }
 
     /**
-     * @param $file
+     * @param \stdClass $file
      * @param $index
      */
     protected function handle_form_data($file, $index)
@@ -568,7 +568,7 @@ 
     }
 
     /**
-     * @param $file_path
+     * @param string $file_path
      * @return bool
      */
     protected function orient_image($file_path)
@@ -699,7 +699,7 @@ 
     }
 
     /**
-     * @param $file_path
+     * @param string $file_path
      * @return false|int
      */
     protected function readfile($file_path)
@@ -708,7 +708,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      */
     protected function body($str)
     {
@@ -716,7 +716,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      */
     protected function header($str)
     {
@@ -765,7 +765,7 @@ 
     }
 
     /**
-     * @param $file_path
+     * @param string $file_path
      * @return string
      */
     protected function get_file_type($file_path)

class/SmallworldAdmin.php

Doc Comments +4 added lines, -4 removed lines

@@ -330,7 +330,7 @@ 
      * Fetch content of comma separated text file
      * will attempt to use the fopen method first, then curl, then socket
      * @param string $url
-     * @param array $methods
+     * @param string[] $methods
      * @returns string
      */
     public function fetchURL($url, $methods = ['fopen', 'curl', 'socket'])
@@ -522,8 +522,8 @@ 
      * - Remove user image dir in uploads.
      * @param  int $userid
      * @param  string|bool $directory
-     * @param bool|int $empty
-     * @return true
+     * @param boolean $empty
+     * @return boolean|null
      */
     public function smallworld_remDir($userid, $directory, $empty = false)
     {
@@ -564,7 +564,7 @@ 
      * SmallworldDeleteDirectory function
      * - Delete images from users on delete
      * @param  int $userid
-     * @return true
+     * @return boolean
      */
     public function SmallworldDeleteDirectory($userid)
     {

class/SmallWorldDB.php

Doc Comments +8 added lines, -7 removed lines

@@ -146,7 +146,7 @@ 
 
     /**
      * saveImage function
-     * @param $values
+     * @param string $values
      * @return void
      */
     public function saveImage($values)
@@ -456,7 +456,7 @@ 
      * deleteWallMsg function
      * @param int $id
      * @param int $smallworld_msg_id
-     * @return true
+     * @return boolean
      */
     public function deleteWallMsg($id, $smallworld_msg_id)
     {
@@ -475,7 +475,7 @@ 
      * deleteWallComment function
      * - Delete Comments
      * @param int $smallworld_com_id
-     * @return true
+     * @return boolean
      */
     public function deleteWallComment($smallworld_com_id)
     {
@@ -550,7 +550,7 @@ 
      * SmallworldDeleteDirectory function
      * - Delete images from users on delete
      * @param int $userid
-     * @return true
+     * @return boolean
      */
     public function SmallworldDeleteDirectory($userid)
     {
@@ -580,8 +580,8 @@ 
      * - Remove user image dir in uploads.
      * @param int    $userid
      * @param string|bool $directory
-     * @param bool|int $empty
-     * @return true
+     * @param boolean $empty
+     * @return boolean|null
      */
     public function smallworld_remDir($userid, $directory, $empty = false)
     {
@@ -621,6 +621,7 @@ 
      * Update private settings
      * @param int id ($userid)
      * @param string posts (serialized values)
+     * @param string $posts
      * @return void
      */
     public function saveSettings($id, $posts)
@@ -641,7 +642,7 @@ 
     /**
      * Retrieve private settings
      * @param int userid
-     * @return serialized|string
+     * @return null|string
      */
     public function GetSettings($userid)
     {

class/SmallworldUploadHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
     }
 
     /**
-     * @param $file_name
+     * @param string $file_name
      * @return null|\stdClass
      */
     private function get_file_object($file_name)
@@ -63,7 +63,7 @@ 
     }
 
     /**
-     * @param $file_name
+     * @param string $file_name
      * @return bool
      */
     private function create_thumbnail($file_name)