osCommerce / oscommerce2

catalog/admin/includes/classes/phplot.php

Doc Comments +78 added lines

@@ -301,6 +301,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $which_input_file
+	 */
 	function SetInputFile($which_input_file) {
 		//$this->SetFileFormat($which_frmt);
 		$size = GetImageSize($which_input_file);
@@ -343,6 +346,9 @@ 
 
 	}
 
+	/**
+	 * @param string $which_output_file
+	 */
 	function SetOutputFile($which_output_file) {
 		$this->output_file = $which_output_file;
 		return true;
@@ -718,11 +724,18 @@ 
 			$this->ndx_plot_bg_color);
 	}
 
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetBackgroundColor($which_color) {
 		$this->bg_color= $which_color;
 		$this->ndx_bg_color= $this->SetIndexColor($which_color);
 		return true;
 	}
+
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetPlotBgColor($which_color) {
 		$this->plot_bg_color= $which_color;
 		$this->ndx_plot_bg_color= $this->SetIndexColor($which_color);
@@ -734,36 +747,54 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetTitleColor($which_color) {
 		$this->title_color= $which_color;
 		$this->ndx_title_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetTickColor ($which_color) {
 		$this->tick_color= $which_color;
 		$this->ndx_tick_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetLabelColor ($which_color) {
 		$this->label_color= $which_color;
 		$this->ndx_label_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetTextColor ($which_color) {
 		$this->text_color= $which_color;
 		$this->ndx_text_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param integer[] $which_color
+	 */
 	function SetLightGridColor ($which_color) {
 		$this->light_grid_color= $which_color;
 		$this->ndx_light_grid_color= $this->SetIndexColor($which_color);
 		return true;
 	}
 
+	/**
+	 * @param string $which_color
+	 */
 	function SetGridColor ($which_color) {
 		$this->grid_color = $which_color;
 		$this->ndx_grid_color= $this->SetIndexColor($which_color);
@@ -993,6 +1024,12 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $x1
+	 * @param string $y1
+	 * @param string $x2
+	 * @param string $y2
+	 */
 	function SetPlotAreaPixels($x1,$y1,$x2,$y2) {
 		//Like in GD 0,0 is upper left
 		if (!$this->x_tot_margin) {
@@ -1013,6 +1050,12 @@ 
 
 	}
 
+	/**
+	 * @param string $xmin
+	 * @param string $ymin
+	 * @param string $xmax
+	 * @param string $ymax
+	 */
 	function SetPlotAreaWorld($xmin,$ymin,$xmax,$ymax) {
 		if (($xmin == "")  && ($xmax == "")) {
 			//For automatic setting of data we need $this->max_x
@@ -1077,6 +1120,9 @@ 
 		die;
 	}
 
+	/**
+	 * @param string $error_message
+	 */
 	function DrawError($error_message) {
 	// prints the error message inline into
 	// the generated image
@@ -1204,6 +1250,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $which_ps
+	 */
 	function SetPointSize($which_ps) {
 		//in pixels
 		SetType($which_ps,'integer');
@@ -1234,6 +1283,9 @@ 
 	}
 
 //////////////COLORS
+	/**
+	 * @param string $which_color_array
+	 */
 	function SetRGBArray ($which_color_array) {
 		if ( is_array($which_color_array) ) {
 			//User Defined Array
@@ -1329,6 +1381,10 @@ 
 		return $ret_val;
 	}
 
+	/**
+	 * @param string[] $which_data
+	 * @param string[] $which_border
+	 */
 	function SetDataColors($which_data,$which_border) {
 		//Set the data to be displayed in a particular color
 		if (!$which_data) {
@@ -1824,6 +1880,9 @@ 
 
 	}
 
+	/**
+	 * @param double $xpos
+	 */
 	function DrawXDataLabel($xlab,$xpos) {
 		//xpos comes in in PIXELS not in world coordinates.
 		//Draw an x data label centered at xlab
@@ -2065,6 +2124,9 @@ 
 
 	}  //function DrawThinBarLines
 
+	/**
+	 * @param string $error_bar_type
+	 */
 	function DrawYErrorBar($x_world,$y_world,$error_height,$error_bar_type,$color) {
 		$x1 = $this->xtr($x_world);
 		$y1 = $this->ytr($y_world);
@@ -2087,6 +2149,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $dot_type
+	 */
 	function DrawDot($x_world,$y_world,$dot_type,$color) {
 		$half_point = $this->point_size / 2;
 		$x1 = $this->xtr($x_world) - $half_point;
@@ -2314,6 +2379,14 @@ 
 		return false;
 	} //function DrawLineSeries
 
+	/**
+	 * @param double $x1pix
+	 * @param double $y1pix
+	 * @param double $x2pix
+	 * @param double $y2pix
+	 * @param integer $dash_length
+	 * @param integer $dash_space
+	 */
 	function DrawDashedLine($x1pix,$y1pix,$x2pix,$y2pix,$dash_length,$dash_space,$color) {
 		//Code based on work by Ariel Garza and James Pine
 		//I've decided to have this be in pixels only as a replacement for ImageLine
@@ -2402,6 +2475,11 @@ 
 		}
 	} //function DrawBars
 
+	/**
+	 * @param string $which_x1
+	 * @param string $which_y1
+	 * @param string $which_boxtype
+	 */
 	function DrawLegend($which_x1,$which_y1,$which_boxtype) {
 		//Base code submitted by Marlin Viss
 		$max_legend_length=0;

catalog/admin/includes/functions/compatibility.php

Doc Comments +11 added lines

@@ -70,6 +70,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);
@@ -89,6 +93,10 @@ 
  */
 
   if ( !function_exists('http_build_query') && (PHP_VERSION >= 4)) {
+
+    /**
+     * @param string $arg_separator
+     */
     function http_build_query($formdata, $numeric_prefix = null, $arg_separator = null) {
 // If $formdata is an object, convert it to an array
       if ( is_object($formdata) ) {
@@ -140,6 +148,9 @@ 
     }
 
 // Helper function
+    /**
+     * @param string $name
+     */
     function http_build_query_helper($array, $name, $arg_separator) {
       $tmp = array();
 

catalog/admin/includes/functions/database.php

Doc Comments +13 added lines

@@ -34,6 +34,10 @@ 
     return mysqli_close($$link);
   }
 
+  /**
+   * @param integer $errno
+   * @param string $error
+   */
   function tep_db_error($query, $errno, $error) {
     global $logger;
 
@@ -57,6 +61,9 @@ 
     return $result;
   }
 
+  /**
+   * @param string $table
+   */
   function tep_db_perform($table, $data, $action = 'insert', $parameters = '', $link = 'db_link') {
     if ($action == 'insert') {
       $query = 'insert into ' . $table . ' (';
@@ -204,6 +211,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);
@@ -234,6 +244,9 @@ 
       return mysql_error($link);
     }
 
+    /**
+     * @param integer $type
+     */
     function mysqli_fetch_array($query, $type) {
       return mysql_fetch_array($query, $type);
     }

catalog/admin/includes/functions/general.php

Doc Comments +45 added lines

@@ -174,6 +174,9 @@ 
 
   }
 
+  /**
+   * @param string $raw_datetime
+   */
   function tep_datetime_short($raw_datetime) {
     if ( ($raw_datetime == '0000-00-00 00:00:00') || ($raw_datetime == '') ) return false;
 
@@ -288,6 +291,10 @@ 
     return $image;
   }
 
+  /**
+   * @param string $string
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -345,6 +352,9 @@ 
     }
   }
 
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     return stristr(getenv('HTTP_USER_AGENT'), $component);
   }
@@ -388,6 +398,11 @@ 
     return $geo_zone_name;
   }
 
+  /**
+   * @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);
@@ -485,6 +500,9 @@ 
     return $state_prov_code;
   }
 
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     $uprid = $prid;
     if ( (is_array($params)) && (!strstr($prid, '{')) ) {
@@ -584,6 +602,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);
@@ -743,6 +764,9 @@ 
 
 ////
 // Sets the status of a banner
+  /**
+   * @param string $status
+   */
   function tep_set_banner_status($banners_id, $status) {
     if ($status == '1') {
       return tep_db_query("update " . TABLE_BANNERS . " set status = '1', expires_impressions = NULL, expires_date = NULL, date_status_change = NULL where banners_id = '" . (int)$banners_id . "'");
@@ -779,6 +803,9 @@ 
 
 ////
 // Sets the status of a product on special
+  /**
+   * @param string $status
+   */
   function tep_set_specials_status($specials_id, $status) {
     if ($status == '1') {
       return tep_db_query("update " . TABLE_SPECIALS . " set status = '1', expires_date = NULL, date_status_change = NULL where specials_id = '" . (int)$specials_id . "'");
@@ -1028,6 +1055,9 @@ 
     tep_db_query("delete from " . TABLE_ORDERS_TOTAL . " where orders_id = '" . (int)$order_id . "'");
   }
 
+  /**
+   * @param string $cache_block
+   */
   function tep_reset_cache_block($cache_block) {
     global $cache_blocks;
 
@@ -1171,6 +1201,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;
 
@@ -1223,6 +1258,9 @@ 
 
 ////
 // Wrapper function for round() for php3 compatibility
+  /**
+   * @return double
+   */
   function tep_round($value, $precision) {
     return round($value, $precision);
   }
@@ -1339,6 +1377,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1362,6 +1404,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/database.php

Doc Comments +13 added lines

@@ -34,6 +34,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);
@@ -54,6 +58,9 @@ 
     return $result;
   }
 
+  /**
+   * @param string $table
+   */
   function tep_db_perform($table, $data, $action = 'insert', $parameters = '', $link = 'db_link') {
     if ($action == 'insert') {
       $query = 'insert into ' . $table . ' (';
@@ -190,6 +197,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);
@@ -220,6 +230,9 @@ 
       return mysql_error($link);
     }
 
+    /**
+     * @param integer $type
+     */
     function mysqli_fetch_array($query, $type) {
       return mysql_fetch_array($query, $type);
     }