osCommerce / oscommerce2

catalog/admin/ext/modules/payment/sofortueberweisung/install.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
 
   define('OSC_CATALOG_SESSION_ID', 'osCsid');
 
+  /**
+   * @param integer $length
+   */
   function tep_create_random_value($length, $type = 'mixed') {
     if ( ($type != 'mixed') && ($type != 'chars') && ($type != 'digits')) return false;
 

catalog/admin/includes/classes/logger.php

Doc Comments +3 added lines

@@ -45,6 +45,9 @@
       return '<span class="smallText">Parse Time: ' . $this->timer_total . 's</span>';
     }
 
+    /**
+     * @param string $type
+     */
     function write($message, $type) {
       error_log(strftime(STORE_PARSE_DATE_TIME_FORMAT) . ' [' . $type . '] ' . $message . "\n", 3, STORE_PAGE_PARSE_TIME_LOG);
     }

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;
@@ -719,11 +725,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);
@@ -735,36 +748,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);
@@ -997,6 +1028,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) {
@@ -1017,6 +1054,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
@@ -1081,6 +1124,9 @@ 
 		die;
 	}
 
+	/**
+	 * @param string $error_message
+	 */
 	function DrawError($error_message) {
 	// prints the error message inline into
 	// the generated image
@@ -1208,6 +1254,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $which_ps
+	 */
 	function SetPointSize($which_ps) {
 		//in pixels
 		SetType($which_ps,'integer');
@@ -1238,6 +1287,9 @@ 
 	}
 
 //////////////COLORS
+	/**
+	 * @param string $which_color_array
+	 */
 	function SetRGBArray ($which_color_array) { 
 		if ( is_array($which_color_array) ) { 
 			//User Defined Array
@@ -1333,6 +1385,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) {
@@ -1833,6 +1889,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
@@ -2083,6 +2142,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);
@@ -2105,6 +2167,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;
@@ -2344,6 +2409,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
@@ -2434,6 +2507,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/classes/rss.php

Doc Comments +8 added lines

@@ -53,6 +53,10 @@ 
     // -------------------------------------------------------------------
     // Parse RSS file and returns associative array.
     // -------------------------------------------------------------------
+
+    /**
+     * @param string $rss_url
+     */
     function Get ($rss_url) {
         // If CACHE ENABLED
         if ($this->cache_dir != '') {
@@ -114,6 +118,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/classes/upload.php

Doc Comments +12 added lines

@@ -108,10 +108,16 @@ 
       $this->file = $file;
     }
 
+    /**
+     * @param string $destination
+     */
     function set_destination($destination) {
       $this->destination = $destination;
     }
 
+    /**
+     * @param string $permissions
+     */
     function set_permissions($permissions) {
       $this->permissions = octdec($permissions);
     }
@@ -124,6 +130,9 @@ 
       $this->tmp_filename = $filename;
     }
 
+    /**
+     * @param string $extensions
+     */
     function set_extensions($extensions) {
       if (tep_not_null($extensions)) {
         if (is_array($extensions)) {
@@ -160,6 +169,9 @@ 
       }
     }
 
+    /**
+     * @param string $location
+     */
     function set_output_messages($location) {
       switch ($location) {
         case 'session':

catalog/admin/includes/functions/database.php

Doc Comments +7 added lines

@@ -32,6 +32,10 @@ 
     return mysqli_close($$link);
   }
 
+  /**
+   * @param integer $errno
+   * @param string $error
+   */
   function tep_db_error($query, $errno, $error) {
     global $logger;
 
@@ -42,6 +46,9 @@ 
     die('<font color="#000000"><strong>' . $errno . ' - ' . $error . '<br /><br />' . $query . '<br /><br /><small><font color="#ff0000">[TEP STOP]</font></small><br /><br /></strong></font>');
   }
 
+  /**
+   * @param string $query
+   */
   function tep_db_query($query, $link = 'db_link') {
     global $$link, $logger;
 

catalog/admin/includes/functions/general.php

Doc Comments +47 added lines

@@ -24,6 +24,9 @@ 
 
 ////
 // Redirect to another page or site
+  /**
+   * @param null|string $url
+   */
   function tep_redirect($url) {
     global $logger;
 
@@ -165,6 +168,9 @@ 
 
   }
 
+  /**
+   * @param string $raw_datetime
+   */
   function tep_datetime_short($raw_datetime) {
     if ( ($raw_datetime == '0000-00-00 00:00:00') || ($raw_datetime == '') ) return false;
 
@@ -275,6 +281,9 @@ 
     return $image;
   }
 
+  /**
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -332,6 +341,9 @@ 
     }
   }
 
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     global $HTTP_USER_AGENT;
 
@@ -377,6 +389,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);
@@ -474,6 +491,9 @@ 
     return $state_prov_code;
   }
 
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     $uprid = $prid;
     if ( (is_array($params)) && (!strstr($prid, '{')) ) {
@@ -571,6 +591,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);
@@ -730,6 +753,9 @@ 
 
 ////
 // Sets the status of a banner
+  /**
+   * @param integer $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 = '" . $banners_id . "'");
@@ -766,6 +792,9 @@ 
 
 ////
 // Sets the status of a product on special
+  /**
+   * @param integer $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 . "'");
@@ -1014,6 +1043,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;
 
@@ -1157,6 +1189,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;
 
@@ -1209,6 +1246,9 @@ 
 
 ////
 // Wrapper function for round() for php3 compatibility
+  /**
+   * @return double
+   */
   function tep_round($value, $precision) {
     return round($value, $precision);
   }
@@ -1325,6 +1365,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1340,6 +1384,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/functions/html_graphs.php

Doc Comments +8 added lines

@@ -231,6 +231,10 @@ 
 
 ////
 // prints out the actual data for the double horizontal chart
+  /**
+   * @param integer $dvalues
+   * @param integer $dbars
+   */
   function double_horizontal_graph($names, $values, $bars, $vals, $dvalues, $dbars) {
     $double_horizontal_graph_string = '';
     for($i = 0, $n = sizeof($values); $i < $n; $i++) {
@@ -291,6 +295,10 @@ 
 
 ////
 // prints out the actual data for the double vertical chart
+  /**
+   * @param integer $dvalues
+   * @param integer $dbars
+   */
   function double_vertical_graph($names, $values, $bars, $vals, $dvalues, $dbars) {
     $double_vertical_graph_string = '  <tr>' . "\n";
     for ($i = 0, $n = sizeof($values); $i < $n; $i++) {

catalog/admin/includes/functions/html_output.php

Doc Comments +27 added lines

@@ -88,6 +88,9 @@ 
 
 ////
 // The HTML image wrapper function
+  /**
+   * @param string $src
+   */
   function tep_image($src, $alt = '', $width = '', $height = '', $parameters = '') {
     $image = '<img src="' . tep_output_string($src) . '" border="0" alt="' . tep_output_string($alt) . '"';
 
@@ -176,6 +179,9 @@ 
 
 ////
 // Output a form
+  /**
+   * @param string $name
+   */
   function tep_draw_form($name, $action, $parameters = '', $method = 'post', $params = '') {
     $form = '<form name="' . tep_output_string($name) . '" action="';
     if (tep_not_null($parameters)) {
@@ -237,6 +243,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, $compare = '') {
 
     $selection = '<input type="' . tep_output_string($type) . '" name="' . tep_output_string($name) . '"';
@@ -267,6 +276,12 @@ 
 ////
 // Output a form textarea field
 // The $wrap parameter is no longer used in the core xhtml template
+  /**
+   * @param string $name
+   * @param boolean $wrap
+   * @param integer $width
+   * @param integer $height
+   */
   function tep_draw_textarea_field($name, $wrap, $width, $height, $text = '', $parameters = '', $reinsert_value = true) {
 
     $field = '<textarea name="' . tep_output_string($name) . '" cols="' . tep_output_string($width) . '" rows="' . tep_output_string($height) . '"';
@@ -292,6 +307,9 @@ 
 
 ////
 // Output a form hidden field
+  /**
+   * @param string $name
+   */
   function tep_draw_hidden_field($name, $value = '', $parameters = '') {
 
     $field = '<input type="hidden" name="' . tep_output_string($name) . '"';
@@ -327,6 +345,9 @@ 
 
 ////
 // Output a form pull down menu
+  /**
+   * @param string $name
+   */
   function tep_draw_pull_down_menu($name, $values, $default = '', $parameters = '', $required = false) {
 
     $field = '<select name="' . tep_output_string($name) . '"';
@@ -360,6 +381,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;