osCommerce / oscommerce2

catalog/admin/includes/functions/general.php

Doc Comments +38 added lines

@@ -124,6 +124,9 @@ 
 
   }
 
+  /**
+   * @param string $raw_datetime
+   */
   function tep_datetime_short($raw_datetime) {
     if ( ($raw_datetime == '0000-00-00 00:00:00') || ($raw_datetime == '') ) return false;
 
@@ -261,6 +264,9 @@ 
     return $image;
   }
 
+  /**
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -373,6 +379,11 @@ 
     return $geo_zone_id;
   }
 
+  /**
+   * @param boolean $html
+   * @param string $boln
+   * @param string $eoln
+   */
   function tep_address_format($address_format_id, $address, $html, $boln, $eoln) {
     $Qaddress = Registry::get('Db')->get('address_format', 'address_format', ['address_format_id' => (int)$address_format_id]);
 
@@ -469,6 +480,9 @@ 
     return $def_state;
   }
 
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     $uprid = $prid;
     if ( (is_array($params)) && (!strstr($prid, '{')) ) {
@@ -576,6 +590,9 @@ 
 ////
 // Wrapper for class_exists() function
 // This function is not available in all PHP versions so we test it before using it.
+  /**
+   * @param string $class_name
+   */
   function tep_class_exists($class_name) {
     if (function_exists('class_exists')) {
       return class_exists($class_name);
@@ -771,6 +788,9 @@ 
 
 ////
 // Sets the status of a banner
+  /**
+   * @param integer $status
+   */
   function tep_set_banner_status($banners_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -845,6 +865,9 @@ 
 
 ////
 // Sets the status of a product on special
+  /**
+   * @param integer $status
+   */
   function tep_set_specials_status($specials_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -1261,6 +1284,11 @@ 
     return $value;
   }
 
+  /**
+   * @param string $to_name
+   * @param string $email_subject
+   * @param string $email_text
+   */
   function tep_mail($to_name, $to_email_address, $email_subject, $email_text, $from_email_name, $from_email_address) {
     if (SEND_EMAILS != 'true') return false;
 
@@ -1312,6 +1340,9 @@ 
 
 ////
 // Wrapper function for round() for php3 compatibility
+  /**
+   * @return double
+   */
   function tep_round($value, $precision) {
     return round($value, $precision);
   }
@@ -1454,6 +1485,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1469,6 +1504,9 @@ 
   }
 
 // nl2br() prior PHP 4.2.0 did not convert linefeeds on all OSs (it only converted \n)
+  /**
+   * @param string[] $from
+   */
   function tep_convert_linefeeds($from, $to, $string) {
       return str_replace($from, $to, $string);
   }

catalog/includes/functions/general.php

Doc Comments +29 added lines

@@ -78,6 +78,9 @@ 
 
 ////
 // Break a word in a string if it is longer than a specified length ($len)
+  /**
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -245,6 +248,9 @@ 
 
 ////
 // Wrapper function for round()
+  /**
+   * @return double
+   */
   function tep_round($number, $precision) {
     if (strpos($number, '.') && (strlen(substr($number, strpos($number, '.')+1)) > $precision)) {
       $number = substr($number, 0, strpos($number, '.') + 1 + $precision + 1);
@@ -424,6 +430,11 @@ 
 ////
 // Return a formatted address
 // TABLES: address_format
+  /**
+   * @param boolean $html
+   * @param string $boln
+   * @param string $eoln
+   */
   function tep_address_format($address_format_id, $address, $html, $boln, $eoln) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -952,6 +963,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;
@@ -1033,6 +1047,11 @@ 
 // $from_email_adress The eMail address of the sender,
 //                    e.g. info@mytepshop.com
 
+  /**
+   * @param string $to_name
+   * @param string $email_subject
+   * @param string $email_text
+   */
   function tep_mail($to_name, $to_email_address, $email_subject, $email_text, $from_email_name, $from_email_address) {
     if (SEND_EMAILS != 'true') return false;
 
@@ -1092,6 +1111,9 @@ 
     return tep_count_modules(MODULE_SHIPPING_INSTALLED);
   }
 
+  /**
+   * @param integer $length
+   */
   function tep_create_random_value($length, $type = 'mixed') {
     if ( ($type != 'mixed') && ($type != 'chars') && ($type != 'digits')) $type = 'mixed';
 
@@ -1247,6 +1269,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
 
     if (isset($min) && isset($max)) {
@@ -1366,6 +1392,9 @@ 
   }
 
 // Convert linefeeds
+  /**
+   * @param string[] $from
+   */
   function tep_convert_linefeeds($from, $to, $string) {
       return str_replace($from, $to, $string);
   }