osCommerce / oscommerce2

catalog/includes/OSC/OM/HTML.php

Doc Comments +20 added lines

@@ -103,6 +103,10 @@ 
         return $image;
     }
 
+    /**
+     * @param string $name
+     * @param string $action
+     */
     public static function form($name, $action, $method = 'post', $parameters = '', array $flags = [])
     {
         if (!isset($flags['tokenize']) || !is_bool($flags['tokenize'])) {
@@ -175,6 +179,9 @@ 
         return static::inputField($name, null, $parameters, 'file', false);
     }
 
+    /**
+     * @param string $type
+     */
     protected static function selectionField($name, $type, $value = '', $checked = false, $parameters = '')
     {
         $selection = '<input type="' . static::output($type) . '" name="' . static::output($name) . '"';
@@ -196,6 +203,9 @@ 
         return $selection;
     }
 
+    /**
+     * @param string $name
+     */
     public static function checkboxField($name, $value = '', $checked = false, $parameters = '')
     {
         return static::selectionField($name, 'checkbox', $value, $checked, $parameters);
@@ -206,6 +216,11 @@ 
         return static::selectionField($name, 'radio', $value, $checked, $parameters);
     }
 
+    /**
+     * @param string $name
+     * @param integer $width
+     * @param integer $height
+     */
     public static function textareaField($name, $width, $height, $text = '', $parameters = '', $reinsert_value = true, $class = 'form-control')
     {
         $field = '<textarea name="' . static::output($name) . '" cols="' . static::output($width) . '" rows="' . static::output($height) . '"';
@@ -325,6 +340,11 @@ 
         return $field;
     }
 
+    /**
+     * @param string $title
+     * @param string $icon
+     * @param string $link
+     */
     public static function button($title = null, $icon = null, $link = null, $params = null, $class = null)
     {
         $types = ['submit', 'button', 'reset'];

catalog/includes/functions/general.php

Doc Comments +29 added lines

@@ -78,6 +78,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 = '';
@@ -245,6 +248,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);
@@ -424,6 +430,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');
 
@@ -952,6 +963,9 @@ 
 
 ////
 // Return a product ID with attributes
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     if (is_numeric($prid)) {
       $uprid = (int)$prid;
@@ -1033,6 +1047,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;
 
@@ -1092,6 +1111,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';
 
@@ -1247,6 +1269,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
 
     if (isset($min) && isset($max)) {
@@ -1366,6 +1392,9 @@ 
   }
 
 // Convert linefeeds
+  /**
+   * @param string[] $from
+   */
   function tep_convert_linefeeds($from, $to, $string) {
       return str_replace($from, $to, $string);
   }

catalog/includes/OSC/OM/Language.php

Doc Comments +9 added lines

@@ -121,6 +121,9 @@ 
         }
     }
 
+    /**
+     * @param string $data
+     */
     public function get($data = null, $language_code = null)
     {
         if (!isset($data)) {
@@ -246,6 +249,9 @@ 
         $this->injectDefinitions($defs, $scope);
     }
 
+    /**
+     * @param string $pathname
+     */
     public function getDefinitions($group, $language_code, $pathname)
     {
         $defs = [];
@@ -331,6 +337,9 @@ 
         }
     }
 
+    /**
+     * @param boolean $flag
+     */
     public function setUseCache($flag)
     {
         $this->use_cache = ($flag === true);

catalog/includes/OSC/OM/Cache.php

Doc Comments +6 added lines

@@ -50,6 +50,9 @@ 
         return false;
     }
 
+    /**
+     * @param integer $expire
+     */
     public function exists($expire = null)
     {
         $filename = static::$path . $this->key . '.cache';
@@ -139,6 +142,9 @@ 
         return static::$path;
     }
 
+    /**
+     * @param string $key
+     */
     public static function clear($key)
     {
         if (!static::hasSafeName($key)) {

catalog/includes/OSC/OM/HTTP.php

Doc Comments +1 added lines

@@ -37,6 +37,7 @@
 
     /**
      * @param array $parameters url, headers, parameters, method, verify_ssl, cafile, certificate, proxy
+     * @return string
      */
 
     public static function getResponse(array $parameters)

catalog/admin/includes/functions/general.php

Doc Comments +35 added lines

@@ -221,6 +221,9 @@ 
     return $image;
   }
 
+  /**
+   * @param integer $len
+   */
   function tep_break_string($string, $len, $break_char = '-') {
     $l = 0;
     $output = '';
@@ -333,6 +336,11 @@ 
     return $geo_zone_id;
   }
 
+  /**
+   * @param boolean $html
+   * @param string $boln
+   * @param string $eoln
+   */
   function tep_address_format($address_format_id, $address, $html, $boln, $eoln) {
     $Qaddress = Registry::get('Db')->get('address_format', 'address_format', ['address_format_id' => (int)$address_format_id]);
 
@@ -429,6 +437,9 @@ 
     return $def_state;
   }
 
+  /**
+   * @param string $params
+   */
   function tep_get_uprid($prid, $params) {
     $uprid = $prid;
     if ( (is_array($params)) && (!strstr($prid, '{')) ) {
@@ -545,6 +556,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);
@@ -740,6 +754,9 @@ 
 
 ////
 // Sets the status of a banner
+  /**
+   * @param integer $status
+   */
   function tep_set_banner_status($banners_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -814,6 +831,9 @@ 
 
 ////
 // Sets the status of a product on special
+  /**
+   * @param integer $status
+   */
   function tep_set_specials_status($specials_id, $status) {
     $OSCOM_Db = Registry::get('Db');
 
@@ -1231,6 +1251,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;
 
@@ -1282,6 +1307,9 @@ 
 
 ////
 // Wrapper function for round() for php3 compatibility
+  /**
+   * @return double
+   */
   function tep_round($value, $precision) {
     return round($value, $precision);
   }
@@ -1430,6 +1458,10 @@ 
 
 ////
 // Return a random value
+  /**
+   * @param integer $min
+   * @param integer $max
+   */
   function tep_rand($min = null, $max = null) {
     static $seeded;
 
@@ -1445,6 +1477,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);
   }