osCommerce / oscommerce2

catalog/admin/includes/functions/password_funcs.php

Doc Comments +6 added lines

@@ -13,6 +13,9 @@ 
 ////
 // This function validates a plain text password with a
 // salted or phpass password
+  /**
+   * @param string $plain
+   */
   function tep_validate_password($plain, $encrypted) {
     if (tep_not_null($plain) && tep_not_null($encrypted)) {
       if (tep_password_type($encrypted) == 'salt') {
@@ -52,6 +55,9 @@ 
 ////
 // This function encrypts a phpass password from a plaintext
 // password.
+  /**
+   * @param string $plain
+   */
   function tep_encrypt_password($plain) {
     if (!class_exists('PasswordHash')) {
       include(DIR_WS_CLASSES . 'passwordhash.php');

catalog/includes/functions/banner.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 
 ////
 // Sets the status of a special product
+  /**
+   * @param integer $status
+   */
   function tep_set_specials_status($specials_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 

catalog/admin/includes/classes/rss.php

Doc Comments +9 added lines

@@ -53,6 +53,11 @@ 
     // -------------------------------------------------------------------
     // Parse RSS file and returns associative array.
     // -------------------------------------------------------------------
+
+    /**
+     * @param string $rss_url
+     * @param string $key
+     */
     function Get ($rss_url, $key = null) {
         // If CACHE ENABLED
         if ($this->cache_dir != '') {
@@ -114,6 +119,10 @@ 
     // -------------------------------------------------------------------
     // Replace HTML entities &something; by real characters
     // -------------------------------------------------------------------
+
+    /**
+     * @param string $string
+     */
     function unhtmlentities ($string) {
         // Get HTML entities table
         $trans_tbl = get_html_translation_table (HTML_ENTITIES, ENT_QUOTES);

catalog/admin/includes/functions/general.php

Doc Comments +41 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 = '';
@@ -317,6 +323,9 @@ 
     }
   }
 
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     global $HTTP_USER_AGENT;
 
@@ -379,6 +388,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]);
 
@@ -475,6 +489,9 @@ 
     return $def_state;
   }
 
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     $uprid = $prid;
     if ( (is_array($params)) && (!strstr($prid, '{')) ) {
@@ -582,6 +599,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);
@@ -787,6 +807,9 @@ 
 
 ////
 // Sets the status of a banner
+  /**
+   * @param integer $status
+   */
   function tep_set_banner_status($banners_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -861,6 +884,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');
 
@@ -1276,6 +1302,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;
 
@@ -1327,6 +1358,9 @@ 
 
 ////
 // Wrapper function for round() for php3 compatibility
+  /**
+   * @return double
+   */
   function tep_round($value, $precision) {
     return round($value, $precision);
   }
@@ -1469,6 +1503,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1484,6 +1522,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/admin/includes/modules/security_check/extended/ext_directory_listing.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
       return MODULE_SECURITY_CHECK_EXTENDED_EXT_DIRECTORY_LISTING_HTTP_200;
     }
 
+    /**
+     * @param string $url
+     */
     function getHttpRequest($url) {
       $server = parse_url($url);
 

catalog/includes/classes/category_tree.php

Doc Comments +10 added lines

@@ -54,6 +54,9 @@ 
       }
     }
 
+    /**
+     * @param integer $parent_id
+     */
     protected function _buildBranch($parent_id, $level = 0) {
       $result = ((($level === 0) && ($this->parent_group_apply_to_root === true)) || ($level > 0)) ? $this->parent_group_start_string : null;
 
@@ -278,6 +281,10 @@ 
       $this->parent_end_string = $parent_end_string;
     }
 
+    /**
+     * @param string $parent_group_start_string
+     * @param string $parent_group_end_string
+     */
     function setParentGroupString($parent_group_start_string, $parent_group_end_string, $apply_to_root = false) {
       $this->parent_group_start_string = $parent_group_start_string;
       $this->parent_group_end_string = $parent_group_end_string;
@@ -301,6 +308,9 @@ 
       }
     }
 
+    /**
+     * @param string $spacer_string
+     */
     function setSpacerString($spacer_string, $spacer_multiplier = 2) {
       $this->spacer_string = $spacer_string;
       $this->spacer_multiplier = $spacer_multiplier;

catalog/includes/classes/passwordhash.php

Doc Comments +12 added lines

@@ -84,6 +84,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	function encode64($input, $count)
 	{
 		$output = '';
@@ -107,6 +110,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_private($input)
 	{
 		$output = '$P$';
@@ -155,6 +161,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_extended($input)
 	{
 		$count_log2 = min($this->iteration_count_log2 + 8, 24);
@@ -173,6 +182,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_blowfish($input)
 	{
 		# This one needs to use a different order of characters and a

catalog/includes/functions/general.php

Doc Comments +32 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 = '';
@@ -201,6 +204,9 @@ 
 
 ////
 // Returns the clients browser
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     return stristr($_SERVER['HTTP_USER_AGENT'], $component);
   }
@@ -251,6 +257,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);
@@ -430,6 +439,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');
 
@@ -958,6 +972,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;
@@ -1039,6 +1056,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;
 
@@ -1098,6 +1120,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 +1278,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
 
     if (isset($min) && isset($max)) {
@@ -1372,6 +1401,9 @@ 
   }
 
 // Convert linefeeds
+  /**
+   * @param string[] $from
+   */
   function tep_convert_linefeeds($from, $to, $string) {
       return str_replace($from, $to, $string);
   }

catalog/includes/OSC/OM/FileSystem.php

Doc Comments +3 added lines

@@ -71,6 +71,9 @@
         return $result;
     }
 
+    /**
+     * @param string $pathname
+     */
     public static function displayPath($pathname)
     {
         return str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $pathname);