Fix parameter withcode of currency_name function. Add PHPUnit tests

htdocs/core/lib/company.lib.php

@@ -421,23 +421,26 @@ function getState($id,$withcode='',$dbtouse=0)
 }
 
 /**
- *    Retourne le nom traduit ou code+nom d'une devise
+ *    Return label of currency or code+label
  *
- *    @param      string	$code_iso       Code iso de la devise
+ *    @param      string	$code_iso       Code iso of currency
- *    @param      int		$withcode       '1'=affiche code + nom
+ *    @param      int		$withcode       '1'=show code + label
- *    @return     string     			    Nom traduit de la devise
+ *    @param      Translate $outputlangs    Output language
+ *    @return     string     			    Label translated of currency
  */
-function currency_name($code_iso,$withcode='')
+function currency_name($code_iso, $withcode='', $outputlangs=null)
 {
     global $langs,$db;
 
-    // Si il existe une traduction, on peut renvoyer de suite le libelle
+    if (empty($outputlangs)) $outputlangs=$langs;
-    if ($langs->trans("Currency".$code_iso)!="Currency".$code_iso)
+
+    // If there is a translation, we can send immediatly the label
+    if ($outputlangs->trans("Currency".$code_iso)!="Currency".$code_iso)
     {
-        return $langs->trans("Currency".$code_iso);
+        return ($withcode?$code_iso.' - ':'').$outputlangs->trans("Currency".$code_iso);
     }
 
-    // Si pas de traduction, on consulte le libelle par defaut en table
+    // If no translation, we read table to get label by default
     $sql = "SELECT label FROM ".MAIN_DB_PREFIX."c_currencies";
     $sql.= " WHERE code_iso='".$code_iso."'";
 
@@ -457,8 +460,8 @@ function currency_name($code_iso,$withcode='')
         {
             return $code_iso;
         }
-
     }
+    return 'ErrorWhenReadingCurrencyLabel';
 }
 
 /**

test/phpunit/AdminLibTest.php

@@ -115,7 +115,7 @@ class AdminLibTest extends PHPUnit_Framework_TestCase
     }
 
     /**
-     * testConvertTime2Seconds
+     * testVersionCompare
      *
      * @return	void
      */

test/phpunit/AllTests.php

@@ -81,6 +81,8 @@ class AllTests
         //$suite->addTestSuite('CoreTest');
         require_once dirname(__FILE__).'/AdminLibTest.php';
         $suite->addTestSuite('AdminLibTest');
+        require_once dirname(__FILE__).'/CompanyLibTest.php';
+        $suite->addTestSuite('CompanyLibTest');
         require_once dirname(__FILE__).'/DateLibTest.php';
         $suite->addTestSuite('DateLibTest');
         //require_once dirname(__FILE__).'/DateLibTzFranceTest.php';

test/phpunit/CompanyLibTest.php

@@ -0,0 +1,144 @@
+<?php
+/* Copyright (C) 2017 Laurent Destailleur  <eldy@users.sourceforge.net>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * or see http://www.gnu.org/
+ */
+
+/**
+ *      \file       test/phpunit/CompanyLibTest.php
+ *      \ingroup    test
+ *      \brief      PHPUnit test
+ *      \remarks    To run this script as CLI:  phpunit filename.php
+ */
+
+global $conf,$user,$langs,$db;
+//define('TEST_DB_FORCE_TYPE','mysql');	// This is to force using mysql driver
+//require_once 'PHPUnit/Autoload.php';
+require_once dirname(__FILE__).'/../../htdocs/master.inc.php';
+require_once dirname(__FILE__).'/../../htdocs/core/lib/company.lib.php';
+
+if (empty($user->id)) {
+    print "Load permissions for admin user nb 1\n";
+    $user->fetch(1);
+    $user->getrights();
+}
+$conf->global->MAIN_DISABLE_ALL_MAILS=1;
+
+
+/**
+ * Class for PHPUnit tests
+ *
+ * @backupGlobals disabled
+ * @backupStaticAttributes enabled
+ * @remarks backupGlobals must be disabled to have db,conf,user and lang not erased.
+ */
+class CompanyLibTest extends PHPUnit_Framework_TestCase
+{
+    protected $savconf;
+    protected $savuser;
+    protected $savlangs;
+    protected $savdb;
+
+    /**
+     * Constructor
+     * We save global variables into local variables
+     *
+     * @return AdminLibTest
+     */
+    function __construct()
+    {
+        //$this->sharedFixture
+        global $conf,$user,$langs,$db;
+        $this->savconf=$conf;
+        $this->savuser=$user;
+        $this->savlangs=$langs;
+        $this->savdb=$db;
+
+        print __METHOD__." db->type=".$db->type." user->id=".$user->id;
+        //print " - db ".$db->db;
+        print "\n";
+    }
+
+    // Static methods
+    public static function setUpBeforeClass()
+    {
+        global $conf,$user,$langs,$db;
+        $db->begin(); // This is to have all actions inside a transaction even if test launched without suite.
+
+        print __METHOD__."\n";
+    }
+
+    // tear down after class
+    public static function tearDownAfterClass()
+    {
+        global $conf,$user,$langs,$db;
+        $db->rollback();
+
+        print __METHOD__."\n";
+    }
+
+    /**
+     * Init phpunit tests
+     *
+     * @return  void
+     */
+    protected function setUp()
+    {
+        global $conf,$user,$langs,$db;
+        $conf=$this->savconf;
+        $user=$this->savuser;
+        $langs=$this->savlangs;
+        $db=$this->savdb;
+
+        print __METHOD__."\n";
+    }
+    /**
+     * End phpunit tests
+     *
+     * @return	void
+     */
+    protected function tearDown()
+    {
+        print __METHOD__."\n";
+    }
+
+    /**
+     * testNameCurrency
+     *
+     * @return	void
+     */
+    public function testNameCurrency()
+    {
+        global $conf,$user,$langs,$db;
+        $conf=$this->savconf;
+        $user=$this->savuser;
+        $langs=$this->savlangs;
+        $db=$this->savdb;
+
+        $result=currency_name('USD');
+        print __METHOD__." result=".$result."\n";
+        $this->assertEquals('United States Dollar',$result);
+
+        $outputlangs=new Translate('', $conf);
+        $outputlangs->setDefaultLang('fr_FR');
+        $outputlangs->load("dict");
+
+        $result=currency_name('USD', 1, $outputlangs);
+        print __METHOD__." result=".$result."\n";
+        $this->assertEquals('USD - Dollars US',$result);
+
+        return $result;
+    }
+}