Completed
Pull Request — master (#440)
by Harald
04:56
created
catalog/admin/includes/functions/general.php 1 patch
Doc Comments   +28 added lines patch added patch discarded remove patch
@@ -221,6 +221,9 @@  discard block
 block discarded – undo
221 221
     return $image;
222 222
   }
223 223
 
224
+  /**
225
+   * @param integer $len
226
+   */
224 227
   function tep_break_string($string, $len, $break_char = '-') {
225 228
     $l = 0;
226 229
     $output = '';
@@ -333,6 +336,11 @@  discard block
 block discarded – undo
333 336
     return $geo_zone_id;
334 337
   }
335 338
 
339
+  /**
340
+   * @param boolean $html
341
+   * @param string $boln
342
+   * @param string $eoln
343
+   */
336 344
   function tep_address_format($address_format_id, $address, $html, $boln, $eoln) {
337 345
     $Qaddress = Registry::get('Db')->get('address_format', 'address_format', ['address_format_id' => (int)$address_format_id]);
338 346
 
@@ -429,6 +437,9 @@  discard block
 block discarded – undo
429 437
     return $def_state;
430 438
   }
431 439
 
440
+  /**
441
+   * @param string $params
442
+   */
432 443
   function tep_get_uprid($prid, $params) {
433 444
     $uprid = $prid;
434 445
     if ( (is_array($params)) && (!strstr($prid, '{')) ) {
@@ -729,6 +740,9 @@  discard block
 block discarded – undo
729 740
 
730 741
 ////
731 742
 // Sets the status of a banner
743
+  /**
744
+   * @param integer $status
745
+   */
732 746
   function tep_set_banner_status($banners_id, $status) {
733 747
     $OSCOM_Db = Registry::get('Db');
734 748
 
@@ -803,6 +817,9 @@  discard block
 block discarded – undo
803 817
 
804 818
 ////
805 819
 // Sets the status of a product on special
820
+  /**
821
+   * @param integer $status
822
+   */
806 823
   function tep_set_specials_status($specials_id, $status) {
807 824
     $OSCOM_Db = Registry::get('Db');
808 825
 
@@ -1220,6 +1237,11 @@  discard block
 block discarded – undo
1220 1237
     return $value;
1221 1238
   }
1222 1239
 
1240
+  /**
1241
+   * @param string $to_name
1242
+   * @param string $email_subject
1243
+   * @param string $email_text
1244
+   */
1223 1245
   function tep_mail($to_name, $to_email_address, $email_subject, $email_text, $from_email_name, $from_email_address) {
1224 1246
     if (SEND_EMAILS != 'true') return false;
1225 1247
 
@@ -1271,6 +1293,9 @@  discard block
 block discarded – undo
1271 1293
 
1272 1294
 ////
1273 1295
 // Wrapper function for round() for php3 compatibility
1296
+  /**
1297
+   * @return double
1298
+   */
1274 1299
   function tep_round($value, $precision) {
1275 1300
     return round($value, $precision);
1276 1301
   }
@@ -1418,6 +1443,9 @@  discard block
 block discarded – undo
1418 1443
   }
1419 1444
 
1420 1445
 // nl2br() prior PHP 4.2.0 did not convert linefeeds on all OSs (it only converted \n)
1446
+  /**
1447
+   * @param string[] $from
1448
+   */
1421 1449
   function tep_convert_linefeeds($from, $to, $string) {
1422 1450
       return str_replace($from, $to, $string);
1423 1451
   }
Please login to merge, or discard this patch.
catalog/includes/functions/general.php 1 patch
Doc Comments   +22 added lines patch added patch discarded remove patch
@@ -79,6 +79,9 @@  discard block
 block discarded – undo
79 79
 
80 80
 ////
81 81
 // Break a word in a string if it is longer than a specified length ($len)
82
+  /**
83
+   * @param integer $len
84
+   */
82 85
   function tep_break_string($string, $len, $break_char = '-') {
83 86
     $l = 0;
84 87
     $output = '';
@@ -246,6 +249,9 @@  discard block
 block discarded – undo
246 249
 
247 250
 ////
248 251
 // Wrapper function for round()
252
+  /**
253
+   * @return double
254
+   */
249 255
   function tep_round($number, $precision) {
250 256
     if (strpos($number, '.') && (strlen(substr($number, strpos($number, '.')+1)) > $precision)) {
251 257
       $number = substr($number, 0, strpos($number, '.') + 1 + $precision + 1);
@@ -425,6 +431,11 @@  discard block
 block discarded – undo
425 431
 ////
426 432
 // Return a formatted address
427 433
 // TABLES: address_format
434
+  /**
435
+   * @param boolean $html
436
+   * @param string $boln
437
+   * @param string $eoln
438
+   */
428 439
   function tep_address_format($address_format_id, $address, $html, $boln, $eoln) {
429 440
     $OSCOM_Db = Registry::get('Db');
430 441
 
@@ -918,6 +929,9 @@  discard block
 block discarded – undo
918 929
 
919 930
 ////
920 931
 // Return a product ID with attributes
932
+  /**
933
+   * @param string $params
934
+   */
921 935
   function tep_get_uprid($prid, $params) {
922 936
     if (is_numeric($prid)) {
923 937
       $uprid = (int)$prid;
@@ -999,6 +1013,11 @@  discard block
 block discarded – undo
999 1013
 // $from_email_adress The eMail address of the sender,
1000 1014
 //                    e.g. [email protected]
1001 1015
 
1016
+  /**
1017
+   * @param string $to_name
1018
+   * @param string $email_subject
1019
+   * @param string $email_text
1020
+   */
1002 1021
   function tep_mail($to_name, $to_email_address, $email_subject, $email_text, $from_email_name, $from_email_address) {
1003 1022
     if (SEND_EMAILS != 'true') return false;
1004 1023
 
@@ -1227,6 +1246,9 @@  discard block
 block discarded – undo
1227 1246
   }
1228 1247
 
1229 1248
 // Convert linefeeds
1249
+  /**
1250
+   * @param string[] $from
1251
+   */
1230 1252
   function tep_convert_linefeeds($from, $to, $string) {
1231 1253
       return str_replace($from, $to, $string);
1232 1254
   }
Please login to merge, or discard this patch.
catalog/includes/OSC/OM/Hash.php 1 patch
Doc Comments   +13 added lines patch added patch discarded remove patch
@@ -12,6 +12,9 @@  discard block
 block discarded – undo
12 12
 
13 13
 class Hash
14 14
 {
15
+    /**
16
+     * @param string $plain
17
+     */
15 18
     public static function encrypt($plain, $algo = null)
16 19
     {
17 20
         if (!isset($algo) || ($algo == 'default') || ($algo == 'bcrypt')) {
@@ -53,6 +56,9 @@  discard block
 block discarded – undo
53 56
         return false;
54 57
     }
55 58
 
59
+    /**
60
+     * @param string $plain
61
+     */
56 62
     public static function verify($plain, $hash)
57 63
     {
58 64
         $result = false;
@@ -128,6 +134,10 @@  discard block
 block discarded – undo
128 134
         return '';
129 135
     }
130 136
 
137
+    /**
138
+     * @param integer $min
139
+     * @param integer $max
140
+     */
131 141
     public static function getRandomInt($min = null, $max = null, $secure = true)
132 142
     {
133 143
         if (!isset($min)) {
@@ -151,6 +161,9 @@  discard block
 block discarded – undo
151 161
         return $result;
152 162
     }
153 163
 
164
+    /**
165
+     * @param integer $length
166
+     */
154 167
     public static function getRandomString($length, $type = 'mixed')
155 168
     {
156 169
         if (!in_array($type, [
Please login to merge, or discard this patch.
catalog/includes/third_party/PasswordHash.php 1 patch
Doc Comments   +19 added lines patch added patch discarded remove patch
@@ -35,6 +35,10 @@  discard block
 block discarded – undo
35 35
 	var $portable_hashes;
36 36
 	var $random_state;
37 37
 
38
+	/**
39
+	 * @param integer $iteration_count_log2
40
+	 * @param boolean $portable_hashes
41
+	 */
38 42
 	function __construct($iteration_count_log2, $portable_hashes)
39 43
 	{
40 44
 		$this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
@@ -50,6 +54,9 @@  discard block
 block discarded – undo
50 54
 			$this->random_state .= getmypid();
51 55
 	}
52 56
 
57
+	/**
58
+	 * @param integer $count
59
+	 */
53 60
 	function get_random_bytes($count)
54 61
 	{
55 62
 		$output = '';
@@ -84,6 +91,9 @@  discard block
 block discarded – undo
84 91
 		return $output;
85 92
 	}
86 93
 
94
+	/**
95
+	 * @param integer $count
96
+	 */
87 97
 	function encode64($input, $count)
88 98
 	{
89 99
 		$output = '';
@@ -107,6 +117,9 @@  discard block
 block discarded – undo
107 117
 		return $output;
108 118
 	}
109 119
 
120
+	/**
121
+	 * @param string $input
122
+	 */
110 123
 	function gensalt_private($input)
111 124
 	{
112 125
 		$output = '$P$';
@@ -155,6 +168,9 @@  discard block
 block discarded – undo
155 168
 		return $output;
156 169
 	}
157 170
 
171
+	/**
172
+	 * @param string $input
173
+	 */
158 174
 	function gensalt_extended($input)
159 175
 	{
160 176
 		$count_log2 = min($this->iteration_count_log2 + 8, 24);
@@ -173,6 +189,9 @@  discard block
 block discarded – undo
173 189
 		return $output;
174 190
 	}
175 191
 
192
+	/**
193
+	 * @param string $input
194
+	 */
176 195
 	function gensalt_blowfish($input)
177 196
 	{
178 197
 		# This one needs to use a different order of characters and a
Please login to merge, or discard this patch.