XoopsModules25x / smallworld

class/adminclass.php

Doc Comments +3 added lines, -3 removed lines

@@ -346,7 +346,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
      */
     function fetchURL($url, $methods = array('fopen', 'curl', 'socket'))
@@ -545,7 +545,7 @@ 
      * @param  int    $userid
      * @param  string $directory
      * @param  int    $empty
-     * @return true
+     * @return boolean|null
      */
     function smallworld_remDir ($userid, $directory, $empty = false)
     {
@@ -586,7 +586,7 @@ 
      * SmallworldDeleteDirectory function
      * - Delete images from users on delete
      * @param  int  $userid
-     * @return true
+     * @return boolean
      */
     function SmallworldDeleteDirectory($userid)
     {

class/db.php

Doc Comments +8 added lines, -7 removed lines

@@ -155,7 +155,7 @@ 
 
     /**
      * saveImage function
-     * @param  int  $value
+     * @param  string  $values
      * @return void
      */
     function saveImage($values)
@@ -490,7 +490,7 @@ 
      * deleteWallMsg function
      * @param  int  $id
      * @param  int  $smallworld_msg_id
-     * @return true
+     * @return boolean
      */
     function deleteWallMsg ($id,$smallworld_msg_id)
     {
@@ -509,8 +509,8 @@ 
     /**
      * deleteWallComment function
      * - Delete Comments
-     * @param  int  $smallworldComId
-     * @return true
+     * @param  int  $smallworld_com_id
+     * @return boolean
      */
     public function deleteWallComment($smallworld_com_id)
     {
@@ -597,7 +597,7 @@ 
      * SmallworldDeleteDirectory function
      * - Delete images from users on delete
      * @param  int  $userid
-     * @return true
+     * @return boolean
      */
     function SmallworldDeleteDirectory($userid)
     {
@@ -630,7 +630,7 @@ 
      * @param  int    $userid
      * @param  string $directory
      * @param  int    $empty
-     * @return true
+     * @return boolean|null
      */
     function smallworld_remDir ($userid, $directory, $empty = false)
     {
@@ -671,6 +671,7 @@ 
      * Update private settings
      * @param int id ($userid)
      * @param string posts (serialized values)
+     * @param string $posts
      * @return void
      */
     function saveSettings ($id, $posts)
@@ -691,7 +692,7 @@ 
     /**
      * Retrieve private settings
      * @param int userid
-     * @return serialized array values
+     * @return null|string array values
      */
     function GetSettings ($userid)
     {

class/forms.php

Doc Comments +7 added lines, -13 removed lines

@@ -121,10 +121,9 @@ 
     }
 
     /**
-     * @return as     dropdown
+     * @return string     dropdown
      * @param  string $class
      * @param  string $name
-     * @param  string $nametwo
      * @param  string $rel
      * @param  array  $options
      * @param  string $textmore
@@ -146,10 +145,9 @@ 
     }
         
     /**
-     * @return dynamic inputs
+     * @return string inputs
      * @param  string  $class
      * @param  string  $name
-     * @param  string  $nametwo
      * @param  string  $rel
      * @param  int     $size
      * @param  string  $textmore
@@ -167,7 +165,7 @@ 
     }
 
     /**
-     * @return textarea
+     * @return string
      * @param  string   $name
      * @param  string   $id
      * @param  string   $title
@@ -182,7 +180,7 @@ 
     }
 
     /**
-     * @return dynamic dropdown
+     * @return string dropdown
      * @param  string  $class
      * @param  string  $name
      * @param  string  $name2
@@ -227,10 +225,9 @@ 
     }
 
     /**
-     * @return dynamic inputs
+     * @return string inputs
      * @param  string  $class
      * @param  string  $name
-     * @param  string  $nametwo
      * @param  string  $rel
      * @param  string  $textmore
      * @param  string  $employer      (optional)
@@ -256,7 +253,7 @@ 
     }
     
     /**
-     * @return file   input
+     * @return string   input
      * @param  int    $userID
      * @return string
      */
@@ -272,7 +269,7 @@ 
     }
 
     /**
-     * @return dynamic input
+     * @return string input
      * @param  int     $userID
      * @param  string  $imgurl
      * @param  string  $imgdesc
@@ -295,9 +292,6 @@ 
     
     /**
      * @create a radio select
-     * @param  string $name
-     * @param  array  $options
-     * @param  string $selected (optional)
      * @return string
      */
     function usersettings ($userid)

class/mail.php

Doc Comments +7 added lines

@@ -34,6 +34,10 @@ 
      * Result: send mail, return true or false
      */
      
+    /**
+     * @param string $event
+     * @param string $link
+     */
     function sendMails ($fromUserID, $toUserID, $event, $link=null, array $data) {
         global $xoopsConfig, $xoopsUser;
         $date = date('m-d-Y H:i:s',time());
@@ -198,6 +202,9 @@ 
         return array_unique($parts);
     }
 
+    /**
+     * @return string
+     */
     function getOwnerUpdateFromMsgID ($msgid) {
      global $xoopsDB;
         $sql = "Select message from ".$xoopsDB->prefix('smallworld_messages')." where msg_id = '".$msgid."'";

class/publicWall.php

Doc Comments -3 removed lines

@@ -63,8 +63,6 @@ 
     /**
      * @Get array of updates
      * @param  int   $last
-     * @param  int   $uid
-     * @param  array $followes
      * @return array
      */
     public function Updates($last,$moderators) {
@@ -362,7 +360,6 @@ 
      * @Parse update and comments array to template for public updates
      * @param  array  $updatesarray
      * @param  int    $id
-     * @param  string $permalink
      * @return void
     */
     function ParsePubArray ($updatesarray, $id)

class/uploadclass.php

Doc Comments +6 added lines

@@ -39,6 +39,9 @@ 
         $this->field_name = $options['field_name'];
     }
     
+    /**
+     * @param string $file_name
+     */
     private function get_file_object($file_name) {
         $file_path = $this->upload_dir.$file_name;
         if (is_file($file_path) && $file_name[0] !== '.' && $file_name !='index.html' && $file_name !='Thumbs.db') {
@@ -55,6 +58,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $file_name
+     */
     private function create_thumbnail($file_name) {
         $file_path = $this->upload_dir.$file_name;
         $thumbnail_path = $this->thumbnails_dir.$file_name;

class/UploadHandler.php

Doc Comments +36 added lines

@@ -197,6 +197,9 @@ 
             .$version_path.rawurlencode($file_name);
     }
 
+    /**
+     * @param stdClass $file
+     */
     protected function set_file_delete_properties($file) {
         $file->delete_url = $this->options['script_url']
             .$this->get_query_separator($this->options['script_url'])
@@ -238,6 +241,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $file_name
+     */
     protected function get_file_object($file_name) {
         if ($this->is_valid_file_object($file_name)) {
             $file = new stdClass();
@@ -280,6 +286,9 @@ 
         return count($this->get_file_objects('is_valid_file_object'));
     }
 
+    /**
+     * @param string $file_name
+     */
     protected function create_scaled_image($file_name, $version, $options) {
         $file_path = $this->get_upload_path($file_name);
         if (!empty($version)) {
@@ -356,6 +365,9 @@ 
             $this->error_messages[$error] : $error;
     }
 
+    /**
+     * @param string $val
+     */
     function get_config_bytes($val) {
         $val = trim($val);
         $last = strtolower($val[strlen($val)-1]);
@@ -371,6 +383,9 @@ 
         return $this->fix_integer_overflow($val);
     }
 
+    /**
+     * @param stdClass $file
+     */
     protected function validate($uploaded_file, $file, $error, $index) {
         if ($error) {
             $file->error = $this->get_error_message($error);
@@ -458,6 +473,9 @@ 
         );
     }
 
+    /**
+     * @param string $name
+     */
     protected function get_unique_filename($name, $type, $index, $content_range) {
         while(is_dir($this->get_upload_path($name))) {
             $name = $this->upcount_name($name);
@@ -502,10 +520,16 @@ 
         );
     }
 
+    /**
+     * @param stdClass $file
+     */
     protected function handle_form_data($file, $index) {
         // Handle form data, e.g. $_REQUEST['description'][$index]
     }
 
+    /**
+     * @param string $file_path
+     */
     protected function orient_image($file_path) {
         if (!function_exists('exif_read_data')) {
             return false;
@@ -622,14 +646,23 @@ 
       return $parts['extension'];
     }
     
+    /**
+     * @param string $file_path
+     */
     protected function readfile($file_path) {
         return readfile($file_path);
     }
 
+    /**
+     * @param string $str
+     */
     protected function body($str) {
         echo $str;
     }
     
+    /**
+     * @param string $str
+     */
     protected function header($str) {
         header($str);
     }
@@ -666,6 +699,9 @@ 
         return isset($_GET['file']) ? basename(stripslashes($_GET['file'])) : null;
     }
 
+    /**
+     * @param string $file_path
+     */
     protected function get_file_type($file_path) {
         switch (strtolower(pathinfo($file_path, PATHINFO_EXTENSION))) {
             case 'jpeg':

class/user.php

Doc Comments +1 added lines, -1 removed lines

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

class/wall.php

Doc Comments +1 added lines, -2 removed lines

@@ -205,7 +205,7 @@ 
     /**
      * @Insert comment
      * @param  int    $uid
-     * @param  int    $msgid
+     * @param  int    $msg_id
      * @param  string $comment
      * @return string / void
      */
@@ -447,7 +447,6 @@ 
      * @Parse update and comments array to template for public updates
      * @param  array  $updatesarray
      * @param  int    $id
-     * @param  string $permalink
      * @return void
     */
     function ParsePubArray ($updatesarray, $id)