View GitHub Repository smallworld

Schedule Inspection
Subscribe
Completed
Pull Request — master (#3)
by Michael
02:20
created
Status
Category
Toggle Patches
include/functions.php 1 patch
Doc Comments   +20 added lines, -4 removed lines patch added patch discarded remove patch 
@@ -39,6 +39,9 @@  discard block
 
 block discarded – undo
39 39 
 // Clean vars or arrays
40 40 
 // If array check for magicQuotes.
41 41 
 // Pass string to Smallworld_cleanup_string
42 
+/**
43 
+ * @param string $text
44 
+ */
42 45 
 function Smallworld_cleanup($text)
43 46 
 {
44 47 
     if (is_array($text)) {
 
@@ -108,6 +111,9 @@  discard block
 
 block discarded – undo
108 111 
     return $data;
109 112 
 }
110 113
114 
+/**
115 
+ * @param string $folderUrl
116 
+ */
111 117 
 function Smallworld_CreateIndexFiles($folderUrl)
112 118 
 {
113 119 
     $myts = MyTextSanitizer::getInstance();
 
@@ -231,6 +237,9 @@  discard block
 
 block discarded – undo
231 237
232 238 
 // Return only url/link
233 239 
 // If url is image link return <img>
240 
+/**
241 
+ * @param string $text
242 
+ */
234 243 
 function smallworld_tolink($text, $uid)
235 244 
 {
236 245 
     global $xoopsUser;
 
@@ -580,6 +589,9 @@  discard block
 
 block discarded – undo
580 589 
     return $nu;
581 590 
 }
582 591 
 //Avatar Image
592 
+/**
593 
+ * @return string
594 
+ */
583 595 
 function Smallworld_Gravatar($uid)
584 596 
 {
585 597 
     global $xoopsUser, $xoopsDB;
 
@@ -833,6 +845,9 @@  discard block
 
 block discarded – undo
833 845 
 //Function to resize images proportionally
834 846 
 // Using imagesize($imageurl) returns $img[0], $img[1]
835 847 
 // Target = new max height or width in px
848 
+/**
849 
+ * @param integer $target
850 
+ */
836 851 
 function smallworld_imageResize($width, $height, $target)
837 852 
 {
838 853 
     //takes the larger size of the width and height and applies the
 
@@ -857,7 +872,7 @@  discard block
 
 block discarded – undo
857 872 
  * will attempt to use the getimagesiz method first, then curl
858 873 
  * @param int $w
859 874 
  * @param int $h
860 
- * @param url $url
875 
+ * @param string $url
861 876 
  * @returns array
862 877 
  */
863 878 
 function smallworld_getImageSize($w, $h, $url)
 
@@ -951,7 +966,7 @@  discard block
 
 block discarded – undo
951 966
952 967 
     /**
953 968 
      * @Get htmlentities
954 
-     * @return translated string to utf-8
969 
+     * @return string string to utf-8
955 970 
      */
956 971 
     function smallworld_decodeEntities($text)
957 972 
     {
 
@@ -964,7 +979,7 @@  discard block
 
 block discarded – undo
964 979 
     /**
965 980 
      * @Get string and shorten so contains only ? chars
966 981 
      * @Param $text
967 
-     * @Param $chars
982 
+     * @Param integer $chars
968 983 
      * return string first ? chars
969 984 
      */
970 985 
     function smallworld_shortenText($text, $chars)
 
@@ -979,7 +994,8 @@  discard block
 
 block discarded – undo
979 994
980 995 
     /**
981 996 
      * @Get languagefile if constants are not defined
982 
-     * @param $def
997 
+     * @param string $def
998 
+     * @param string $file
983 999 
      * @file
984 1000 
      * return file include
985 1001 
      */
Please login to merge, or discard this patch.