osCommerce / oscommerce2

catalog/includes/classes/http_client.php

Doc Comments +5 added lines, -4 removed lines

@@ -109,7 +109,7 @@ 
 /**
  * addHeader
  * set a unique request header
- * @param headerName the header name
+ * @param headerName string header name
  * @param headerValue the header value, ( unencoded)
  **/
     function addHeader($headerName, $headerValue) {
@@ -119,7 +119,7 @@ 
 /**
  * removeHeader
  * unset a request header
- * @param headerName the header name
+ * @param headerName string header name
  **/
     function removeHeader($headerName) {
       unset($this->requestHeaders[$headerName]);
@@ -307,7 +307,8 @@ 
  * a) the command
  * b) the request headers if they are defined
  * c) the request body if defined
- * @return string the server repsonse status code
+ * @param string $command
+ * @return boolean|null the server repsonse status code
  **/
     function sendCommand($command) {
       $this->responseHeaders = array();
@@ -430,7 +431,7 @@ 
 /**
  * Calculate and return the URI to be sent ( proxy purpose )
  * @param the local URI
- * @return URI to be used in the HTTP request
+ * @return string to be used in the HTTP request
  * @scope private
  **/
     function makeUri($uri) {

catalog/includes/classes/mime.php

Doc Comments +1 added lines, -1 removed lines

@@ -145,7 +145,7 @@
  * @param $body   The body of the subpart, if any.
  * @param $params The parameters for the subpart, same
  *                as the $params argument for constructor.
- * @return A reference to the part you just added. It is
+ * @return mime reference to the part you just added. It is
  *         crucial if using multipart/* in your subparts that
  *         you use =& in your script when calling this function,
  *         otherwise you will not be able to add further subparts.

catalog/includes/classes/passwordhash.php

Doc Comments +16 added lines

@@ -35,6 +35,10 @@ 
 	var $portable_hashes;
 	var $random_state;
 
+	/**
+	 * @param integer $iteration_count_log2
+	 * @param boolean $portable_hashes
+	 */
 	function PasswordHash($iteration_count_log2, $portable_hashes)
 	{
 		$this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
@@ -84,6 +88,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	function encode64($input, $count)
 	{
 		$output = '';
@@ -107,6 +114,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_private($input)
 	{
 		$output = '$P$';
@@ -155,6 +165,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_extended($input)
 	{
 		$count_log2 = min($this->iteration_count_log2 + 8, 24);
@@ -173,6 +186,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/banner.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
 
 ////
 // Sets the status of a banner
+  /**
+   * @param integer $status
+   */
   function tep_set_banner_status($banners_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 

catalog/includes/functions/cache.php

Doc Comments +7 added lines

@@ -15,6 +15,9 @@ 
 //  write_cache uses serialize() to store $var in $filename.
 //  $var      -  The variable to be written out.
 //  $filename -  The name of the file to write to.
+  /**
+   * @param string $filename
+   */
   function write_cache(&$var, $filename) {
     $filename = DIR_FS_CACHE . $filename;
     $success = false;
@@ -40,6 +43,10 @@ 
 //  fills $var using unserialize().
 //  $var      -  The variable to be filled.
 //  $filename -  The name of the file to read.
+  /**
+   * @param string $var
+   * @param string $filename
+   */
   function read_cache(&$var, $filename, $auto_expire = false){
     $filename = DIR_FS_CACHE . $filename;
     $success = false;

catalog/includes/functions/general.php

Doc Comments +35 added lines

@@ -121,6 +121,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 = '';
@@ -244,6 +247,9 @@ 
 
 ////
 // Returns the clients browser
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     return stristr($_SERVER['HTTP_USER_AGENT'], $component);
   }
@@ -294,6 +300,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);
@@ -473,6 +482,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');
 
@@ -1001,6 +1015,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;
@@ -1094,6 +1111,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;
 
@@ -1153,6 +1175,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';
 
@@ -1308,6 +1333,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
 
     if (isset($min) && isset($max)) {
@@ -1321,6 +1350,9 @@ 
     }
   }
 
+  /**
+   * @param string $name
+   */
   function tep_setcookie($name, $value = '', $expire = 0, $path = null, $domain = null, $secure = 0) {
     global $cookie_path, $cookie_domain;
 
@@ -1433,6 +1465,9 @@ 
   }
 
 // Convert linefeeds
+  /**
+   * @param string[] $from
+   */
   function tep_convert_linefeeds($from, $to, $string) {
       return str_replace($from, $to, $string);
   }

catalog/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/specials.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/includes/functions/whos_online.php

Doc Comments +4 added lines

@@ -60,6 +60,10 @@
     }
   }
 
+  /**
+   * @param string $old_id
+   * @param string $new_id
+   */
   function tep_whos_online_update_session_id($old_id, $new_id) {
     $OSCOM_Db = Registry::get('Db');