osCommerce / oscommerce2

catalog/includes/functions/compatibility.php

Doc Comments +4 added lines

@@ -55,6 +55,10 @@
   }
 
   if (!function_exists('checkdnsrr')) {
+
+    /**
+     * @param string $type
+     */
     function checkdnsrr($host, $type) {
       if(tep_not_null($host) && tep_not_null($type)) {
         @exec("nslookup -type=" . escapeshellarg($type) . " " . escapeshellarg($host), $output);

catalog/includes/functions/database.php

Doc Comments +13 added lines

@@ -32,6 +32,10 @@ 
     return mysqli_close($$link);
   }
 
+  /**
+   * @param integer $errno
+   * @param string $error
+   */
   function tep_db_error($query, $errno, $error) { 
     if (defined('STORE_DB_TRANSACTIONS') && (STORE_DB_TRANSACTIONS == 'true')) {
       error_log('ERROR: [' . $errno . '] ' . $error . "\n", 3, STORE_PAGE_PARSE_TIME_LOG);
@@ -52,6 +56,9 @@ 
     return $result;
   }
 
+  /**
+   * @param string $table
+   */
   function tep_db_perform($table, $data, $action = 'insert', $parameters = '', $link = 'db_link') {
     reset($data);
     if ($action == 'insert') {
@@ -191,6 +198,9 @@ 
       return mysql_error($link);
     }
 
+    /**
+     * @param string $charset
+     */
     function mysqli_set_charset($link, $charset) {
       if ( function_exists('mysql_set_charset') ) {
         return mysql_set_charset($charset, $link);
@@ -221,6 +231,9 @@ 
       return mysql_error($link);
     }
 
+    /**
+     * @param integer $type
+     */
     function mysqli_fetch_array($query, $type) {
       return mysql_fetch_array($query, $type);
     }

catalog/includes/functions/general.php

Doc Comments +36 added lines

@@ -81,6 +81,9 @@ 
 
 ////
 // Return a random row from a database query
+  /**
+   * @param string $query
+   */
   function tep_random_select($query) {
     $random_product = '';
     $random_query = tep_db_query($query);
@@ -145,6 +148,10 @@ 
 
 ////
 // Break a word in a string if it is longer than a specified length ($len)
+  /**
+   * @param string $string
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -260,6 +267,9 @@ 
 
 ////
 // Returns the clients browser
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     global $HTTP_USER_AGENT;
 
@@ -302,6 +312,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);
@@ -448,6 +461,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) {
     $address_format_query = tep_db_query("select address_format as format from " . TABLE_ADDRESS_FORMAT . " where address_format_id = '" . (int)$address_format_id . "'");
     $address_format = tep_db_fetch_array($address_format_query);
@@ -940,6 +958,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;
@@ -1036,6 +1057,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;
 
@@ -1104,6 +1130,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';
 
@@ -1253,6 +1282,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1386,6 +1419,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) {
     if ((PHP_VERSION < "4.0.5") && is_array($from)) {
       return preg_replace('/(' . implode('|', $from) . ')/', $to, $string);

catalog/includes/functions/html_output.php

Doc Comments +22 added lines

@@ -117,6 +117,9 @@ 
 ////
 // The HTML form submit button wrapper function
 // Outputs a button in the selected language
+  /**
+   * @param string $image
+   */
   function tep_image_submit($image, $alt = '', $parameters = '') {
     global $language;
 
@@ -147,6 +150,9 @@ 
 
 ////
 // Output a form
+  /**
+   * @param string $name
+   */
   function tep_draw_form($name, $action, $method = 'post', $parameters = '', $tokenize = false) {
     global $sessiontoken;
 
@@ -197,6 +203,9 @@ 
 
 ////
 // Output a selection field - alias function for tep_draw_checkbox_field() and tep_draw_radio_field()
+  /**
+   * @param string $type
+   */
   function tep_draw_selection_field($name, $type, $value = '', $checked = false, $parameters = '') {
     global $HTTP_GET_VARS, $HTTP_POST_VARS;
 
@@ -217,6 +226,9 @@ 
 
 ////
 // Output a form checkbox field
+  /**
+   * @param string $name
+   */
   function tep_draw_checkbox_field($name, $value = '', $checked = false, $parameters = '') {
     return tep_draw_selection_field($name, 'checkbox', $value, $checked, $parameters);
   }
@@ -230,6 +242,10 @@ 
 ////
 // Output a form textarea field
 // The $wrap parameter is no longer used in the core xhtml template
+  /**
+   * @param string $name
+   * @param string|false $wrap
+   */
   function tep_draw_textarea_field($name, $wrap, $width, $height, $text = '', $parameters = '', $reinsert_value = true) {
     global $HTTP_GET_VARS, $HTTP_POST_VARS;
 
@@ -337,6 +353,12 @@ 
 
 ////
 // Output a jQuery UI Button
+  /**
+   * @param string $title
+   * @param string $icon
+   * @param string $link
+   * @param string $priority
+   */
   function tep_draw_button($title = null, $icon = null, $link = null, $priority = null, $params = null) {
     static $button_counter = 1;
 

catalog/includes/functions/sessions.php

Doc Comments +9 added lines

@@ -91,6 +91,9 @@ 
     return session_start();
   }
 
+  /**
+   * @param string $variable
+   */
   function tep_session_register($variable) {
     if (!isset($GLOBALS[$variable])) {
       $GLOBALS[$variable] = null;
@@ -101,10 +104,16 @@ 
     return false;
   }
 
+  /**
+   * @param string $variable
+   */
   function tep_session_is_registered($variable) {
     return isset($_SESSION) && array_key_exists($variable, $_SESSION);
   }
 
+  /**
+   * @param string $variable
+   */
   function tep_session_unregister($variable) {
     unset($_SESSION[$variable]);
   }

catalog/includes/functions/specials.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 
 ////
 // Sets the status of a special product
+  /**
+   * @param string $status
+   */
   function tep_set_specials_status($specials_id, $status) {
     return tep_db_query("update " . TABLE_SPECIALS . " set status = '" . (int)$status . "', date_status_change = now() where specials_id = '" . (int)$specials_id . "'");
   }

catalog/includes/modules/content/login/cm_paypal_login.php

Doc Comments +3 added lines

@@ -312,6 +312,9 @@
       return array('OSCOM_APP_PAYPAL_LOGIN_CONTENT_WIDTH', 'OSCOM_APP_PAYPAL_LOGIN_SORT_ORDER');
     }
 
+    /**
+     * @param string $attribute
+     */
     function hasAttribute($attribute) {
       return in_array($attribute, explode(';', OSCOM_APP_PAYPAL_LOGIN_ATTRIBUTES));
     }

catalog/includes/modules/payment/authorizenet_cc_aim.php

Doc Comments +7 added lines

@@ -436,6 +436,9 @@ 
       return $this->_check;
     }
 
+    /**
+     * @param string $parameter
+     */
     function install($parameter = null) {
       $params = $this->getParams();
 
@@ -598,6 +601,10 @@ 
       return md5($k_opad . pack("H*",md5($k_ipad . $data)));
     }
 
+    /**
+     * @param string $url
+     * @param string $parameters
+     */
     function sendTransactionToGateway($url, $parameters) {
       $server = parse_url($url);
 

catalog/includes/modules/payment/authorizenet_cc_sim.php

Doc Comments +6 added lines

@@ -343,6 +343,9 @@ 
       return $this->_check;
     }
 
+    /**
+     * @param string $parameter
+     */
     function install($parameter = null) {
       $params = $this->getParams();
 
@@ -473,6 +476,9 @@ 
       return $params;
     }
 
+    /**
+     * @param string $data
+     */
     function _hmac($key, $data) {
       if (function_exists('hash_hmac')) {
         return hash_hmac('md5', $data, $key);