XRSites / correios

correios.php

Doc Comments +4 added lines, -4 removed lines

@@ -176,7 +176,7 @@ 
 

     /**

      * 

-     * @return type

+     * @return string

      */

     public function getContent() {

         $output = '<h2>' . $this->displayName . '</h2>';

@@ -210,7 +210,7 @@ 
     /**

      * 

      * @param type $params

-     * @param type $shipping_cost

+     * @param integer $shipping_cost

      * @return boolean

      */

     public function getOrderShippingCost($params, $shipping_cost) {

@@ -238,7 +238,7 @@ 
     /**

      * 

      * @param type $params

-     * @return type

+     * @return boolean

      */

     public function getOrderShippingCostExternal($params) {

         return $this->getOrderShippingCost($params, 0);

@@ -376,7 +376,7 @@ 
 

     /**

      * 

-     * @param type $name

+     * @param string $name

      * @return boolean

      */

     private function getCache($name) {

tests/vendors/Configuration.php

Doc Comments +6 added lines

@@ -3,6 +3,9 @@ 
 class Configuration extends ObjectModel

 {

 

+    /**
+     * @param integer $id_lang
+     */
     public static function get($key, $id_lang = NULL)

     {

       if ( $key === "PS_CORREIOS_FACTORY" )

@@ -24,6 +27,9 @@ 
         return "01311000"; # av paulista

     }

 

+    /**
+     * @param string[] $keys
+     */
     public static function getMultiple($keys, $id_lang = NULL)

     {

       return array();

tests/vendors/Language.php

Doc Comments +15 added lines, -2 removed lines

@@ -75,6 +75,9 @@ 
         'pdf' => '_LANGPDF',
     );
 
+    /**
+     * @param integer $id
+     */
     public  function __construct($id = NULL, $id_lang = NULL)
     {
         parent::__construct($id);
@@ -214,7 +217,7 @@ 
      * Concerned files are theses located in translations/$iso_code/
      * and translations/mails/$iso_code .
      *
-     * @param mixed $iso_code
+     * @param string $iso_code
      * @returntrue if all files exists
      */
     public static function checkFilesWithIsoCode($iso_code)
@@ -380,6 +383,9 @@ 
         return $return;
     }
 
+    /**
+     * @param string $dir
+     */
     public static function recurseDeleteDir($dir)
     {
         if (!is_dir($dir))
@@ -518,6 +524,11 @@ 
         return $languages;
     }
 
+    /**
+     * @param integer $id_lang
+     *
+     * @return integer|null
+     */
     public static function getLanguage($id_lang)
     {
         if (!array_key_exists((int)($id_lang), self::$_LANGUAGES))
@@ -563,7 +574,6 @@ 
     /**
       * Return array (id_lang, iso_code)
       *
-      * @param string $iso_code Iso code
       * @return array  Language (id_lang, iso_code)
       */
     public static function getIsoIds($active = true)
@@ -684,6 +694,9 @@ 
         }
     }
 
+    /**
+     * @param integer $id
+     */
     protected static function _copyNoneFlag($id)
     {
         return copy(dirname(__FILE__).'/../img/l/none.jpg', dirname(__FILE__).'/../img/l/'.$id.'.jpg');

tests/vendors/Tools.php

Doc Comments +33 added lines, -11 removed lines

@@ -521,8 +521,6 @@ 
 	* Sanitize a string
 	*
 	* @param string $string String to sanitize
-	* @param boolean $full String contains HTML or not (optional)
-	* @return string Sanitized string
 	*/
 	public static function safeOutput($string, $html = false)
 	{
@@ -531,6 +529,10 @@ 
 		return @Tools::htmlentitiesUTF8($string, ENT_QUOTES);
 	}
 
+	/**
+	 * @param string $string
+	 * @param integer $type
+	 */
 	public static function htmlentitiesUTF8($string, $type = ENT_QUOTES)
 	{
 		if (is_array($string))
@@ -803,7 +805,6 @@ 
 	/**
 	* Encrypt password
 	*
-	* @param object $object Object to display
 	*/
 	public static function encrypt($passwd)
 	{
@@ -813,7 +814,6 @@ 
 	/**
 	* Get token to prevent CSRF
 	*
-	* @param string $token token to encrypt
 	*/
 	public static function getToken($page = true)
 	{
@@ -827,7 +827,7 @@ 
 	/**
 	* Encrypt password
 	*
-	* @param object $object Object to display
+	* @param string $string
 	*/
 	public static function getAdminToken($string)
 	{
@@ -1073,10 +1073,6 @@ 
 	/**
 	* Generate date form
 	*
-	* @param integer $year Year to select
-	* @param integer $month Month to select
-	* @param integer $day Day to select
-	* @return array $tab html data with 3 cells :['days'], ['months'], ['years']
 	*
 	*/
 	public static function dateYears()
@@ -1100,6 +1096,11 @@ 
 		return $tab;
 	}
 
+	/**
+	 * @param integer $hours
+	 * @param integer $minutes
+	 * @param integer $seconds
+	 */
 	public static function hourGenerate($hours, $minutes, $seconds)
 	{
 		return implode(':', array($hours, $minutes, $seconds));
@@ -1156,6 +1157,9 @@ 
 		return $string;
 	}
 
+	/**
+	 * @param false|string $str
+	 */
 	static function strtoupper($str)
 	{
 		if (is_array($str))
@@ -1165,6 +1169,9 @@ 
 		return strtoupper($str);
 	}
 
+	/**
+	 * @param integer $start
+	 */
 	static function substr($str, $start, $length = false, $encoding = 'utf-8')
 	{
 		if (is_array($str))
@@ -1243,6 +1250,9 @@ 
 			set_magic_quotes_runtime($var);
 	}
 
+	/**
+	 * @param double $value
+	 */
 	public static function ps_round($value, $precision = 0)
 	{
 		$method = (int)(Configuration::get('PS_PRICE_ROUND_MODE'));
@@ -1364,6 +1374,7 @@ 
 	/**
 	* Translates a string with underscores into camel case (e.g. first_name -> firstName)
 	* @prototype string public static function toCamelCase(string $str[, bool $capitaliseFirstChar = false])
+	* @param string $str
 	*/
 	public static function toCamelCase($str, $capitaliseFirstChar = false)
 	{
@@ -1438,6 +1449,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $css_content
+	 */
 	public static function minifyCSS($css_content, $fileuri = false)
 	{
 		global $current_css_file;
@@ -1493,7 +1507,7 @@ 
 	 * addJS load a javascript file in the header
 	 *
 	 * @param mixed $js_uri
-	 * @return void
+	 * @return boolean
 	 */
 	public static function addJS($js_uri)
 	{
@@ -1544,7 +1558,7 @@ 
 	 *
 	 * @param mixed $css_uri
 	 * @param string $css_media_type
-	 * @return true
+	 * @return boolean
 	 */
 	public static function addCSS($css_uri, $css_media_type = 'all')
 	{
@@ -1758,6 +1772,11 @@ 
 		return self::getHttpHost();
 	}
 
+	/**
+	 * @param string $path
+	 * @param integer $rewrite_settings
+	 * @param integer $cache_control
+	 */
 	public static function generateHtaccess($path, $rewrite_settings, $cache_control, $specific = '', $disableMuliviews = false)
 	{
 		$tab = array('ErrorDocument' => array(), 'RewriteEngine' => array(), 'RewriteRule' => array());
@@ -2030,6 +2049,9 @@ 
 		return $s;
 	}
 
+	/**
+	 * @param string $replace
+	 */
 	public static function str_replace_once($needle , $replace, $haystack)
 	{
 		$pos = strpos($haystack, $needle);