osCommerce / oscommerce2

catalog/includes/apps/braintree/lib/Braintree/MultipleValueOrTextNode.php

Doc Comments +3 added lines

@@ -3,6 +3,9 @@
 
 class MultipleValueOrTextNode extends MultipleValueNode
 {
+    /**
+     * @param string $name
+     */
     public function __construct($name)
     {
         parent::__construct($name);

catalog/includes/apps/braintree/lib/Braintree/PaymentMethodNonceGateway.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
     private $_config;
     private $_http;
 
+    /**
+     * @param Gateway $gateway
+     */
     public function __construct($gateway)
     {
         $this->_gateway = $gateway;

catalog/includes/apps/braintree/lib/Braintree/RangeNode.php

Doc Comments +3 added lines

@@ -3,6 +3,9 @@
 
 class RangeNode
 {
+    /**
+     * @param string $name
+     */
     public function __construct($name)
     {
         $this->name = $name;

catalog/includes/apps/braintree/lib/Braintree/SignatureService.php

Doc Comments +6 added lines

@@ -4,12 +4,18 @@
 class SignatureService
 {
 
+    /**
+     * @param string $digest
+     */
     public function __construct($key, $digest)
     {
         $this->key = $key;
         $this->digest = $digest;
     }
 
+    /**
+     * @param string $payload
+     */
     public function sign($payload)
     {
         return $this->hash($payload) . "|" . $payload;

catalog/includes/apps/braintree/lib/Braintree/SubscriptionGateway.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
     private $_config;
     private $_http;
 
+    /**
+     * @param Gateway $gateway
+     */
     public function __construct($gateway)
     {
         $this->_gateway = $gateway;

catalog/includes/apps/braintree/lib/Braintree/WebhookTesting.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
         ];
     }
 
+    /**
+     * @return string
+     */
     private static function _sampleXml($kind, $id)
     {
         switch ($kind) {

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

@@ -18,6 +18,9 @@ 
     var $_identifier = 'osCommerce_PPapp_v5';
     var $_definitions = array();
 
+    /**
+     * @param integer $result
+     */
     function log($module, $action, $result, $request, $response, $server, $is_ipn = false) {
       global $customer_id;
 
@@ -158,6 +161,9 @@ 
       return false;
     }
 
+    /**
+     * @param string $info
+     */
     function getModuleInfo($module, $info) {
       $class = 'OSCOM_PayPal_' . $module;
 
@@ -172,6 +178,10 @@ 
       return $m->{'_' . $info};
     }
 
+    /**
+     * @param string $module
+     * @param string $type
+     */
     function hasCredentials($module, $type = null) {
       if ( !defined('OSCOM_APP_PAYPAL_' . $module . '_STATUS') ) {
         return false;
@@ -210,6 +220,10 @@ 
       return true;
     }
 
+    /**
+     * @param string $module
+     * @param string $type
+     */
     function getCredentials($module, $type) {
       if ( constant('OSCOM_APP_PAYPAL_' . $module . '_STATUS') == '1' ) {
         if ( $type == 'email') {
@@ -357,6 +371,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;
@@ -383,6 +402,9 @@ 
       return $result['res'];
     }
 
+    /**
+     * @param string $parameters
+     */
     function makeApiCall($url, $parameters = null, $headers = null) {
       $server = parse_url($url);
 
@@ -441,6 +463,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',
@@ -736,6 +762,9 @@ 
       }
     }
 
+    /**
+     * @param string $filename
+     */
     public function loadLanguageFile($filename, $lang = null) {
       global $language;
 
@@ -777,6 +806,9 @@ 
       }
     }
 
+    /**
+     * @param string $key
+     */
     function getDef($key, $values = null) {
       $def = isset($this->_definitions[$key]) ? $this->_definitions[$key] : $key;
 
@@ -847,6 +879,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/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) {
     return stristr(getenv('HTTP_USER_AGENT'), $component);
   }
@@ -300,6 +310,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);
@@ -446,6 +459,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);
@@ -938,6 +956,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;
@@ -1034,6 +1055,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;
 
@@ -1102,6 +1128,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';
 
@@ -1251,6 +1280,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1384,6 +1417,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);