From 1cf55396a099efb8db261f4fb806f582e56860c5 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Sun, 8 May 2005 18:21:28 +0000
Subject: [PATCH] Doc: Documentation doxygen

---
 htdocs/tva.class.php | 333 ++++++++++++++++++++++---------------------
 1 file changed, 170 insertions(+), 163 deletions(-)

diff --git a/htdocs/tva.class.php b/htdocs/tva.class.php
index 92fbc0bece3..de2003f8f54 100644
--- a/htdocs/tva.class.php
+++ b/htdocs/tva.class.php
@@ -1,7 +1,7 @@
 <?php
 /* Copyright (C) 2002-2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
- * Copyright (C) 2004      Laurent Destailleur  <eldy@users.sourceforge.net>
- * 
+ * Copyright (C) 2004-2005 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 2 of the License, or
@@ -20,188 +20,195 @@
  * $Source$
  */
 
-/*
- * La tva collect�e n'est calcul�e que sur les factures pay�es.
- *
- *
- */
+/**
+        \file       htdocs/chargesociales.class.php
+		\ingroup    compta
+		\brief      Fichier de la classe de tva
+        \remarks    La tva collect�e n'est calcul�e que sur les factures pay�es.
+		\version    $Revision$
+*/
+
+
+/**     \class      PaiementCharge
+		\brief      Classe permettant la gestion de la tva
+*/
  
 class Tva
 {
-  var $db;
-  var $note;
-  /*
-   * Initialistation automatique de la classe
-   */
-  function Tva($DB)
+    var $db;
+    var $note;
+
+    /*
+     *      \brief      Constructeur
+     */
+    function Tva($DB)
     {
-      $this->db = $DB;
-    
-      return 1;
-  }
-	
-  /*
-   * \brief Hum la fonction s'appelle 'Solde' elle doit a mon avis calcluer le solde de TVA, non ?
-   *
-   */
-	 
-  function solde($year = 0)
+        $this->db = $DB;
+
+        return 1;
+    }
+
+    /*
+     *      \brief      Hum la fonction s'appelle 'Solde' elle doit a mon avis calcluer le solde de TVA, non ?
+     *
+     */
+    function solde($year = 0)
     {
-    
-      $reglee = $this->tva_sum_reglee($year);
 
-      $payee = $this->tva_sum_payee($year);
-      $collectee = $this->tva_sum_collectee($year);
+        $reglee = $this->tva_sum_reglee($year);
 
-      $solde = $reglee - ($collectee - $payee) ;
+        $payee = $this->tva_sum_payee($year);
+        $collectee = $this->tva_sum_collectee($year);
 
-      return $solde;
-    }
-		
-  /*
-   * \brief Total de la TVA des factures emises par la societe.
-   *
-   */
-	 
-  function tva_sum_collectee($year = 0)
-    {
+        $solde = $reglee - ($collectee - $payee) ;
 
-      $sql = "SELECT sum(f.tva) as amount";
-      $sql .= " FROM ".MAIN_DB_PREFIX."facture as f WHERE f.paye = 1";
-
-      if ($year)
-	{
-	  $sql .= " AND f.datef >= '$year-01-01' AND f.datef <= '$year-12-31' ";
-	}
-
-      $result = $this->db->query($sql);
-
-      if ($result)
-	{
-	  if ($this->db->num_rows())
-	    {
-	      $obj = $this->db->fetch_object($result);
-	      return $obj->amount;
-	    }
-	  else
-	    {
-	      return 0;
-	    }
-
-	  $this->db->free();
-	  
-	}
-      else
-	{
-	  print $this->db->error();
-	  return -1;
-	} 
+        return $solde;
     }
-		
-  /*
-   * \brief  Tva pay�e
-   * 
-   */
-	 
-  function tva_sum_payee($year = 0)
+
+    /*
+     *      \brief      Total de la TVA des factures emises par la societe.
+     *
+     */
+
+    function tva_sum_collectee($year = 0)
     {
-      
-      $sql = "SELECT sum(f.amount) as amount";
-      $sql .= " FROM ".MAIN_DB_PREFIX."facture_fourn as f";
-      
-      if ($year)
-	{
-	  $sql .= " WHERE f.datef >= '$year-01-01' AND f.datef <= '$year-12-31' ";
-	}
-      
-      $result = $this->db->query($sql);
-      
-      if ($result)
-	{
-	  if ($this->db->num_rows())
-	    {
-	      $obj = $this->db->fetch_object($result);
-	      return $obj->amount;
-	    }
-	  else
-	    {
-	      return 0;
-	    }
-	  
-	  $this->db->free();
-
-	}
-      else
-	{
-	  print $this->db->error();
-	  return -1;
-	} 
+
+        $sql = "SELECT sum(f.tva) as amount";
+        $sql .= " FROM ".MAIN_DB_PREFIX."facture as f WHERE f.paye = 1";
+
+        if ($year)
+        {
+            $sql .= " AND f.datef >= '$year-01-01' AND f.datef <= '$year-12-31' ";
+        }
+
+        $result = $this->db->query($sql);
+
+        if ($result)
+        {
+            if ($this->db->num_rows())
+            {
+                $obj = $this->db->fetch_object($result);
+                return $obj->amount;
+            }
+            else
+            {
+                return 0;
+            }
+
+            $this->db->free();
+
+        }
+        else
+        {
+            print $this->db->error();
+            return -1;
+        }
     }
-		
-  /*
-   * Tva r�gl�e
-   * Total de la TVA r�glee aupres de qui de droit
-   *
-   */
-	 
-  function tva_sum_reglee($year = 0)
+
+    /*
+     *      \brief      Tva pay�e
+     *
+     */
+
+    function tva_sum_payee($year = 0)
     {
 
-      $sql = "SELECT sum(f.amount) as amount";
-      $sql .= " FROM ".MAIN_DB_PREFIX."tva as f";
-      
-      if ($year)
-	{
-	  $sql .= " WHERE f.datev >= '$year-01-01' AND f.datev <= '$year-12-31' ";
-	}
-
-      $result = $this->db->query($sql);
-
-      if ($result)
-	{
-	  if ($this->db->num_rows())
-	    {
-	      $obj = $this->db->fetch_object($result);
-	      return $obj->amount;
-	    }
-	  else
-	    {
-	      return 0;
-	    }
-	  
-	  $this->db->free();
-
-	}
-      else
-	{
-	  print $this->db->error();
-	  return -1;
-	} 
+        $sql = "SELECT sum(f.amount) as amount";
+        $sql .= " FROM ".MAIN_DB_PREFIX."facture_fourn as f";
+
+        if ($year)
+        {
+            $sql .= " WHERE f.datef >= '$year-01-01' AND f.datef <= '$year-12-31' ";
+        }
+
+        $result = $this->db->query($sql);
+
+        if ($result)
+        {
+            if ($this->db->num_rows())
+            {
+                $obj = $this->db->fetch_object($result);
+                return $obj->amount;
+            }
+            else
+            {
+                return 0;
+            }
+
+            $this->db->free();
+
+        }
+        else
+        {
+            print $this->db->error();
+            return -1;
+        }
     }
 
-  /*
-   *
-   */
-	 
-  function add_payement($datep, $datev, $amount)
+
+    /*
+     *      \brief      Tva r�gl�e
+     *                  Total de la TVA r�glee aupres de qui de droit
+     *
+     */
+
+    function tva_sum_reglee($year = 0)
     {
-      $sql = "INSERT INTO ".MAIN_DB_PREFIX."tva (datep, datev, amount) ";
-      $sql .= " VALUES ('".$this->db->idate($datep)."',";
-      $sql .= "'".$this->db->idate($datev)."'," . ereg_replace(",",".",$amount) .")";
 
-      $result = $this->db->query($sql);
+        $sql = "SELECT sum(f.amount) as amount";
+        $sql .= " FROM ".MAIN_DB_PREFIX."tva as f";
+
+        if ($year)
+        {
+            $sql .= " WHERE f.datev >= '$year-01-01' AND f.datev <= '$year-12-31' ";
+        }
+
+        $result = $this->db->query($sql);
+
+        if ($result)
+        {
+            if ($this->db->num_rows())
+            {
+                $obj = $this->db->fetch_object($result);
+                return $obj->amount;
+            }
+            else
+            {
+                return 0;
+            }
+
+            $this->db->free();
+
+        }
+        else
+        {
+            print $this->db->error();
+            return -1;
+        }
+    }
 
-      if ($result)
-	{
-	  return 1;
-	}
-      else
-	{
-	  print $this->db->error()."<br>".$sql;
-	  return -1;
-	} 
 
+    /*
+     *      \brief      Ajoute un paiement de TVA
+     */
 
+    function add_payement($datep, $datev, $amount)
+    {
+        $sql = "INSERT INTO ".MAIN_DB_PREFIX."tva (datep, datev, amount) ";
+        $sql .= " VALUES ('".$this->db->idate($datep)."',";
+        $sql .= "'".$this->db->idate($datev)."'," . ereg_replace(",",".",$amount) .")";
+
+        $result = $this->db->query($sql);
+
+        if ($result)
+        {
+            return 1;
+        }
+        else
+        {
+            $this->error=$this->db->error();
+            return -1;
+        }
     }
 }
 
-- 
GitLab