Qual: Uniformize code

Doc: Doxygen

htdocs/comm/propal/class/propal.class.php

@@ -266,7 +266,7 @@ class Propal extends CommonObject
 	}
 
 	/**
-	 *    	\brief     	Add new line in database
+	 *    	Add a proposal line into database (linked to product/service or not)
 	 * 		\param    	propalid        	Id de la propale
 	 * 		\param    	desc            	Description de la ligne
 	 * 		\param    	pu_ht              	Prix unitaire
@@ -279,8 +279,10 @@ class Propal extends CommonObject
 	 * 		\param    	price_base_type		HT or TTC
 	 * 		\param    	pu_ttc             	Prix unitaire TTC
 	 * 		\param    	info_bits			Bits de type de lignes
+	 *      \param      type                Type of line (product, service)
+	 *      \param      rang                Position of line
 	 *    	\return    	int             	>0 if OK, <0 if KO
-	 *    	\see       	add_product
+	 *    	@see       	add_product
 	 * 		\remarks	Les parametres sont deja cense etre juste et avec valeurs finales a l'appel
 	 *					de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini
 	 *					par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,'',produit)
@@ -293,14 +295,14 @@ class Propal extends CommonObject
 		dol_syslog("Propal::Addline propalid=$propalid, desc=$desc, pu_ht=$pu_ht, qty=$qty, txtva=$txtva, fk_product=$fk_product, remise_except=$remise_percent, price_base_type=$price_base_type, pu_ttc=$pu_ttc, info_bits=$info_bits, type=$type");
 		include_once(DOL_DOCUMENT_ROOT.'/lib/price.lib.php');
 
-		if ($this->statut == 0)
-		{
-			$this->db->begin();
-
 		// Clean parameters
+		if (empty($remise_percent)) $remise_percent=0;
+		if (empty($qty)) $qty=0;
+		if (empty($info_bits)) $info_bits=0;
+		if (empty($rang)) $rang=0;
+
 		$remise_percent=price2num($remise_percent);
 		$qty=price2num($qty);
-			if (empty($qty)) $qty=0;	// If qty=''
 		$pu_ht=price2num($pu_ht);
 		$pu_ttc=price2num($pu_ttc);
 		$txtva=price2num($txtva);
@@ -315,6 +317,13 @@ class Propal extends CommonObject
 			$pu=$pu_ttc;
 		}
 
+		// Check parameters
+		if ($type < 0) return -1;
+
+		if ($this->statut == 0)
+		{
+			$this->db->begin();
+
 			// Calcul du total TTC et de la TVA pour la ligne a partir de
 			// qty, pu, remise_percent et txtva
 			// TRES IMPORTANT: C'est au moment de l'insertion ligne qu'on doit stocker
@@ -423,29 +432,18 @@ class Propal extends CommonObject
 		dol_syslog("Propal::UpdateLine $rowid, $pu, $qty, $remise_percent, $txtva, $desc, $price_base_type, $info_bits");
 		include_once(DOL_DOCUMENT_ROOT.'/lib/price.lib.php');
 
-		if ($this->statut == 0)
+		// Clean parameters
-		{
-			$this->db->begin();
-
-			// Nettoyage param<61>tres
 		$remise_percent=price2num($remise_percent);
 		$qty=price2num($qty);
-			/*
-			if ($conf->global->PROPALE_USE_OPTION_LINE && !$qty)
-			{
-				$qty=0;
-				$remise_percent=0;
-			}
-			else if (! $qty)
-			{
-				$qty=1;
-			}
-			*/
 		$pu = price2num($pu);
 		$txtva = price2num($txtva);
 		$txlocaltax1=price2num($txlocaltax1);
 		$txlocaltax2=price2num($txlocaltax2);
 
+		if ($this->statut == 0)
+		{
+			$this->db->begin();
+
 			// Calcul du total TTC et de la TVA pour la ligne a partir de
 			// qty, pu, remise_percent et txtva
 			// TRES IMPORTANT: C'est au moment de l'insertion ligne qu'on doit stocker
@@ -2263,16 +2261,20 @@ class PropaleLigne
 		global $conf;
 
 		dol_syslog("PropaleLigne::insert rang=".$this->rang);
-		$this->db->begin();
 
 		// Clean parameters
-		if (! $this->remise) $this->remise=0;
-		if (! $this->remise_percent) $this->remise_percent=0;
-		if (! $this->info_bits) $this->info_bits=0;
 		if (empty($this->tva_tx)) $this->tva_tx=0;
+		if (empty($this->localtax1_tx)) $this->localtax1_tx=0;
+		if (empty($this->localtax2_tx)) $this->localtax2_tx=0;
+		if (empty($this->rang)) $this->rang=0;
+		if (empty($this->remise)) $this->remise=0;
+		if (empty($this->remise_percent)) $this->remise_percent=0;
+		if (empty($this->info_bits)) $this->info_bits=0;
 
 		// Check parameters
-		if ($this->type < 0) return -1;
+		if ($this->product_type < 0) return -1;
+
+		$this->db->begin();
 
 		// Insert line into database
 		$sql = 'INSERT INTO '.MAIN_DB_PREFIX.'propaldet';

htdocs/commande/class/commande.class.php

@@ -804,26 +804,27 @@ class Commande extends CommonObject
 
 
 	/**
-	 *    	\brief     	Add a line
+	 *     Add an order line into database (linked to product/service or not)
-	 * 		\param    	commandeid      	Id de la commande
+	 *     @param      commandeid      	Id of line
-	 * 		\param    	desc            	Description de la ligne
+	 * 	   @param      desc            	Description of line
-	 * 		\param    	pu_ht              	Prix unitaire HT
+	 * 	   @param      pu_ht            Unit price (without tax)
-	 * 		\param    	qty             	Quantite
+	 * 	   @param      qty             	Quantite
-	 * 		\param    	txtva           	Taux de tva force, sinon -1
+	 * 	   @param      txtva           	Taux de tva force, sinon -1
-	 * 		\param		txlocaltax1			Local tax 1 rate
+	 * 	   @param      txlocaltax1		Local tax 1 rate
-	 *  	\param		txlocaltax2			Local tax 2 rate
+	 *     @param      txlocaltax2		Local tax 2 rate
-	 *		\param    	fk_product      	Id du produit/service predefini
+	 *	   @param      fk_product      	Id du produit/service predefini
-	 * 		\param    	remise_percent  	Pourcentage de remise de la ligne
+	 * 	   @param      remise_percent  	Pourcentage de remise de la ligne
-	 * 		\param    	info_bits			Bits de type de lignes
+	 * 	   @param      info_bits		Bits de type de lignes
-	 *		\param    	fk_remise_except	Id remise
+	 *	   @param      fk_remise_except	Id remise
-	 *		\param		price_base_type		HT or TTC
+	 *	   @param      price_base_type	HT or TTC
-	 * 		\param    	pu_ttc             	Prix unitaire TTC
+	 * 	   @param      pu_ttc           Prix unitaire TTC
-	 * 		\param    	date_start          Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
+	 * 	   @param      date_start       Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
-	 * 		\param    	date_end            End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
+	 * 	   @param      date_end         End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
-	 * 		\param		type				Type of line (0=product, 1=service)
+	 * 	   @param      type				Type of line (0=product, 1=service)
-	 *    	\return    	int             	>0 si ok, <0 si ko
+	 *     @param      rang             Position of line
-	 *    	\see       	add_product
+	 *     @return     int             	>0 si ok, <0 si ko
-	 * 		\remarks	Les parametres sont deja cense etre juste et avec valeurs finales a l'appel
+	 *     @see        add_product
+	 * 	   @remarks	   Les parametres sont deja cense etre juste et avec valeurs finales a l'appel
 	 *		           	de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini
 	 *					par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,produit)
 	 *					et le desc doit deja avoir la bonne valeur (a l'appelant de gerer le multilangue)
@@ -838,6 +839,7 @@ class Commande extends CommonObject
 		if (empty($remise_percent)) $remise_percent=0;
         if (empty($qty)) $qty=0;
         if (empty($info_bits)) $info_bits=0;
+        if (empty($rang)) $rang=0;
 
 		$remise_percent=price2num($remise_percent);
 		$qty=price2num($qty);
@@ -2624,6 +2626,13 @@ class OrderLine
 		if (empty($this->tva_tx)) $this->tva_tx=0;
 		if (empty($this->localtax1_tx)) $this->localtax1_tx=0;
 		if (empty($this->localtax2_tx)) $this->localtax2_tx=0;
+        if (empty($this->rang)) $this->rang=0;
+        if (empty($this->remise)) $this->remise=0;
+        if (empty($this->remise_percent)) $this->remise_percent=0;
+        if (empty($this->info_bits)) $this->info_bits=0;
+
+        // Check parameters
+        if ($this->product_type < 0) return -1;
 
         $this->db->begin();
 

htdocs/compta/facture/class/facture.class.php

@@ -1565,7 +1565,7 @@ class Facture extends CommonObject
 
 
 	/**
-	 * 		\brief    	Add an invoice line into database (linked to product/service or not)
+	 * 		Add an invoice line into database (linked to product/service or not)
 	 * 		\param    	facid           	Id de la facture
 	 * 		\param    	desc            	Description de la ligne
 	 * 		\param    	pu_ht              	Prix unitaire HT
@@ -1583,6 +1583,7 @@ class Facture extends CommonObject
 	 *		\param		price_base_type		HT or TTC
 	 * 		\param    	pu_ttc             	Prix unitaire TTC
 	 * 		\param		type				Type of line (0=product, 1=service)
+	 *      \param      rang                Position of line
 	 *    	\return    	int             	>0 if OK, <0 if KO
 	 * 		\remarks	Les parametres sont deja cense etre juste et avec valeurs finales a l'appel
 	 *					de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini
@@ -1594,18 +1595,13 @@ class Facture extends CommonObject
 		dol_syslog("Facture::Addline facid=$facid,desc=$desc,pu_ht=$pu_ht,qty=$qty,txtva=$txtva, txlocaltax1=$txlocaltax1, txlocaltax2=$txlocaltax2, fk_product=$fk_product,remise_percent=$remise_percent,date_start=$date_start,date_end=$date_end,ventil=$ventil,info_bits=$info_bits,fk_remise_except=$fk_remise_except,price_base_type=$price_base_type,pu_ttc=$pu_ttc,type=$type", LOG_DEBUG);
 		include_once(DOL_DOCUMENT_ROOT.'/lib/price.lib.php');
 
-		// Check parameters
-		if ($type < 0) return -1;
-
-		if ($this->brouillon)
-		{
-			$this->db->begin();
-
 		// Clean parameters
 		if (empty($remise_percent)) $remise_percent=0;
 		if (empty($qty)) $qty=0;
-			if (empty($ventil)) $ventil=0;
 		if (empty($info_bits)) $info_bits=0;
+		if (empty($rang)) $rang=0;
+		if (empty($ventil)) $ventil=0;
+
 		$remise_percent=price2num($remise_percent);
 		$qty=price2num($qty);
 		$pu_ht=price2num($pu_ht);
@@ -1623,6 +1619,13 @@ class Facture extends CommonObject
 			$pu=$pu_ttc;
 		}
 
+		// Check parameters
+		if ($type < 0) return -1;
+
+		if ($this->brouillon)
+		{
+			$this->db->begin();
+
 			// Calcul du total TTC et de la TVA pour la ligne a partir de
 			// qty, pu, remise_percent et txtva
 			// TRES IMPORTANT: C'est au moment de l'insertion ligne qu'on doit stocker
@@ -3026,11 +3029,15 @@ class FactureLigne
 
         // Clean parameters
         $this->desc=trim($this->desc);
-		if (empty($this->subprice)) $this->subprice=0;
-		if (empty($this->price))    $this->price=0;
 		if (empty($this->tva_tx)) $this->tva_tx=0;
         if (empty($this->localtax1_tx)) $this->localtax1_tx=0;
         if (empty($this->localtax2_tx)) $this->localtax2_tx=0;
+        if (empty($this->rang)) $this->rang=0;
+        if (empty($this->remise)) $this->remise=0;
+        if (empty($this->remise_percent)) $this->remise_percent=0;
+        if (empty($this->info_bits)) $this->info_bits=0;
+        if (empty($this->subprice)) $this->subprice=0;
+        if (empty($this->price))    $this->price=0;
 
         // Check parameters
         if ($this->product_type < 0) return -1;

htdocs/core/class/commonobject.class.php

@@ -802,7 +802,8 @@ class CommonObject
 	}
 
 	/**
-	 * 	\brief		Get max value for rang
+	 * 	   Get max value used for position of line (rang)
+	 *     @result     int     Max value of rang in table of lines
 	 */
 	function line_max()
 	{