[Phpcompta-dev] r627 - trunk/rapport_avance/include

[phpcompta-dev]

Author: danydb
Date: 2013-12-20 10:34:35 +0100 (Fri, 20 Dec 2013)
New Revision: 627

Modified:
   trunk/rapport_avance/include/class_rapav_listing_compute_fiche.php
Log:
Documentation

Modified: trunk/rapport_avance/include/class_rapav_listing_compute_fiche.php
===================================================================
--- trunk/rapport_avance/include/class_rapav_listing_compute_fiche.php  
2013-12-18 01:35:35 UTC (rev 626)
+++ trunk/rapport_avance/include/class_rapav_listing_compute_fiche.php  
2013-12-20 09:34:35 UTC (rev 627)
@@ -73,7 +73,11 @@
         $cn->commit();
         return array($file_to_parse, $dirname, $type);
     }
-
+    /**
+     * Generate the document, open the file and replace all the tags,
+     * by the found value.
+     * Load the file into the db
+     */
     function generate_document()
     {
         global $cn;
@@ -116,7 +120,14 @@
 
         $this->load_document($dirname . DIRECTORY_SEPARATOR . $file_to_save);
     }
-
+    /**
+     * Replace into the file, the tags from the DB
+     * @param $p_dir path
+     * @param $p_filename filename (modele)
+     * @param $p_type mimetype of the file (OOo) 
+     * @throws Exception when the type from the DB is not a date, a text or a 
+     * numeric
+     */
     private function parse_document($p_dir, $p_filename, $p_type)
     {
         global $cn;
@@ -208,7 +219,13 @@
         }
         unlink($oname);
     }
-
+    /**
+     * Replace special tags (PERIODE_DECLARATION, TITRE, DOSSIER, NAME... 
+     * into the file
+     * @param $p_dir path
+     * @param $p_filename filename (modele)
+     * @param $p_type mimetype of the file (OOo) 
+     */
     private function special_tag($p_dir, $p_filename, $p_type)
     {
         global $cn, $g_parameter;
@@ -281,6 +298,20 @@
         }
         unlink($oname);
     }
+    /**
+     * Replace into the file the history tags
+     *     -  Code _DATE date of operation
+     *     -  Code _ECH limit date of operation
+     *     -  Code _MONTANT_OPERATION amount of operation
+     *     -  Code _PIECE Receipt number
+     *     -  Code _INTERNAL Internal number of op
+     *     -  Code _HTVA amount without VAT
+     *     -  Code _TVA amount VAT
+     *     -  Code _TOTAL amount HVAT + TVA
+    * @param $p_dir path
+     * @param $p_filename filename (modele)
+     * @param $p_type mimetype of the file (OOo) 
+     */
     private function histo($p_dir, $p_filename, $p_type)
     {
         global $cn, $g_parameter;
@@ -429,6 +460,9 @@
         }
         unlink($oname);
     }
+    /**
+     * Load the document into DB
+     */
     private function load_document($p_file)
     {
         global $cn;
@@ -446,6 +480,10 @@
         $this->update();
         $cn->commit();
     }
+    /**
+     * Create a PDF if GENERATE_PDF is different of NO and load it into
+     * DB
+     */
     function create_pdf()
     {
         global $cn;
@@ -470,13 +508,14 @@
         
     }
     /**
-     * 
-     * @global type $cn
-     * @param type $p_from
-     * @param type $p_subject
-     * @param type $p_message
-     * @param type $p_attach
-     * @return type
+     * Send email
+     * @param $p_from email sender
+     * @param $p_subject subject 
+     * @param $p_message message
+     * @param $p_attach 
+     *      - 0 no attach
+     *      - 1 PDF document
+     *      - 2 document from db
      */
     function send_mail($p_from, $p_subject, $p_message, $p_attach)
     {
@@ -564,6 +603,12 @@
             return $result;
         }
     }
+    /**
+     * Include into FOLLOW
+     * @param type $p_array 
+     * @see Follow_Up::fromArray
+     * @return string with result
+     */
     function include_follow($p_array)
     {
         global $cn;



---
PhpCompta est un logiciel de comptabilité libre en ligne (full web)
Projet opensource http://www.phpcompta.eu