@@ -12,6 +12,9 @@ |
||
12 | 12 | |
13 | 13 | //// |
14 | 14 | // Sets the status of a banner |
15 | + /** |
|
16 | + * @param string $status |
|
17 | + */ |
|
15 | 18 | function tep_set_banner_status($banners_id, $status) { |
16 | 19 | if ($status == '1') { |
17 | 20 | return tep_db_query("update " . TABLE_BANNERS . " set status = '1', date_status_change = now(), date_scheduled = NULL where banners_id = '" . (int)$banners_id . "'"); |
@@ -55,6 +55,10 @@ |
||
55 | 55 | } |
56 | 56 | |
57 | 57 | if (!function_exists('checkdnsrr')) { |
58 | + |
|
59 | + /** |
|
60 | + * @param string $type |
|
61 | + */ |
|
58 | 62 | function checkdnsrr($host, $type) { |
59 | 63 | if(tep_not_null($host) && tep_not_null($type)) { |
60 | 64 | @exec("nslookup -type=" . escapeshellarg($type) . " " . escapeshellarg($host), $output); |
@@ -81,6 +81,9 @@ discard block |
||
81 | 81 | |
82 | 82 | //// |
83 | 83 | // Return a random row from a database query |
84 | + /** |
|
85 | + * @param string $query |
|
86 | + */ |
|
84 | 87 | function tep_random_select($query) { |
85 | 88 | $random_product = ''; |
86 | 89 | $random_query = tep_db_query($query); |
@@ -145,6 +148,10 @@ discard block |
||
145 | 148 | |
146 | 149 | //// |
147 | 150 | // Break a word in a string if it is longer than a specified length ($len) |
151 | + /** |
|
152 | + * @param string $string |
|
153 | + * @param integer $len |
|
154 | + */ |
|
148 | 155 | function tep_break_string($string, $len, $break_char = '-') { |
149 | 156 | $l = 0; |
150 | 157 | $output = ''; |
@@ -260,6 +267,9 @@ discard block |
||
260 | 267 | |
261 | 268 | //// |
262 | 269 | // Returns the clients browser |
270 | + /** |
|
271 | + * @param string $component |
|
272 | + */ |
|
263 | 273 | function tep_browser_detect($component) { |
264 | 274 | global $HTTP_USER_AGENT; |
265 | 275 | |
@@ -302,6 +312,9 @@ discard block |
||
302 | 312 | |
303 | 313 | //// |
304 | 314 | // Wrapper function for round() |
315 | + /** |
|
316 | + * @return double |
|
317 | + */ |
|
305 | 318 | function tep_round($number, $precision) { |
306 | 319 | if (strpos($number, '.') && (strlen(substr($number, strpos($number, '.')+1)) > $precision)) { |
307 | 320 | $number = substr($number, 0, strpos($number, '.') + 1 + $precision + 1); |
@@ -448,6 +461,11 @@ discard block |
||
448 | 461 | //// |
449 | 462 | // Return a formatted address |
450 | 463 | // TABLES: address_format |
464 | + /** |
|
465 | + * @param boolean $html |
|
466 | + * @param string $boln |
|
467 | + * @param string $eoln |
|
468 | + */ |
|
451 | 469 | function tep_address_format($address_format_id, $address, $html, $boln, $eoln) { |
452 | 470 | $address_format_query = tep_db_query("select address_format as format from " . TABLE_ADDRESS_FORMAT . " where address_format_id = '" . (int)$address_format_id . "'"); |
453 | 471 | $address_format = tep_db_fetch_array($address_format_query); |
@@ -940,6 +958,9 @@ discard block |
||
940 | 958 | |
941 | 959 | //// |
942 | 960 | // Return a product ID with attributes |
961 | + /** |
|
962 | + * @param string $params |
|
963 | + */ |
|
943 | 964 | function tep_get_uprid($prid, $params) { |
944 | 965 | if (is_numeric($prid)) { |
945 | 966 | $uprid = (int)$prid; |
@@ -1036,6 +1057,11 @@ discard block |
||
1036 | 1057 | // $from_email_adress The eMail address of the sender, |
1037 | 1058 | // e.g. [email protected] |
1038 | 1059 | |
1060 | + /** |
|
1061 | + * @param string $to_name |
|
1062 | + * @param string $email_subject |
|
1063 | + * @param string $email_text |
|
1064 | + */ |
|
1039 | 1065 | function tep_mail($to_name, $to_email_address, $email_subject, $email_text, $from_email_name, $from_email_address) { |
1040 | 1066 | if (SEND_EMAILS != 'true') return false; |
1041 | 1067 | |
@@ -1104,6 +1130,9 @@ discard block |
||
1104 | 1130 | return tep_count_modules(MODULE_SHIPPING_INSTALLED); |
1105 | 1131 | } |
1106 | 1132 | |
1133 | + /** |
|
1134 | + * @param integer $length |
|
1135 | + */ |
|
1107 | 1136 | function tep_create_random_value($length, $type = 'mixed') { |
1108 | 1137 | if ( ($type != 'mixed') && ($type != 'chars') && ($type != 'digits')) $type = 'mixed'; |
1109 | 1138 | |
@@ -1253,6 +1282,10 @@ discard block |
||
1253 | 1282 | |
1254 | 1283 | //// |
1255 | 1284 | // Return a random value |
1285 | + /** |
|
1286 | + * @param integer $min |
|
1287 | + * @param integer $max |
|
1288 | + */ |
|
1256 | 1289 | function tep_rand($min = null, $max = null) { |
1257 | 1290 | static $seeded; |
1258 | 1291 | |
@@ -1386,6 +1419,9 @@ discard block |
||
1386 | 1419 | } |
1387 | 1420 | |
1388 | 1421 | // nl2br() prior PHP 4.2.0 did not convert linefeeds on all OSs (it only converted \n) |
1422 | + /** |
|
1423 | + * @param string[] $from |
|
1424 | + */ |
|
1389 | 1425 | function tep_convert_linefeeds($from, $to, $string) { |
1390 | 1426 | if ((PHP_VERSION < "4.0.5") && is_array($from)) { |
1391 | 1427 | return preg_replace('/(' . implode('|', $from) . ')/', $to, $string); |
@@ -12,6 +12,9 @@ |
||
12 | 12 | |
13 | 13 | //// |
14 | 14 | // Sets the status of a special product |
15 | + /** |
|
16 | + * @param string $status |
|
17 | + */ |
|
15 | 18 | function tep_set_specials_status($specials_id, $status) { |
16 | 19 | return tep_db_query("update " . TABLE_SPECIALS . " set status = '" . (int)$status . "', date_status_change = now() where specials_id = '" . (int)$specials_id . "'"); |
17 | 20 | } |
@@ -436,6 +436,9 @@ discard block |
||
436 | 436 | return $this->_check; |
437 | 437 | } |
438 | 438 | |
439 | + /** |
|
440 | + * @param string $parameter |
|
441 | + */ |
|
439 | 442 | function install($parameter = null) { |
440 | 443 | $params = $this->getParams(); |
441 | 444 | |
@@ -598,6 +601,10 @@ discard block |
||
598 | 601 | return md5($k_opad . pack("H*",md5($k_ipad . $data))); |
599 | 602 | } |
600 | 603 | |
604 | + /** |
|
605 | + * @param string $url |
|
606 | + * @param string $parameters |
|
607 | + */ |
|
601 | 608 | function sendTransactionToGateway($url, $parameters) { |
602 | 609 | $server = parse_url($url); |
603 | 610 |
@@ -387,6 +387,9 @@ discard block |
||
387 | 387 | return $this->_check; |
388 | 388 | } |
389 | 389 | |
390 | + /** |
|
391 | + * @param string $parameter |
|
392 | + */ |
|
390 | 393 | function install($parameter = null) { |
391 | 394 | $params = $this->getParams(); |
392 | 395 | |
@@ -517,6 +520,9 @@ discard block |
||
517 | 520 | return $params; |
518 | 521 | } |
519 | 522 | |
523 | + /** |
|
524 | + * @param string $data |
|
525 | + */ |
|
520 | 526 | function _hmac($key, $data) { |
521 | 527 | if (function_exists('hash_hmac')) { |
522 | 528 | return hash_hmac('md5', $data, $key); |
@@ -587,6 +587,11 @@ |
||
587 | 587 | } |
588 | 588 | return $this->_check; |
589 | 589 | } |
590 | + |
|
591 | + /** |
|
592 | + * @param string $order_status |
|
593 | + * @param boolean $set_to_public |
|
594 | + */ |
|
590 | 595 | function set_order_status($order_status, $set_to_public) |
591 | 596 | { |
592 | 597 | $status_id = 0; |
@@ -647,6 +647,10 @@ |
||
647 | 647 | return number_format(tep_round($number * $currency_value, $currencies->currencies[$currency_code]['decimal_places']), $currencies->currencies[$currency_code]['decimal_places'], '.', ''); |
648 | 648 | } |
649 | 649 | |
650 | + /** |
|
651 | + * @param string $url |
|
652 | + * @param string $parameters |
|
653 | + */ |
|
650 | 654 | function sendTransactionToGateway($url, $parameters, $with_headers = false) { |
651 | 655 | $server = parse_url($url); |
652 | 656 |
@@ -329,6 +329,9 @@ discard block |
||
329 | 329 | return $this->_check; |
330 | 330 | } |
331 | 331 | |
332 | + /** |
|
333 | + * @param string $parameter |
|
334 | + */ |
|
332 | 335 | function install($parameter = null) { |
333 | 336 | $params = $this->getParams(); |
334 | 337 | |
@@ -474,6 +477,10 @@ discard block |
||
474 | 477 | return $params; |
475 | 478 | } |
476 | 479 | |
480 | + /** |
|
481 | + * @param string $url |
|
482 | + * @param string $parameters |
|
483 | + */ |
|
477 | 484 | function sendTransactionToGateway($url, $parameters) { |
478 | 485 | $server = parse_url($url); |
479 | 486 | |
@@ -578,6 +585,9 @@ discard block |
||
578 | 585 | return (is_numeric($number) && isset($this->_error_messages[$number])); |
579 | 586 | } |
580 | 587 | |
588 | + /** |
|
589 | + * @param null|string $url |
|
590 | + */ |
|
581 | 591 | function formatURL($url) { |
582 | 592 | return str_replace('&', '&', $url); |
583 | 593 | } |