Merge pull request #12458 from frederic34/doxygen_accountancy

doxygen accountancy class

htdocs/accountancy/class/accountancysystem.class.php

@@ -36,7 +36,7 @@ class AccountancySystem
 	/**
 	 * @var string Error code (or message)
 	 */
-	public $error='';
+	public $error = '';
 
 	/**
 	 * @var int ID
@@ -48,7 +48,14 @@ class AccountancySystem
      */
 	public $fk_pcg_version;
 
+    /**
+     * @var string pcg type
+     */
 	public $pcg_type;
+
+    /**
+     * @var string pcg subtype
+     */
 	public $pcg_subtype;
 
 	/**
@@ -61,7 +68,14 @@ class AccountancySystem
      */
     public $label;
 
+    /**
+     * @var string account number
+     */
 	public $account_number;
+
+    /**
+     * @var string account parent
+     */
 	public $account_parent;
 
 	/**

htdocs/accountancy/class/accountingjournal.class.php

@@ -42,8 +42,7 @@ class AccountingJournal extends CommonObject
 	public $fk_element = '';
 
 	/**
-	 * 0=No test on entity, 1=Test with field entity, 2=Test with link by societe
-	 * @var int
+	 * @var int 0=No test on entity, 1=Test with field entity, 2=Test with link by societe
 	 */
 	public $ismultientitymanaged = 0;
 
@@ -57,6 +56,9 @@ class AccountingJournal extends CommonObject
 	 */
 	public $rowid;
 
+    /**
+     * @var string Accounting journal code
+     */
 	public $code;
 
 	/**
@@ -64,9 +66,19 @@ class AccountingJournal extends CommonObject
      */
     public $label;
 
-	public $nature; // 1:various operations, 2:sale, 3:purchase, 4:bank, 5:expense-report, 8:inventory, 9: has-new
+    /**
+     * @var int 1:various operations, 2:sale, 3:purchase, 4:bank, 5:expense-report, 8:inventory, 9: has-new
+     */
+    public $nature;
+
+    /**
+     * @var int is active or not
+     */
 	public $active;
 
+    /**
+     * @var array array of lines
+     */
 	public $lines;
 
 	/**

htdocs/accountancy/class/bookkeeping.class.php

@@ -38,7 +38,7 @@ class BookKeeping extends CommonObject
 	public $error;
 
 	/**
-	 * @var string[] Error codes (or messages)
+	 * @var string[] Array of Error codes (or messages)
 	 */
 	public $errors = array();
 
@@ -67,7 +67,14 @@ class BookKeeping extends CommonObject
 	 */
 	public $id;
 
+    /**
+     * @var string Date of source document, in db date NOT NULL
+     */
 	public $doc_date;
+
+    /**
+     * @var int Deadline for payment
+     */
 	public $date_lim_reglement;
 
     /**
@@ -119,9 +126,25 @@ class BookKeeping extends CommonObject
      * @var string label operation
      */
     public $label_operation;
+
+    /**
+     * @var float FEC:Debit
+     */
 	public $debit;
+
+    /**
+     * @var float FEC:Credit
+     */
 	public $credit;
+
+    /**
+     * @var float FEC:Amount (Not necessary)
+     */
 	public $montant;
+
+    /**
+     * @var string FEC:Sens (Not necessary)
+     */
 	public $sens;
 
 	/**
@@ -129,9 +152,24 @@ class BookKeeping extends CommonObject
      */
 	public $fk_user_author;
 
+    /**
+     * @var string key for import
+     */
 	public $import_key;
+
+    /**
+     * @var string code journal
+     */
 	public $code_journal;
+
+    /**
+     * @var string label journal
+     */
 	public $journal_label;
+
+    /**
+     * @var int accounting transaction id
+     */
 	public $piece_num;
 
 	/**
@@ -140,7 +178,6 @@ class BookKeeping extends CommonObject
 	public $picto = 'generic';
 
 
-
 	/**
 	 * Constructor
 	 *

htdocs/install/mysql/tables/llx_accounting_bookkeeping.sql

@@ -17,7 +17,7 @@
 --
 -- ============================================================================
 
-CREATE TABLE llx_accounting_bookkeeping 
+CREATE TABLE llx_accounting_bookkeeping
 (
   rowid                 integer NOT NULL AUTO_INCREMENT PRIMARY KEY,
   entity                integer DEFAULT 1 NOT NULL,	-- 					| multi company id
@@ -27,7 +27,7 @@ CREATE TABLE llx_accounting_bookkeeping
   doc_ref               varchar(300) NOT NULL,		-- FEC:PieceRef		| facture_client/reglement_client/... reference number
   fk_doc                integer NOT NULL,			-- 					| facture_client/reglement_client/... rowid
   fk_docdet             integer NOT NULL,			-- 					| facture_client/reglement_client/... line rowid
-  thirdparty_code       varchar(32),                -- Third party code (customer or supplier) when record is saved (may help debug) 
+  thirdparty_code       varchar(32),                -- Third party code (customer or supplier) when record is saved (may help debug)
   subledger_account     varchar(32),				-- FEC:CompAuxNum	| account number of subledger account
   subledger_label       varchar(255),				-- FEC:CompAuxLib	| label of subledger account
   numero_compte         varchar(32) NOT NULL,		-- FEC:CompteNum	| account number
@@ -45,12 +45,12 @@ CREATE TABLE llx_accounting_bookkeeping
   fk_user_author        integer NOT NULL,			-- 					| user creating
   fk_user_modif         integer,					-- 					| user making last change
   date_creation         datetime,					-- FEC:EcritureDate	| creation date
-  tms                   timestamp,					--					| date last modification 
+  tms                   timestamp,					--					| date last modification
   fk_user               integer NULL,               -- The id of user that validate the accounting source document
   code_journal          varchar(32) NOT NULL,		-- FEC:JournalCode
   journal_label         varchar(255),				-- FEC:JournalLib
-  date_validated        datetime,					-- FEC:ValidDate	| if empty: movement not validated / if not empty: movement validated (No deleting / No modification) 
-  date_export	      		datetime DEFAULT NULL,		--
+  date_validated        datetime,					-- FEC:ValidDate	| if empty: movement not validated / if not empty: movement validated (No deleting / No modification)
+  date_export	      	datetime DEFAULT NULL,		--
   import_key            varchar(14),
-  extraparams	          varchar(255)				-- for other parameters with json format
+  extraparams           varchar(255)				-- for other parameters with json format
 ) ENGINE=innodb;