Merge pull request #9414 from grandoc/new_branch_03_09_2018

Standardize and update code

htdocs/commande/class/commande.class.php

@@ -64,6 +64,9 @@ class Commande extends CommonOrder
 	 */
 	public $fk_element = 'fk_commande';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'order';
 
 	/**

htdocs/compta/bank/class/account.class.php

@@ -46,6 +46,9 @@ class Account extends CommonObject
 	 */
 	public $table_element = 'bank_account';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'account';
 
 	/**
@@ -1664,6 +1667,9 @@ class AccountLine extends CommonObject
 	 */
 	public $table_element='bank';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'generic';
 
 	/**

htdocs/compta/bank/class/bankcateg.class.php

@@ -30,7 +30,10 @@ class BankCateg // extends CommonObject
 {
 	//public $element='bank_categ';			//!< Id that identify managed objects
 	//public $table_element='bank_categ';	//!< Name of table without prefix where object is stored
-    public $picto='generic';
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto='generic';
 
 	/**
      * @var int ID

htdocs/compta/bank/class/paymentvarious.class.php

@@ -40,6 +40,9 @@ class PaymentVarious extends CommonObject
 	 */
 	public $table_element='payment_various';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'bill';
 
 	/**

htdocs/compta/facture/class/facture-rec.class.php

@@ -59,6 +59,9 @@ class FactureRec extends CommonInvoice
 	 */
 	public $fk_element='fk_facture';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto='bill';
 
 	public $entity;

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

@@ -73,6 +73,9 @@ class Facture extends CommonInvoice
 	 */
 	public $fk_element = 'fk_facture';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto='bill';
 
 	/**

htdocs/compta/localtax/class/localtax.class.php

@@ -39,22 +39,25 @@ class Localtax extends CommonObject
 	 */
 	public $table_element='localtax';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto='payment';
 
-	var $ltt;
-	var $tms;
-	var $datep;
-	var $datev;
-	var $amount;
+	public $ltt;
+	public $tms;
+	public $datep;
+	public $datev;
+	public $amount;
 
 	/**
      * @var string local tax
      */
     public $label;
 
-	var $fk_bank;
-	var $fk_user_creat;
-	var $fk_user_modif;
+	public $fk_bank;
+	public $fk_user_creat;
+	public $fk_user_modif;
 
     /**
 	 *	Constructor

htdocs/compta/paiement/cheque/class/remisecheque.class.php

@@ -43,12 +43,15 @@ class RemiseCheque extends CommonObject
 	 */
 	public $table_element='bordereau_cheque';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'payment';
 
-	var $num;
-	var $intitule;
+	public $num;
+	public $intitule;
 	//! Numero d'erreur Plage 1024-1279
-	var $errno;
+	public $errno;
 
 	public $amount;
 	public $date_bordereau;

htdocs/compta/paiement/class/paiement.class.php

@@ -40,40 +40,46 @@ class Paiement extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element='payment';
-    
+
     /**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='paiement';
-	
-    public $picto = 'payment';
 
-	var $facid;
-	var $datepaye;
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto = 'payment';
+
+	public $facid;
+	public $datepaye;
+
 	/**
 	 * @deprecated
 	 * @see amount, amounts
 	 */
-    var $total;
+    public $total;
+
 	/**
 	 * @deprecated
 	 * @see amount, amounts
 	 */
-	var $montant;
-	var $amount;            // Total amount of payment
-	var $amounts=array();   // Array of amounts
-	var $multicurrency_amounts=array();   // Array of amounts
-	var $author;
-	var $paiementid;	// Type de paiement. Stocke dans fk_paiement
+	public $montant;
+
+	public $amount;            // Total amount of payment
+	public $amounts=array();   // Array of amounts
+	public $multicurrency_amounts=array();   // Array of amounts
+	public $author;
+	public $paiementid;	// Type de paiement. Stocke dans fk_paiement
 	// de llx_paiement qui est lie aux types de
 	//paiement de llx_c_paiement
-	var $num_paiement;	// Numero du CHQ, VIR, etc...
-	var $num_payment;	// Numero du CHQ, VIR, etc...
-	var $bank_account;	// Id compte bancaire du paiement
-	var $bank_line;     // Id de la ligne d'ecriture bancaire
+	public $num_paiement;	// Numero du CHQ, VIR, etc...
+	public $num_payment;	// Numero du CHQ, VIR, etc...
+	public $bank_account;	// Id compte bancaire du paiement
+	public $bank_line;     // Id de la ligne d'ecriture bancaire
 	// fk_paiement dans llx_paiement est l'id du type de paiement (7 pour CHQ, ...)
 	// fk_paiement dans llx_paiement_facture est le rowid du paiement
-    var $fk_paiement;    // Type of paiment
+    public $fk_paiement;    // Type of paiment
 
 
 	/**

htdocs/compta/prelevement/class/bonprelevement.class.php

@@ -43,33 +43,36 @@ class BonPrelevement extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element='widthdraw';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='prelevement_bons';
-	
+
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'payment';
 
-	var $date_echeance;
-	var $raison_sociale;
-	var $reference_remise;
-	var $emetteur_code_guichet;
-	var $emetteur_numero_compte;
-	var $emetteur_code_banque;
-	var $emetteur_number_key;
+	public $date_echeance;
+	public $raison_sociale;
+	public $reference_remise;
+	public $emetteur_code_guichet;
+	public $emetteur_numero_compte;
+	public $emetteur_code_banque;
+	public $emetteur_number_key;
 
-	var $emetteur_iban;
-	var $emetteur_bic;
-	var $emetteur_ics;
+	public $emetteur_iban;
+	public $emetteur_bic;
+	public $emetteur_ics;
 
-	var $total;
-	var $_fetched;
-	var $statut;    // 0-Wait, 1-Trans, 2-Done
-	var $labelstatut=array();
+	public $total;
+	public $fetched;
+	public $statut;    // 0-Wait, 1-Trans, 2-Done
+	public $labelstatut=array();
 
-	var $invoice_in_error=array();
-	var $thirdparty_in_error=array();
+	public $invoice_in_error=array();
+	public $thirdparty_in_error=array();
 
 
 	/**
@@ -106,7 +109,7 @@ class BonPrelevement extends CommonObject
 
 		$this->methodes_trans[0] = "Internet";
 
-		$this->_fetched = 0;
+		$this->fetched = 0;
 	}
 
 	/**
@@ -312,7 +315,7 @@ class BonPrelevement extends CommonObject
 
 				$this->statut             = $obj->statut;
 
-				$this->_fetched = 1;
+				$this->fetched = 1;
 
 				return 1;
 			}
@@ -420,7 +423,7 @@ class BonPrelevement extends CommonObject
 
 		$error = 0;
 
-		if ($this->_fetched == 1)
+		if ($this->fetched == 1)
 		{
 			if ($date >= $this->date_trans)
 			{

htdocs/compta/salaries/class/paymentsalary.class.php

@@ -41,6 +41,9 @@ class PaymentSalary extends CommonObject
 	 */
 	public $table_element='payment_salary';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto='payment';
 
 	public $tms;

htdocs/compta/sociales/class/chargesociales.class.php

@@ -36,33 +36,36 @@ class ChargeSociales extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element='chargesociales';
-	
+
     public $table='chargesociales';
-    
+
     /**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='chargesociales';
-	
-    public $picto = 'bill';
+
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto = 'bill';
 
     /**
      * {@inheritdoc}
      */
     protected $table_ref_field = 'ref';
 
-    var $date_ech;
-    var $lib;
-    var $type;
-    var $type_libelle;
-    var $amount;
-    var $paye;
-    var $periode;
-    var $date_creation;
-    var $date_modification;
-    var $date_validation;
-    var $fk_account;
-	var $fk_project;
+    public $date_ech;
+    public $lib;
+    public $type;
+    public $type_libelle;
+    public $amount;
+    public $paye;
+    public $periode;
+    public $date_creation;
+    public $date_modification;
+    public $date_validation;
+    public $fk_account;
+	public $fk_project;
 
 
     /**

htdocs/compta/sociales/class/paymentsocialcontribution.class.php

@@ -41,17 +41,22 @@ class PaymentSocialContribution extends CommonObject
 	 */
 	public $table_element='paiementcharge';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'payment';
 
 	public $fk_charge;
 	public $datec='';
 	public $tms='';
 	public $datep='';
+
 	/**
 	 * @deprecated
 	 * @see amount
 	 */
 	public $total;
+
     public $amount;            // Total amount of payment
     public $amounts=array();   // Array of amounts
 	public $fk_typepaiement;

htdocs/compta/tva/class/tva.class.php

@@ -43,23 +43,26 @@ class Tva extends CommonObject
 	 */
 	public $table_element='tva';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto='payment';
 
-	var $tms;
-	var $datep;
-	var $datev;
-	var $amount;
-	var $type_payment;
-	var $num_payment;
+	public $tms;
+	public $datep;
+	public $datev;
+	public $amount;
+	public $type_payment;
+	public $num_payment;
 
 	/**
      * @var string label
      */
     public $label;
 
-	var $fk_bank;
-	var $fk_user_creat;
-	var $fk_user_modif;
+	public $fk_bank;
+	public $fk_user_creat;
+	public $fk_user_modif;
 
     /**
 	 *	Constructor

htdocs/contact/class/contact.class.php

@@ -41,13 +41,17 @@ class Contact extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element='contact';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='socpeople';
-	
+
 	public $ismultientitymanaged = 1;	// 0=No test on entity, 1=Test with field entity, 2=Test with link by societe
+
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'contact';
 
 
@@ -726,7 +730,7 @@ class Contact extends CommonObject
 
 				$this->date_creation     = $this->db->jdate($obj->date_creation);
 				$this->date_modification = $this->db->jdate($obj->date_modification);
-				
+
 				$this->fk_departement	= $obj->fk_departement;    // deprecated
 				$this->state_id			= $obj->fk_departement;
 				$this->departement_code	= $obj->state_code;	       // deprecated

htdocs/contrat/class/contrat.class.php

@@ -61,7 +61,10 @@ class Contrat extends CommonObject
 	 */
 	public $fk_element='fk_contrat';
 
-    public $picto='contract';
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto='contract';
 
     /**
      * 0=No test on entity, 1=Test with field entity, 2=Test with link by societe

htdocs/core/triggers/interface_20_all_Logevents.class.php

@@ -31,7 +31,11 @@ require_once DOL_DOCUMENT_ROOT.'/core/triggers/dolibarrtriggers.class.php';
  */
 class InterfaceLogevents extends DolibarrTriggers
 {
+	/**
+	 * @var string Image of the trigger
+	 */
 	public $picto = 'technic';
+
 	public $family = 'core';
 	public $description = "Triggers of this module allows to add security event records inside Dolibarr.";
 	public $version = self::VERSION_DOLIBARR;

htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php

@@ -32,7 +32,11 @@ require_once DOL_DOCUMENT_ROOT.'/core/triggers/dolibarrtriggers.class.php';
 
 class InterfaceWorkflowManager extends DolibarrTriggers
 {
+	/**
+	 * @var string Image of the trigger
+	 */
 	public $picto = 'technic';
+
 	public $family = 'core';
 	public $description = "Triggers of this module allows to manage workflows";
 	public $version = self::VERSION_DOLIBARR;

htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php

@@ -37,6 +37,10 @@ class InterfaceActionsAuto extends DolibarrTriggers
 	public $family = 'agenda';
 	public $description = "Triggers of this module add actions in agenda according to setup made in agenda setup.";
 	public $version = self::VERSION_DOLIBARR;
+
+	/**
+	 * @var string Image of the trigger
+	 */
 	public $picto = 'action';
 
 	/**

htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php

@@ -33,6 +33,10 @@ class InterfaceActionsBlockedLog extends DolibarrTriggers
 	public $family = 'system';
 	public $description = "Triggers of this module add action for BlockedLog module.";
 	public $version = self::VERSION_DOLIBARR;
+
+	/**
+	 * @var string Image of the trigger
+	 */
 	public $picto = 'technic';
 
 	/**

htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php

@@ -34,6 +34,10 @@ class InterfaceLdapsynchro extends DolibarrTriggers
 	public $family = 'ldap';
 	public $description = "Triggers of this module allows to synchronize Dolibarr toward a LDAP database.";
 	public $version = self::VERSION_DOLIBARR;
+
+	/**
+	 * @var string Image of the trigger
+	 */
 	public $picto = 'technic';
 
 	/**

htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php

@@ -32,6 +32,10 @@ class InterfaceMailmanSpipsynchro extends DolibarrTriggers
 	public $family = 'mailmanspip';
 	public $description = "Triggers of this module allows to synchronize Mailman an Spip.";
 	public $version = self::VERSION_DOLIBARR;
+
+	/**
+	 * @var string Image of the trigger
+	 */
 	public $picto = 'technic';
 
 	/**

htdocs/core/triggers/interface_50_modNotification_Notification.class.php

@@ -33,9 +33,13 @@ class InterfaceNotification extends DolibarrTriggers
 	public $family = 'notification';
 	public $description = "Triggers of this module send email notifications according to Notification module setup.";
 	public $version = self::VERSION_DOLIBARR;
+
+	/**
+	 * @var string Image of the trigger
+	 */
 	public $picto = 'email';
 
-	var $listofmanagedevents=array(
+	public $listofmanagedevents=array(
 		'BILL_VALIDATE',
 		'BILL_PAYED',
 		'ORDER_VALIDATE',

htdocs/cron/class/cronjob.class.php

@@ -40,7 +40,10 @@ class Cronjob extends CommonObject
 	 */
 	public $table_element='cronjob';
 
-    public $picto = 'cron';
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto = 'cron';
 
     /**
 	 * @var int Entity

htdocs/don/class/don.class.php

@@ -50,7 +50,11 @@ class Don extends CommonObject
 	public $fk_element = 'fk_donation';
 
 	public $ismultientitymanaged = 1;  	// 0=No test on entity, 1=Test with field entity, 2=Test with link by societe
-    public $picto = 'generic';
+
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto = 'generic';
 
     public $date;
     public $amount;

htdocs/don/class/paymentdonation.class.php

@@ -39,7 +39,10 @@ class PaymentDonation extends CommonObject
 	 */
 	public $table_element='payment_donation';
 
-    public $picto = 'payment';
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto = 'payment';
 
 	/**
 	 * @var int ID

htdocs/ecm/class/ecmdirectory.class.php

@@ -37,6 +37,9 @@ class EcmDirectory // extends CommonObject
 	 */
 	//public $table_element='ecm_directories';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'dir';
 
 	/**

htdocs/ecm/class/ecmfiles.class.php

@@ -46,6 +46,9 @@ class EcmFiles extends CommonObject
 	 */
 	public $table_element = 'ecm_files';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'generic';
 
 	/**

htdocs/expedition/class/expedition.class.php

@@ -62,6 +62,10 @@ class Expedition extends CommonObject
 	public $table_element_line="expeditiondet";
 
 	public $ismultientitymanaged = 1;	// 0=No test on entity, 1=Test with field entity, 2=Test with link by societe
+
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'sending';
 
 	public $socid;

htdocs/expensereport/class/paymentexpensereport.class.php

@@ -40,24 +40,27 @@ class PaymentExpenseReport extends CommonObject
 	 */
 	public $table_element='payment_expensereport';
 
-    public $picto = 'payment';
+    /**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
+	public $picto = 'payment';
 
-	var $rowid;
+	public $rowid;
 
-	var $fk_expensereport;
-	var $datec='';
-	var $tms='';
-	var $datep='';
-    var $amount;            // Total amount of payment
-    var $amounts=array();   // Array of amounts
-	var $fk_typepayment;
-	var $num_payment;
-	var $fk_bank;
-	var $fk_user_creat;
-	var $fk_user_modif;
+	public $fk_expensereport;
+	public $datec='';
+	public $tms='';
+	public $datep='';
+    public $amount;            // Total amount of payment
+    public $amounts=array();   // Array of amounts
+	public $fk_typepayment;
+	public $num_payment;
+	public $fk_bank;
+	public $fk_user_creat;
+	public $fk_user_modif;
     //Unknow field
-    var $chid;
-    var $total;
+    public $chid;
+    public $total;
 
 	/**
 	 *	Constructor

htdocs/fichinter/class/fichinter.class.php

@@ -55,6 +55,9 @@ class Fichinter extends CommonObject
 	 */
 	public $table_element_line='fichinterdet';
 
+	/**
+	 * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
+	 */
 	public $picto = 'intervention';
 
 	/**