osCommerce / oscommerce2

catalog/admin/includes/classes/logger.php

Doc Comments +4 added lines

@@ -45,6 +45,10 @@
       return '<span class="smallText">Parse Time: ' . $this->timer_total . 's</span>';
     }
 
+    /**
+     * @param string $message
+     * @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/functions/compatibility.php

Doc Comments +12 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);
@@ -74,6 +78,11 @@ 
  */
 
   if ( !function_exists('http_build_query') && (PHP_VERSION >= 4)) {
+
+    /**
+     * @param string $numeric_prefix
+     * @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) ) {
@@ -125,6 +134,9 @@ 
     }
 
 // Helper function
+    /**
+     * @param string $name
+     */
     function http_build_query_helper($array, $name, $arg_separator) {
       $tmp = array();
 

catalog/admin/includes/functions/general.php

Doc Comments +45 added lines

@@ -167,6 +167,9 @@ 
 
   }
 
+  /**
+   * @param string $raw_datetime
+   */
   function tep_datetime_short($raw_datetime) {
     if ( ($raw_datetime == '0000-00-00 00:00:00') || ($raw_datetime == '') ) return false;
 
@@ -277,6 +280,10 @@ 
     return $image;
   }
 
+  /**
+   * @param string $string
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -334,6 +341,9 @@ 
     }
   }
 
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     global $HTTP_USER_AGENT;
 
@@ -379,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);
@@ -476,6 +491,9 @@ 
     return $state_prov_code;
   }
 
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     $uprid = $prid;
     if ( (is_array($params)) && (!strstr($prid, '{')) ) {
@@ -573,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);
@@ -732,6 +753,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 = '" . $banners_id . "'");
@@ -768,6 +792,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 . "'");
@@ -1018,6 +1045,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;
 
@@ -1161,6 +1191,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;
 
@@ -1213,6 +1248,9 @@ 
 
 ////
 // Wrapper function for round() for php3 compatibility
+  /**
+   * @return double
+   */
   function tep_round($value, $precision) {
     return round($value, $precision);
   }
@@ -1329,6 +1367,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1352,6 +1394,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/ext/modules/payment/inpay/inpay_functions.php

Doc Comments +5 added lines

@@ -12,6 +12,11 @@
 /* Ensure the http_build_query is defined */

 

 if (!function_exists('http_build_query')) { 

+
+    /**
+     * @param string $prefix
+     * @param string $sep
+     */
     function http_build_query($data, $prefix='', $sep='', $key='') { 

         $ret = array(); 

         foreach ((array)$data as $k => $v) { 

catalog/includes/apps/paypal/modules/EC/EC.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
       return $this->doMigrationCheck($this->_pm_code) || $this->doMigrationCheck($this->_pm_pf_code);
     }
 
+    /**
+     * @param string $class
+     */
     function doMigrationCheck($class) {
       if ( file_exists(DIR_FS_CATALOG . 'includes/modules/payment/' . $class . '.php') ) {
         if ( !class_exists($class) ) {

catalog/includes/apps/paypal/OSCOM_PayPal.php

Doc Comments +35 added lines

@@ -42,6 +42,9 @@ 
       return $countries;
     }
 
+    /**
+     * @param integer $result
+     */
     function log($module, $action, $result, $request, $response, $server, $is_ipn = false) {
       global $customer_id;
 
@@ -182,6 +185,9 @@ 
       return false;
     }
 
+    /**
+     * @param string $info
+     */
     function getModuleInfo($module, $info) {
       $class = 'OSCOM_PayPal_' . $module;
 
@@ -196,6 +202,10 @@ 
       return $m->{'_' . $info};
     }
 
+    /**
+     * @param string $module
+     * @param string $type
+     */
     function hasCredentials($module, $type = null) {
       $server = constant('OSCOM_APP_PAYPAL_' . $module . '_STATUS');
 
@@ -230,6 +240,10 @@ 
       return true;
     }
 
+    /**
+     * @param string $module
+     * @param string $type
+     */
     function getCredentials($module, $type) {
       if ( constant('OSCOM_APP_PAYPAL_' . $module . '_STATUS') == '1' ) {
         if ( $type == 'email') {
@@ -377,6 +391,11 @@ 
     }
 
 // APP calls require $server to be "live" or "sandbox"
+    /**
+     * @param string $module
+     * @param string $call
+     * @param string $server
+     */
     function getApiResult($module, $call, $extra_params = null, $server = null, $is_ipn = false) {
       if ( $module == 'APP' ) {
         $function = 'OSCOM_PayPal_Api_' . $call;
@@ -403,6 +422,9 @@ 
       return $result['res'];
     }
 
+    /**
+     * @param string $parameters
+     */
     function makeApiCall($url, $parameters = null, $headers = null) {
       $server = parse_url($url);
 
@@ -461,6 +483,10 @@ 
       return $result;
     }
 
+    /**
+     * @param string $link
+     * @param string $type
+     */
     function drawButton($title = null, $link = null, $type = null, $params = null, $force_css = false) {
       $colours = array('success' => '#1cb841',
                        'error' => '#ca3c3c',
@@ -752,6 +778,9 @@ 
       }
     }
 
+    /**
+     * @param string $filename
+     */
     public function loadLanguageFile($filename, $lang = null) {
       global $language;
 
@@ -793,6 +822,9 @@ 
       }
     }
 
+    /**
+     * @param string $key
+     */
     function getDef($key, $values = null) {
       $def = isset($this->_definitions[$key]) ? $this->_definitions[$key] : $key;
 
@@ -863,6 +895,9 @@ 
       return str_replace('/', DIRECTORY_SEPARATOR, $pathname);
     }
 // OSCOM v2.2rc2a compatibility
+    /**
+     * @return string
+     */
     function getIpAddress() {
       if ( function_exists('tep_get_ip_address') ) {
         return tep_get_ip_address();

catalog/includes/classes/email.php

Doc Comments +6 added lines

@@ -82,6 +82,7 @@ 
  * it. This can then be given as the first
  * argument of the the functions
  * add_html_image() or add_attachment().
+ * @param string $filename
  */
 
     function get_file($filename) {
@@ -153,6 +154,7 @@ 
  * Adds a html part to the mail.
  * Also replaces image names with
  * content-id's.
+ * @param string $text
  */
 
     function add_html($html, $text = NULL, $images_dir = NULL) {
@@ -165,6 +167,7 @@ 
 /**
  * Adds an image to the list of embedded
  * images.
+ * @param string $file
  */
 
     function add_html_image($file, $name = '', $c_type='application/octet-stream') {
@@ -239,6 +242,9 @@ 
 
 /* HPDL PHP3 */
 //    function &add_alternative_part(&$obj) {
+    /**
+     * @param null|mime $obj
+     */
     function add_alternative_part(&$obj) {
       $params['content_type'] = 'multipart/alternative';
 

catalog/includes/classes/hooks.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
       $this->register('global');
     }
 
+    /**
+     * @param string $group
+     */
     function register($group) {
       $group = basename($group);
 

catalog/includes/classes/http_client.php

Doc Comments +6 added lines, -4 removed lines

@@ -110,7 +110,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) {
@@ -120,7 +120,7 @@ 
 /**
  * removeHeader
  * unset a request header
- * @param headerName the header name
+ * @param headerName string header name
  **/
     function removeHeader($headerName) {
       unset($this->requestHeaders[$headerName]);
@@ -172,6 +172,7 @@ 
  * get
  * issue a GET http request
  * @param uri URI (path on server) or full URL of the document
+ * @param string $url
  * @return string response status code (200 if ok)
  * @seeAlso getHeaders(), getBody()
  **/
@@ -309,7 +310,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();
@@ -433,7 +435,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) {