osCommerce / oscommerce2

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) {

catalog/includes/classes/language.php

Doc Comments +3 added lines

@@ -70,6 +70,9 @@
       $this->set_language($lng);
     }
 
+    /**
+     * @param string $language
+     */
     function set_language($language) {
       if ( (tep_not_null($language)) && (isset($this->catalog_languages[$language])) ) {
         $this->language = $this->catalog_languages[$language];

catalog/includes/functions/compatibility.php

Doc Comments +4 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);

catalog/includes/functions/database.php

Doc Comments +13 added lines

@@ -32,6 +32,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);
@@ -52,6 +56,9 @@ 
     return $result;
   }
 
+  /**
+   * @param string $table
+   */
   function tep_db_perform($table, $data, $action = 'insert', $parameters = '', $link = 'db_link') {
     reset($data);
     if ($action == 'insert') {
@@ -191,6 +198,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);
@@ -221,6 +231,9 @@ 
       return mysql_error($link);
     }
 
+    /**
+     * @param integer $type
+     */
     function mysqli_fetch_array($query, $type) {
       return mysql_fetch_array($query, $type);
     }

catalog/includes/functions/general.php

Doc Comments +36 added lines

@@ -81,6 +81,9 @@ 
 
 ////
 // Return a random row from a database query
+  /**
+   * @param string $query
+   */
   function tep_random_select($query) {
     $random_product = '';
     $random_query = tep_db_query($query);
@@ -145,6 +148,10 @@ 
 
 ////
 // Break a word in a string if it is longer than a specified length ($len)
+  /**
+   * @param string $string
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -260,6 +267,9 @@ 
 
 ////
 // Returns the clients browser
+  /**
+   * @param string $component
+   */
   function tep_browser_detect($component) {
     global $HTTP_USER_AGENT;
 
@@ -302,6 +312,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);
@@ -448,6 +461,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) {
     $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);
@@ -940,6 +958,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;
@@ -1036,6 +1057,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;
 
@@ -1104,6 +1130,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 +1282,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1386,6 +1419,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);