diff --git a/htdocs/blockedlog/class/blockedlog.class.php b/htdocs/blockedlog/class/blockedlog.class.php index dab99d80bc9..eb2070d703a 100644 --- a/htdocs/blockedlog/class/blockedlog.class.php +++ b/htdocs/blockedlog/class/blockedlog.class.php @@ -46,6 +46,9 @@ class BlockedLog */ public $entity; + /** + * @var string Error message + */ public $error = ''; /** diff --git a/htdocs/compta/bank/class/account.class.php b/htdocs/compta/bank/class/account.class.php index 3bd5997506e..c45067740af 100644 --- a/htdocs/compta/bank/class/account.class.php +++ b/htdocs/compta/bank/class/account.class.php @@ -1716,7 +1716,11 @@ class AccountLine extends CommonObject public $fk_account; // Id of bank account public $bank_account_label; // Label of bank account - public $emetteur; + /** + * Issuer + * @var Societe + */ + public $emetteur; /** * Constructor diff --git a/htdocs/core/class/CMailFile.class.php b/htdocs/core/class/CMailFile.class.php index 8fd6e48d8a3..d1a46e4d0b9 100644 --- a/htdocs/core/class/CMailFile.class.php +++ b/htdocs/core/class/CMailFile.class.php @@ -59,7 +59,11 @@ class CMailFile var $eol; var $eol2; - var $error=''; + + /** + * @var string Error code (or message) + */ + public $error=''; var $smtps; // Contains SMTPs object (if this method is used) var $phpmailer; // Contains PHPMailer object (if this method is used) diff --git a/htdocs/core/class/CSMSFile.class.php b/htdocs/core/class/CSMSFile.class.php index c2512af70ef..b6c334f7e1c 100644 --- a/htdocs/core/class/CSMSFile.class.php +++ b/htdocs/core/class/CSMSFile.class.php @@ -34,15 +34,18 @@ */ class CSMSFile { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; - var $addr_from; - var $addr_to; - var $deferred; - var $priority; - var $class; - var $message; - var $nostop; + public $addr_from; + public $addr_to; + public $deferred; + public $priority; + public $class; + public $message; + public $nostop; /** diff --git a/htdocs/core/class/commonstickergenerator.class.php b/htdocs/core/class/commonstickergenerator.class.php index 6d4c32d82bb..5289ed882ff 100644 --- a/htdocs/core/class/commonstickergenerator.class.php +++ b/htdocs/core/class/commonstickergenerator.class.php @@ -61,9 +61,12 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/format_cards.lib.php'; */ abstract class CommonStickerGenerator { - public $code; // Code of format - public $format; // Array with informations + + /** + * @var array format Array with informations + */ + public $format; // protected var $_Avery_Name = ''; // Nom du format de l'etiquette diff --git a/htdocs/core/class/cstate.class.php b/htdocs/core/class/cstate.class.php index 13c02ed777a..4320446d7b5 100644 --- a/htdocs/core/class/cstate.class.php +++ b/htdocs/core/class/cstate.class.php @@ -56,7 +56,19 @@ class Cstate // extends CommonObject public $id; public $code_departement; - public $nom; + + /** + * @var string + * @deprecated + * @see name + */ + public $nom=''; + + /** + * @var string name + */ + public $name=''; + public $active; diff --git a/htdocs/core/modules/action/rapport.pdf.php b/htdocs/core/modules/action/rapport.pdf.php index a72c6c5af94..66c4f0a3e45 100644 --- a/htdocs/core/modules/action/rapport.pdf.php +++ b/htdocs/core/modules/action/rapport.pdf.php @@ -45,17 +45,23 @@ class CommActionRapport */ public $description; - var $date_edition; - var $year; - var $month; + public $date_edition; - var $title; - var $subject; + public $year; - var $marge_gauche; - var $marge_droite; - var $marge_haute; - var $marge_basse; + public $month; + + public $title; + + public $subject; + + public $marge_gauche; + + public $marge_droite; + + public $marge_haute; + + public $marge_basse; /** @@ -67,7 +73,7 @@ class CommActionRapport */ function __construct($db, $month, $year) { - global $conf,$langs; + global $conf, $langs; // Load translation files required by the page $langs->loadLangs(array("commercial","projects")); diff --git a/htdocs/core/modules/bank/doc/pdf_ban.modules.php b/htdocs/core/modules/bank/doc/pdf_ban.modules.php index 9a62200eb74..97a91951e81 100644 --- a/htdocs/core/modules/bank/doc/pdf_ban.modules.php +++ b/htdocs/core/modules/bank/doc/pdf_ban.modules.php @@ -35,8 +35,17 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php'; class pdf_ban extends ModeleBankAccountDoc { - var $emetteur; // Objet societe qui emet - var $version = 'development'; + /** + * Issuer + * @var Societe + */ + public $emetteur; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'development'; /** * Constructor diff --git a/htdocs/core/modules/bank/doc/pdf_sepamandate.modules.php b/htdocs/core/modules/bank/doc/pdf_sepamandate.modules.php index 0e954cfc28e..f62b699b4ef 100644 --- a/htdocs/core/modules/bank/doc/pdf_sepamandate.modules.php +++ b/htdocs/core/modules/bank/doc/pdf_sepamandate.modules.php @@ -35,8 +35,17 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php'; class pdf_sepamandate extends ModeleBankAccountDoc { - var $emetteur; // Objet societe qui emet - var $version = 'dolibarr'; + /** + * Issuer + * @var Societe + */ + public $emetteur; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; /** * Constructor @@ -45,7 +54,7 @@ class pdf_sepamandate extends ModeleBankAccountDoc */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Translations $langs->loadLangs(array("main", "bank", "withdrawals", "companies")); diff --git a/htdocs/core/modules/barcode/doc/phpbarcode.modules.php b/htdocs/core/modules/barcode/doc/phpbarcode.modules.php index 2cca0e8927d..c9068dc4d26 100644 --- a/htdocs/core/modules/barcode/doc/phpbarcode.modules.php +++ b/htdocs/core/modules/barcode/doc/phpbarcode.modules.php @@ -32,8 +32,12 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/barcode.lib.php'; // This is to inc */ class modPhpbarcode extends ModeleBarCode { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + /** * @var string Error code (or message) */ diff --git a/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php b/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php index fcf01131f46..c37f87f17d5 100644 --- a/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php +++ b/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php @@ -31,14 +31,18 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/barcode.lib.php'; // This is to inc */ class modTcpdfbarcode extends ModeleBarCode { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + /** * @var string Error code (or message) */ public $error=''; - - var $is2d = false; + + public $is2d = false; /** * Return description of numbering model diff --git a/htdocs/core/modules/barcode/mod_barcode_product_standard.php b/htdocs/core/modules/barcode/mod_barcode_product_standard.php index 42ce154c648..886ff87520a 100644 --- a/htdocs/core/modules/barcode/mod_barcode_product_standard.php +++ b/htdocs/core/modules/barcode/mod_barcode_product_standard.php @@ -33,17 +33,29 @@ require_once DOL_DOCUMENT_ROOT.'/core/modules/barcode/modules_barcode.class.php' */ class mod_barcode_product_standard extends ModeleNumRefBarCode { - var $name='Standard'; // Model Name - var $code_modifiable; // Editable code - var $code_modifiable_invalide; // Modified code if it is invalid - var $code_modifiable_null; // Modified code if it is null - var $code_null; // Optional code - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $code_auto; // Automatic Numbering + public $name='Standard'; // Model Name - var $searchcode; // Search string - var $numbitcounter; // Number of digits the counter - var $prefixIsRequired; // The prefix field of third party must be filled when using {pre} + public $code_modifiable; // Editable code + + public $code_modifiable_invalide; // Modified code if it is invalid + + public $code_modifiable_null; // Modified code if it is null + + public $code_null; // Optional code + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $code_auto; // Automatic Numbering + + public $searchcode; // Search string + + public $numbitcounter; // Number of digits the counter + + public $prefixIsRequired; // The prefix field of third party must be filled when using {pre} /** diff --git a/htdocs/core/modules/cheque/doc/pdf_blochet.class.php b/htdocs/core/modules/cheque/doc/pdf_blochet.class.php index 159f8664390..c4995ead47f 100644 --- a/htdocs/core/modules/cheque/doc/pdf_blochet.class.php +++ b/htdocs/core/modules/cheque/doc/pdf_blochet.class.php @@ -34,7 +34,11 @@ require_once DOL_DOCUMENT_ROOT.'/core/modules/cheque/modules_chequereceipts.php' */ class BordereauChequeBlochet extends ModeleChequeReceipts { - var $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; /** * Constructor diff --git a/htdocs/core/modules/cheque/mod_chequereceipt_mint.php b/htdocs/core/modules/cheque/mod_chequereceipt_mint.php index b3b6fb96b66..ba617787cbe 100644 --- a/htdocs/core/modules/cheque/mod_chequereceipt_mint.php +++ b/htdocs/core/modules/cheque/mod_chequereceipt_mint.php @@ -29,13 +29,20 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/cheque/modules_chequereceipts.php */ class mod_chequereceipt_mint extends ModeleNumRefChequeReceipts { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='CHK'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='CHK'; + /** * @var string Error code (or message) */ public $error=''; - var $name='Mint'; + + public $name='Mint'; /** diff --git a/htdocs/core/modules/cheque/mod_chequereceipt_thyme.php b/htdocs/core/modules/cheque/mod_chequereceipt_thyme.php index caf063da7d4..6e211fb4ace 100644 --- a/htdocs/core/modules/cheque/mod_chequereceipt_thyme.php +++ b/htdocs/core/modules/cheque/mod_chequereceipt_thyme.php @@ -30,9 +30,18 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/cheque/modules_chequereceipts.php */ class mod_chequereceipt_thyme extends ModeleNumRefChequeReceipts { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $name = 'Thyme'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error message + */ + public $error = ''; + + public $name = 'Thyme'; /** @@ -42,7 +51,7 @@ class mod_chequereceipt_thyme extends ModeleNumRefChequeReceipts */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php b/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php index 7c3ca5bd2e6..3839edb85c1 100644 --- a/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php +++ b/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php @@ -3,6 +3,7 @@ * Copyright (C) 2012 Juanjo Menent * Copyright (C) 2014 Marcos García * Copyright (C) 2016 Charlie Benke + * Copyright (C) 2018 Philippe Grand * * 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 @@ -44,7 +45,11 @@ class doc_generic_order_odt extends ModelePDFCommandes */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document diff --git a/htdocs/core/modules/commande/mod_commande_marbre.php b/htdocs/core/modules/commande/mod_commande_marbre.php index 8ff489cc5fa..8345d694cff 100644 --- a/htdocs/core/modules/commande/mod_commande_marbre.php +++ b/htdocs/core/modules/commande/mod_commande_marbre.php @@ -29,13 +29,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/commande/modules_commande.php'; */ class mod_commande_marbre extends ModeleNumRefCommandes { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='CO'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='CO'; + /** * @var string Error code (or message) */ public $error=''; - var $nom='Marbre'; + + /** + * @var string + * @deprecated + * @see name + */ + public $nom='Marbre'; + + /** + * @var string name + */ + public $name='Marbre'; /** diff --git a/htdocs/core/modules/commande/mod_commande_saphir.php b/htdocs/core/modules/commande/mod_commande_saphir.php index ae856072049..588d6fffc6d 100644 --- a/htdocs/core/modules/commande/mod_commande_saphir.php +++ b/htdocs/core/modules/commande/mod_commande_saphir.php @@ -33,9 +33,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/commande/modules_commande.php'; */ class mod_commande_saphir extends ModeleNumRefCommandes { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Saphir'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string nom + * @deprecated + * @see name + */ + public $nom='Saphir'; + + /** + * @var string name + */ + public $name='Saphir'; /** @@ -45,7 +64,7 @@ class mod_commande_saphir extends ModeleNumRefCommandes */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/contract/doc/doc_generic_contract_odt.modules.php b/htdocs/core/modules/contract/doc/doc_generic_contract_odt.modules.php index eca3f13d57f..8a3fdd53ebc 100644 --- a/htdocs/core/modules/contract/doc/doc_generic_contract_odt.modules.php +++ b/htdocs/core/modules/contract/doc/doc_generic_contract_odt.modules.php @@ -43,7 +43,11 @@ class doc_generic_contract_odt extends ModelePDFContract */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document @@ -59,7 +63,7 @@ class doc_generic_contract_odt extends ModelePDFContract */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Load translation files required by the page $langs->loadLangs(array("main","companies")); diff --git a/htdocs/core/modules/contract/mod_contract_magre.php b/htdocs/core/modules/contract/mod_contract_magre.php index 72c8c5bef23..4769ec17f99 100644 --- a/htdocs/core/modules/contract/mod_contract_magre.php +++ b/htdocs/core/modules/contract/mod_contract_magre.php @@ -29,10 +29,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/contract/modules_contract.php'; */ class mod_contract_magre extends ModelNumRefContracts { - var $version='dolibarr'; - var $error = ''; - var $nom = 'Magre'; - var $code_auto=1; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string nom + * @deprecated + * @see name + */ + public $nom='Magre'; + + /** + * @var string name + */ + public $name='Magre'; + + public $code_auto=1; /** * Return default description of numbering model diff --git a/htdocs/core/modules/contract/mod_contract_olive.php b/htdocs/core/modules/contract/mod_contract_olive.php index 6d22aebeb3d..993f4bf9bfb 100644 --- a/htdocs/core/modules/contract/mod_contract_olive.php +++ b/htdocs/core/modules/contract/mod_contract_olive.php @@ -32,15 +32,33 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/contract/modules_contract.php'; */ class mod_contract_olive extends ModelNumRefContracts { + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Olive'; + /** + * @var string model name + */ + public $name='Olive'; - var $nom='Olive'; // Nom du modele - var $code_modifiable = 1; // Code modifiable - var $code_modifiable_invalide = 1; // Code modifiable si il est invalide - var $code_modifiable_null = 1; // Code modifiables si il est null - var $code_null = 1; // Code facultatif - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $code_auto = 0; // Numerotation automatique + public $code_modifiable = 1; // Code modifiable + + public $code_modifiable_invalide = 1; // Code modifiable si il est invalide + + public $code_modifiable_null = 1; // Code modifiables si il est null + + public $code_null = 1; // Code facultatif + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $code_auto = 0; // Numerotation automatique /** diff --git a/htdocs/core/modules/contract/mod_contract_serpis.php b/htdocs/core/modules/contract/mod_contract_serpis.php index ca7ba32184f..e91775f669c 100644 --- a/htdocs/core/modules/contract/mod_contract_serpis.php +++ b/htdocs/core/modules/contract/mod_contract_serpis.php @@ -28,14 +28,32 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/contract/modules_contract.php'; */ class mod_contract_serpis extends ModelNumRefContracts { - var $version='dolibarr'; - var $prefix='CT'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; + + public $prefix='CT'; + /** * @var string Error code (or message) */ public $error=''; - var $nom='Serpis'; - var $code_auto=1; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Serpis'; + + /** + * @var string model name + */ + public $name='Serpis'; + + public $code_auto=1; /** diff --git a/htdocs/core/modules/expedition/doc/doc_generic_shipment_odt.modules.php b/htdocs/core/modules/expedition/doc/doc_generic_shipment_odt.modules.php index 729663bf625..5a128ec99d3 100644 --- a/htdocs/core/modules/expedition/doc/doc_generic_shipment_odt.modules.php +++ b/htdocs/core/modules/expedition/doc/doc_generic_shipment_odt.modules.php @@ -2,7 +2,8 @@ /* Copyright (C) 2010-2012 Laurent Destailleur * Copyright (C) 2012 Juanjo Menent * Copyright (C) 2014 Marcos García - * Copyright (C) 2016 Charlie Benke + * Copyright (C) 2016 Charlie Benke + * Copyright (C) 2018 Philippe Grand * * This program is free software; you can redistribute it and/or modify @@ -45,7 +46,11 @@ class doc_generic_shipment_odt extends ModelePdfExpedition */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document diff --git a/htdocs/core/modules/expedition/mod_expedition_ribera.php b/htdocs/core/modules/expedition/mod_expedition_ribera.php index dadde0fd814..35a5eb2325b 100644 --- a/htdocs/core/modules/expedition/mod_expedition_ribera.php +++ b/htdocs/core/modules/expedition/mod_expedition_ribera.php @@ -29,9 +29,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/expedition/modules_expedition.php */ class mod_expedition_ribera extends ModelNumRefExpedition { - var $version='dolibarr'; - var $error = ''; - var $nom = 'Ribera'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Ribera'; + + /** + * @var string model name + */ + public $name='Ribera'; /** * Return default description of numbering model @@ -40,7 +59,7 @@ class mod_expedition_ribera extends ModelNumRefExpedition */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/expedition/mod_expedition_safor.php b/htdocs/core/modules/expedition/mod_expedition_safor.php index 2a20c22a88d..2ebf9335755 100644 --- a/htdocs/core/modules/expedition/mod_expedition_safor.php +++ b/htdocs/core/modules/expedition/mod_expedition_safor.php @@ -28,13 +28,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/expedition/modules_expedition.php */ class mod_expedition_safor extends ModelNumRefExpedition { - var $version='dolibarr'; - var $prefix='SH'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; + + public $prefix='SH'; + /** * @var string Error code (or message) */ public $error=''; - var $nom='Safor'; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Safor'; + + /** + * @var string model name + */ + public $name='Safor'; /** diff --git a/htdocs/core/modules/expensereport/mod_expensereport_jade.php b/htdocs/core/modules/expensereport/mod_expensereport_jade.php index b1e01d40bb9..385a7558c4c 100644 --- a/htdocs/core/modules/expensereport/mod_expensereport_jade.php +++ b/htdocs/core/modules/expensereport/mod_expensereport_jade.php @@ -28,13 +28,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/expensereport/modules_expenserepo */ class mod_expensereport_jade extends ModeleNumRefExpenseReport { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='ER'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='ER'; + /** * @var string Error code (or message) */ public $error=''; - var $nom='Jade'; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Jade'; + + /** + * @var string model name + */ + public $name='Jade'; /** diff --git a/htdocs/core/modules/expensereport/mod_expensereport_sand.php b/htdocs/core/modules/expensereport/mod_expensereport_sand.php index 4222bf163d5..95cc3d39c95 100644 --- a/htdocs/core/modules/expensereport/mod_expensereport_sand.php +++ b/htdocs/core/modules/expensereport/mod_expensereport_sand.php @@ -30,9 +30,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/expensereport/modules_expenserepo */ class mod_expensereport_sand extends ModeleNumRefExpenseReport { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Sand'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Sand'; + + /** + * @var string model name + */ + public $name='Sand'; /** @@ -42,7 +61,7 @@ class mod_expensereport_sand extends ModeleNumRefExpenseReport */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/export/export_csv.modules.php b/htdocs/core/modules/export/export_csv.modules.php index c3dfc84f94c..1efe6161647 100644 --- a/htdocs/core/modules/export/export_csv.modules.php +++ b/htdocs/core/modules/export/export_csv.modules.php @@ -41,9 +41,15 @@ class ExportCsv extends ModeleExports public $label; public $extension; - public $version; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; public $label_lib; + public $version_lib; public $separator; @@ -58,7 +64,7 @@ class ExportCsv extends ModeleExports */ function __construct($db) { - global $conf,$langs; + global $conf, $langs; $this->db = $db; $this->separator=','; diff --git a/htdocs/core/modules/export/export_excel.modules.php b/htdocs/core/modules/export/export_excel.modules.php index 665a6925c6b..1982fffb07e 100644 --- a/htdocs/core/modules/export/export_excel.modules.php +++ b/htdocs/core/modules/export/export_excel.modules.php @@ -43,15 +43,25 @@ class ExportExcel extends ModeleExports public $label; public $extension; - public $version; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; public $label_lib; + public $version_lib; public $workbook; // Handle file + public $worksheet; // Handle sheet + public $row; + public $col; + public $file; // To save filename diff --git a/htdocs/core/modules/export/export_excel2007.modules.php b/htdocs/core/modules/export/export_excel2007.modules.php index 74e35ff5b18..6c80ac5977e 100644 --- a/htdocs/core/modules/export/export_excel2007.modules.php +++ b/htdocs/core/modules/export/export_excel2007.modules.php @@ -44,15 +44,25 @@ class ExportExcel2007 extends ExportExcel public $label; public $extension; - public $version; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; public $label_lib; + public $version_lib; public $workbook; // Handle fichier + public $worksheet; // Handle onglet + public $row; + public $col; + public $file; // To save filename /** diff --git a/htdocs/core/modules/export/export_tsv.modules.php b/htdocs/core/modules/export/export_tsv.modules.php index 4b57d5f7fcf..8afa9ded884 100644 --- a/htdocs/core/modules/export/export_tsv.modules.php +++ b/htdocs/core/modules/export/export_tsv.modules.php @@ -42,9 +42,15 @@ class ExportTsv extends ModeleExports public $label; public $extension; - public $version; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; public $label_lib; + public $version_lib; public $separator="\t"; diff --git a/htdocs/core/modules/export/modules_export.php b/htdocs/core/modules/export/modules_export.php index 6c155510f30..6436b501705 100644 --- a/htdocs/core/modules/export/modules_export.php +++ b/htdocs/core/modules/export/modules_export.php @@ -35,11 +35,13 @@ class ModeleExports extends CommonDocGenerator // This class can't be abstrac */ public $error=''; - var $driverlabel=array(); - var $driverversion=array(); + public $driverlabel=array(); - var $liblabel=array(); - var $libversion=array(); + public $driverversion=array(); + + public $liblabel=array(); + + public $libversion=array(); // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps diff --git a/htdocs/core/modules/facture/doc/doc_generic_invoice_odt.modules.php b/htdocs/core/modules/facture/doc/doc_generic_invoice_odt.modules.php index 77824b75c8c..93f4dbe88ca 100644 --- a/htdocs/core/modules/facture/doc/doc_generic_invoice_odt.modules.php +++ b/htdocs/core/modules/facture/doc/doc_generic_invoice_odt.modules.php @@ -44,7 +44,11 @@ class doc_generic_invoice_odt extends ModelePDFFactures */ public $emetteur; // Objet societe qui emet - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document @@ -60,7 +64,7 @@ class doc_generic_invoice_odt extends ModelePDFFactures */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Load translation files required by the page $langs->loadLangs(array("main","companies")); diff --git a/htdocs/core/modules/facture/doc/pdf_crabe.modules.php b/htdocs/core/modules/facture/doc/pdf_crabe.modules.php index 417ee6249b3..7d39969ece9 100644 --- a/htdocs/core/modules/facture/doc/pdf_crabe.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_crabe.modules.php @@ -139,7 +139,7 @@ class pdf_crabe extends ModelePDFFactures */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Translations $langs->loadLangs(array("main", "bills")); diff --git a/htdocs/core/modules/facture/mod_facture_mars.php b/htdocs/core/modules/facture/mod_facture_mars.php index 5a2d1281385..a1ed1e32d24 100644 --- a/htdocs/core/modules/facture/mod_facture_mars.php +++ b/htdocs/core/modules/facture/mod_facture_mars.php @@ -30,11 +30,20 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/facture/modules_facture.php'; */ class mod_facture_mars extends ModeleNumRefFactures { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefixinvoice='FA'; - var $prefixreplacement='FR'; - var $prefixdeposit='AC'; - var $prefixcreditnote='AV'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefixinvoice='FA'; + + public $prefixreplacement='FR'; + + public $prefixdeposit='AC'; + + public $prefixcreditnote='AV'; + /** * @var string Error code (or message) */ diff --git a/htdocs/core/modules/facture/mod_facture_mercure.php b/htdocs/core/modules/facture/mod_facture_mercure.php index 89c526bc334..dabd3fbd576 100644 --- a/htdocs/core/modules/facture/mod_facture_mercure.php +++ b/htdocs/core/modules/facture/mod_facture_mercure.php @@ -33,8 +33,16 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/facture/modules_facture.php'; */ class mod_facture_mercure extends ModeleNumRefFactures { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error message + */ + public $error = ''; /** @@ -44,7 +52,7 @@ class mod_facture_mercure extends ModeleNumRefFactures */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/facture/mod_facture_terre.php b/htdocs/core/modules/facture/mod_facture_terre.php index 524eeebdd5f..a55418a8cb5 100644 --- a/htdocs/core/modules/facture/mod_facture_terre.php +++ b/htdocs/core/modules/facture/mod_facture_terre.php @@ -29,10 +29,18 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/facture/modules_facture.php'; */ class mod_facture_terre extends ModeleNumRefFactures { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefixinvoice='FA'; - var $prefixcreditnote='AV'; - var $prefixdeposit='AC'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefixinvoice='FA'; + + public $prefixcreditnote='AV'; + + public $prefixdeposit='AC'; + /** * @var string Error code (or message) */ diff --git a/htdocs/core/modules/fichinter/mod_arctic.php b/htdocs/core/modules/fichinter/mod_arctic.php index 3e6193e0740..82013e94413 100644 --- a/htdocs/core/modules/fichinter/mod_arctic.php +++ b/htdocs/core/modules/fichinter/mod_arctic.php @@ -32,9 +32,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/fichinter/modules_fichinter.php'; */ class mod_arctic extends ModeleNumRefFicheinter { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'arctic'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='arctic'; + + /** + * @var string model name + */ + public $name='arctic'; /** @@ -44,7 +63,7 @@ class mod_arctic extends ModeleNumRefFicheinter */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/fichinter/mod_pacific.php b/htdocs/core/modules/fichinter/mod_pacific.php index c412c1d340c..dcf6baf5ef6 100644 --- a/htdocs/core/modules/fichinter/mod_pacific.php +++ b/htdocs/core/modules/fichinter/mod_pacific.php @@ -30,13 +30,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/fichinter/modules_fichinter.php'; */ class mod_pacific extends ModeleNumRefFicheinter { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='FI'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='FI'; + /** * @var string Error code (or message) */ public $error=''; - var $nom = 'pacific'; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='pacific'; + + /** + * @var string model name + */ + public $name='pacific'; /** diff --git a/htdocs/core/modules/holiday/mod_holiday_immaculate.php b/htdocs/core/modules/holiday/mod_holiday_immaculate.php index 16b7adce4ac..b63326ca276 100644 --- a/htdocs/core/modules/holiday/mod_holiday_immaculate.php +++ b/htdocs/core/modules/holiday/mod_holiday_immaculate.php @@ -30,10 +30,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/holiday/modules_holiday.php'; */ class mod_holiday_immaculate extends ModelNumRefHolidays { - var $version='dolibarr'; - var $error = ''; - var $nom = 'Immaculate'; - var $code_auto=1; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Immaculate'; + + /** + * @var string model name + */ + public $name='Immaculate'; + + public $code_auto=1; /** * Return default description of numbering model @@ -42,7 +62,7 @@ class mod_holiday_immaculate extends ModelNumRefHolidays */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/holiday/mod_holiday_madonna.php b/htdocs/core/modules/holiday/mod_holiday_madonna.php index ba951bb557c..98380d9fae5 100644 --- a/htdocs/core/modules/holiday/mod_holiday_madonna.php +++ b/htdocs/core/modules/holiday/mod_holiday_madonna.php @@ -29,14 +29,32 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/holiday/modules_holiday.php'; */ class mod_holiday_madonna extends ModelNumRefHolidays { - var $version='dolibarr'; - var $prefix='HL'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; + + public $prefix='HL'; + /** * @var string Error code (or message) */ public $error=''; - var $nom='Madonna'; - var $code_auto=1; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Madonna'; + + /** + * @var string model name + */ + public $name='Madonna'; + + public $code_auto=1; /** diff --git a/htdocs/core/modules/import/import_csv.modules.php b/htdocs/core/modules/import/import_csv.modules.php index 2b8d2825f75..60dc9bf6c15 100644 --- a/htdocs/core/modules/import/import_csv.modules.php +++ b/htdocs/core/modules/import/import_csv.modules.php @@ -38,7 +38,7 @@ class ImportCsv extends ModeleImports */ public $db; - var $datatoimport; + public $datatoimport; /** * @var string Error code (or message) @@ -61,20 +61,29 @@ class ImportCsv extends ModeleImports public $label; public $extension; // Extension of files imported by driver - public $version; // Version of driver + + /** + * Dolibarr version of driver + * @public string + */ + public $version = 'dolibarr'; public $label_lib; // Label of external lib used by driver + public $version_lib; // Version of external lib used by driver public $separator; public $file; // Path of file + public $handle; // Handle fichier public $cacheconvert=array(); // Array to cache list of value found after a convertion + public $cachefieldtable=array(); // Array to cache list of value found into fields@tables public $nbinsert = 0; // # of insert done during the import + public $nbupdate = 0; // # of update done during the import @@ -86,7 +95,7 @@ class ImportCsv extends ModeleImports */ function __construct($db,$datatoimport) { - global $conf,$langs; + global $conf, $langs; $this->db = $db; $this->separator=(GETPOST('separator')?GETPOST('separator'):(empty($conf->global->IMPORT_CSV_SEPARATOR_TO_USE)?',':$conf->global->IMPORT_CSV_SEPARATOR_TO_USE)); diff --git a/htdocs/core/modules/import/import_xlsx.modules.php b/htdocs/core/modules/import/import_xlsx.modules.php index 31f09a7893f..36b57e2d69a 100644 --- a/htdocs/core/modules/import/import_xlsx.modules.php +++ b/htdocs/core/modules/import/import_xlsx.modules.php @@ -61,21 +61,31 @@ class ImportXlsx extends ModeleImports public $label; public $extension; // Extension of files imported by driver - public $version; // Version of driver + + /** + * Dolibarr version of driver + * @public string + */ + public $version = 'dolibarr'; public $label_lib; // Label of external lib used by driver + public $version_lib; // Version of external lib used by driver public $separator; public $file; // Path of file + public $handle; // Handle fichier public $cacheconvert=array(); // Array to cache list of value found after a convertion + public $cachefieldtable=array(); // Array to cache list of value found into fields@tables public $workbook; // temporary import file + public $record; // current record + public $headers; diff --git a/htdocs/core/modules/import/modules_import.php b/htdocs/core/modules/import/modules_import.php index a5d73031b7a..214c04ad857 100644 --- a/htdocs/core/modules/import/modules_import.php +++ b/htdocs/core/modules/import/modules_import.php @@ -37,7 +37,10 @@ class ModeleImports public $datatoimport; - public $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * @var int id of driver @@ -50,17 +53,26 @@ class ModeleImports public $label; public $extension; // Extension of files imported by driver - public $version; // Version of driver + + /** + * Dolibarr version of driver + * @public string + */ + public $version = 'dolibarr'; public $label_lib; // Label of external lib used by driver + public $version_lib; // Version of external lib used by driver // Array of all drivers public $driverlabel=array(); + public $driverdesc=array(); + public $driverversion=array(); public $liblabel=array(); + public $libversion=array(); diff --git a/htdocs/core/modules/livraison/mod_livraison_jade.php b/htdocs/core/modules/livraison/mod_livraison_jade.php index 2bc64bdcb63..1fd598d02a7 100644 --- a/htdocs/core/modules/livraison/mod_livraison_jade.php +++ b/htdocs/core/modules/livraison/mod_livraison_jade.php @@ -34,11 +34,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/livraison/modules_livraison.php'; class mod_livraison_jade extends ModeleNumRefDeliveryOrder { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = "Jade"; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='BL'; + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Jade'; + + /** + * @var string model name + */ + public $name='Jade'; + + public $prefix='BL'; /** diff --git a/htdocs/core/modules/livraison/mod_livraison_saphir.php b/htdocs/core/modules/livraison/mod_livraison_saphir.php index bad82554ff3..cbe105ef75c 100644 --- a/htdocs/core/modules/livraison/mod_livraison_saphir.php +++ b/htdocs/core/modules/livraison/mod_livraison_saphir.php @@ -31,9 +31,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/livraison/modules_livraison.php'; */ class mod_livraison_saphir extends ModeleNumRefDeliveryOrder { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Saphir'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Saphir'; + + /** + * @var string model name + */ + public $name='Saphir'; /** @@ -43,7 +62,7 @@ class mod_livraison_saphir extends ModeleNumRefDeliveryOrder */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/payment/mod_payment_ant.php b/htdocs/core/modules/payment/mod_payment_ant.php index d059f0ccebc..b7d88464355 100644 --- a/htdocs/core/modules/payment/mod_payment_ant.php +++ b/htdocs/core/modules/payment/mod_payment_ant.php @@ -30,9 +30,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/payment/modules_payment.php'; */ class mod_payment_ant extends ModeleNumRefPayments { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Ant'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error message + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Ant'; + + /** + * @var string model name + */ + public $name='Ant'; /** @@ -42,7 +61,7 @@ class mod_payment_ant extends ModeleNumRefPayments */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/payment/mod_payment_cicada.php b/htdocs/core/modules/payment/mod_payment_cicada.php index 5e87f33f8c1..5869032cc5b 100644 --- a/htdocs/core/modules/payment/mod_payment_cicada.php +++ b/htdocs/core/modules/payment/mod_payment_cicada.php @@ -29,13 +29,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/payment/modules_payment.php'; */ class mod_payment_cicada extends ModeleNumRefPayments { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='PAY'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='PAY'; + /** * @var string Error code (or message) */ public $error=''; - var $nom='Cicada'; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Cicada'; + + /** + * @var string model name + */ + public $name='Cicada'; /** diff --git a/htdocs/core/modules/product/doc/doc_generic_product_odt.modules.php b/htdocs/core/modules/product/doc/doc_generic_product_odt.modules.php index b11e17a6623..1ee00f486e5 100644 --- a/htdocs/core/modules/product/doc/doc_generic_product_odt.modules.php +++ b/htdocs/core/modules/product/doc/doc_generic_product_odt.modules.php @@ -42,7 +42,11 @@ class doc_generic_product_odt extends ModelePDFProduct */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document diff --git a/htdocs/core/modules/product/doc/pdf_standard.modules.php b/htdocs/core/modules/product/doc/pdf_standard.modules.php index b163e22c712..8d30448bf2f 100644 --- a/htdocs/core/modules/product/doc/pdf_standard.modules.php +++ b/htdocs/core/modules/product/doc/pdf_standard.modules.php @@ -68,12 +68,39 @@ class pdf_standard extends ModelePDFProduct */ public $version = 'dolibarr'; + /** + * @var int page_largeur + */ public $page_largeur; + + /** + * @var int page_hauteur + */ public $page_hauteur; + + /** + * @var array format + */ public $format; + + /** + * @var int marge_gauche + */ public $marge_gauche; + + /** + * @var int marge_droite + */ public $marge_droite; + + /** + * @var int marge_haute + */ public $marge_haute; + + /** + * @var int marge_basse + */ public $marge_basse; /** diff --git a/htdocs/core/modules/product/mod_codeproduct_elephant.php b/htdocs/core/modules/product/mod_codeproduct_elephant.php index f55595a63d5..f051fab7f8e 100644 --- a/htdocs/core/modules/product/mod_codeproduct_elephant.php +++ b/htdocs/core/modules/product/mod_codeproduct_elephant.php @@ -34,18 +34,39 @@ require_once DOL_DOCUMENT_ROOT.'/core/modules/product/modules_product.class.php' */ class mod_codeproduct_elephant extends ModeleProductCode { - var $nom='Elephant'; // Nom du modele - var $name='Elephant'; // Nom du modele - var $code_modifiable; // Code modifiable - var $code_modifiable_invalide; // Code modifiable si il est invalide - var $code_modifiable_null; // Code modifiables si il est null - var $code_null; // Code facultatif - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $code_auto; // Numerotation automatique + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Elephant'; - var $searchcode; // String de recherche - var $numbitcounter; // Nombre de chiffres du compteur - var $prefixIsRequired; // Le champ prefix du tiers doit etre renseigne quand on utilise {pre} + /** + * @var string model name + */ + public $name='Elephant'; + + public $code_modifiable; // Code modifiable + + public $code_modifiable_invalide; // Code modifiable si il est invalide + + public $code_modifiable_null; // Code modifiables si il est null + + public $code_null; // Code facultatif + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $code_auto; // Numerotation automatique + + public $searchcode; // String de recherche + + public $numbitcounter; // Nombre de chiffres du compteur + + public $prefixIsRequired; // Le champ prefix du tiers doit etre renseigne quand on utilise {pre} /** diff --git a/htdocs/core/modules/product/mod_codeproduct_leopard.php b/htdocs/core/modules/product/mod_codeproduct_leopard.php index 3b850e1ba91..815e383d900 100644 --- a/htdocs/core/modules/product/mod_codeproduct_leopard.php +++ b/htdocs/core/modules/product/mod_codeproduct_leopard.php @@ -39,14 +39,33 @@ class mod_codeproduct_leopard extends ModeleProductCode * Le fonctionnement de celui-ci doit donc rester le plus ouvert possible */ - var $nom='Leopard'; // Nom du modele - var $name='Leopard'; // Nom du modele - var $code_modifiable; // Code modifiable - var $code_modifiable_invalide; // Code modifiable si il est invalide - var $code_modifiable_null; // Code modifiables si il est null - var $code_null; // Code facultatif - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $code_auto; // Numerotation automatique + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Leopard'; + + /** + * @var string model name + */ + public $name='Leopard'; + + public $code_modifiable; // Code modifiable + + public $code_modifiable_invalide; // Code modifiable si il est invalide + + public $code_modifiable_null; // Code modifiables si il est null + + public $code_null; // Code facultatif + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $code_auto; // Numerotation automatique /** diff --git a/htdocs/core/modules/project/doc/doc_generic_project_odt.modules.php b/htdocs/core/modules/project/doc/doc_generic_project_odt.modules.php index ae162095627..a350f643e9e 100644 --- a/htdocs/core/modules/project/doc/doc_generic_project_odt.modules.php +++ b/htdocs/core/modules/project/doc/doc_generic_project_odt.modules.php @@ -53,10 +53,23 @@ if (! empty($conf->agenda->enabled)) require_once DOL_DOCUMENT_ROOT.'/comm/ */ class doc_generic_project_odt extends ModelePDFProjects { - var $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; - var $phpmin = array(5,2,0); // Minimum version of PHP required by module - var $version = 'dolibarr'; + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; /** @@ -66,7 +79,7 @@ class doc_generic_project_odt extends ModelePDFProjects */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Load traductions files requiredby by page $langs->loadLangs(array("companies", "main")); diff --git a/htdocs/core/modules/project/doc/pdf_beluga.modules.php b/htdocs/core/modules/project/doc/pdf_beluga.modules.php index d2a678047ab..fe33d093083 100644 --- a/htdocs/core/modules/project/doc/pdf_beluga.modules.php +++ b/htdocs/core/modules/project/doc/pdf_beluga.modules.php @@ -54,7 +54,11 @@ if (! empty($conf->agenda->enabled)) require_once DOL_DOCUMENT_ROOT.'/com class pdf_beluga extends ModelePDFProjects { - var $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; /** * Constructor diff --git a/htdocs/core/modules/project/doc/pdf_timespent.modules.php b/htdocs/core/modules/project/doc/pdf_timespent.modules.php index 74ba4775447..718e618b16d 100644 --- a/htdocs/core/modules/project/doc/pdf_timespent.modules.php +++ b/htdocs/core/modules/project/doc/pdf_timespent.modules.php @@ -37,7 +37,11 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php'; class pdf_timespent extends ModelePDFProjects { - var $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; /** * Constructor diff --git a/htdocs/core/modules/project/mod_project_simple.php b/htdocs/core/modules/project/mod_project_simple.php index 33fce830397..94f2db957a3 100644 --- a/htdocs/core/modules/project/mod_project_simple.php +++ b/htdocs/core/modules/project/mod_project_simple.php @@ -31,14 +31,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/project/modules_project.php'; */ class mod_project_simple extends ModeleNumRefProjects { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='PJ'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='PJ'; + /** * @var string Error code (or message) */ public $error=''; - var $nom = "Simple"; - var $name = "Simple"; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Simple'; + + /** + * @var string model name + */ + public $name='Simple'; /** diff --git a/htdocs/core/modules/project/mod_project_universal.php b/htdocs/core/modules/project/mod_project_universal.php index a5526d9f033..0d11ac820c0 100644 --- a/htdocs/core/modules/project/mod_project_universal.php +++ b/htdocs/core/modules/project/mod_project_universal.php @@ -30,10 +30,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/project/modules_project.php'; */ class mod_project_universal extends ModeleNumRefProjects { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Universal'; - var $name = 'Universal'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Universal'; + + /** + * @var string model name + */ + public $name='Universal'; /** @@ -43,7 +61,7 @@ class mod_project_universal extends ModeleNumRefProjects */ function info() { - global $conf,$langs; + global $conf, $langs; // Load translation files required by the page $langs->loadLangs(array("projects","admin")); diff --git a/htdocs/core/modules/project/task/doc/doc_generic_task_odt.modules.php b/htdocs/core/modules/project/task/doc/doc_generic_task_odt.modules.php index c881c6c5b46..d76ae3b586a 100644 --- a/htdocs/core/modules/project/task/doc/doc_generic_task_odt.modules.php +++ b/htdocs/core/modules/project/task/doc/doc_generic_task_odt.modules.php @@ -60,7 +60,11 @@ class doc_generic_task_odt extends ModelePDFTask */ public $emetteur; // Objet societe qui emet - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document @@ -76,7 +80,7 @@ class doc_generic_task_odt extends ModelePDFTask */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Load translation files required by the page $langs->loadLangs(array("main","companies")); diff --git a/htdocs/core/modules/project/task/mod_task_simple.php b/htdocs/core/modules/project/task/mod_task_simple.php index 76cade72785..48e9cfe557e 100644 --- a/htdocs/core/modules/project/task/mod_task_simple.php +++ b/htdocs/core/modules/project/task/mod_task_simple.php @@ -31,14 +31,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/project/task/modules_task.php'; */ class mod_task_simple extends ModeleNumRefTask { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='TK'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='TK'; + /** * @var string Error code (or message) */ public $error=''; - var $nom = "Simple"; - var $name = "Simple"; + + /** + * @var string + * @deprecated + * @see name + */ + public $nom='Simple'; + + /** + * @var string name + */ + public $name='Simple'; /** diff --git a/htdocs/core/modules/project/task/mod_task_universal.php b/htdocs/core/modules/project/task/mod_task_universal.php index 5fcb39c9b83..6f46f914b07 100644 --- a/htdocs/core/modules/project/task/mod_task_universal.php +++ b/htdocs/core/modules/project/task/mod_task_universal.php @@ -30,10 +30,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/project/task/modules_task.php'; */ class mod_task_universal extends ModeleNumRefTask { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Universal'; - var $name = 'Universal'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string + * @deprecated + * @see name + */ + public $nom='Universal'; + + /** + * @var string name + */ + public $name='Universal'; /** diff --git a/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php b/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php index 469d154ddc5..6b5bf3fe3a2 100644 --- a/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php +++ b/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php @@ -43,7 +43,11 @@ class doc_generic_proposal_odt extends ModelePDFPropales */ public $emetteur; // Objet societe qui emet - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document @@ -59,7 +63,7 @@ class doc_generic_proposal_odt extends ModelePDFPropales */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Load translation files required by the page $langs->loadLangs(array("main","companies")); diff --git a/htdocs/core/modules/propale/mod_propale_marbre.php b/htdocs/core/modules/propale/mod_propale_marbre.php index fe63b28f843..427d4596636 100644 --- a/htdocs/core/modules/propale/mod_propale_marbre.php +++ b/htdocs/core/modules/propale/mod_propale_marbre.php @@ -31,13 +31,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/propale/modules_propale.php'; */ class mod_propale_marbre extends ModeleNumRefPropales { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='PR'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='PR'; + /** * @var string Error code (or message) */ public $error=''; - var $nom = "Marbre"; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Marbre'; + + /** + * @var string model name + */ + public $name='Marbre'; /** diff --git a/htdocs/core/modules/propale/mod_propale_saphir.php b/htdocs/core/modules/propale/mod_propale_saphir.php index 52dba1beac5..913743eb93d 100644 --- a/htdocs/core/modules/propale/mod_propale_saphir.php +++ b/htdocs/core/modules/propale/mod_propale_saphir.php @@ -33,9 +33,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/propale/modules_propale.php'; */ class mod_propale_saphir extends ModeleNumRefPropales { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Saphir'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Saphir'; + + /** + * @var string model name + */ + public $name='Saphir'; /** @@ -45,7 +64,7 @@ class mod_propale_saphir extends ModeleNumRefPropales */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/societe/doc/doc_generic_odt.modules.php b/htdocs/core/modules/societe/doc/doc_generic_odt.modules.php index fcbf379ccd5..fbd4ac84e05 100644 --- a/htdocs/core/modules/societe/doc/doc_generic_odt.modules.php +++ b/htdocs/core/modules/societe/doc/doc_generic_odt.modules.php @@ -34,9 +34,17 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/doc.lib.php'; */ class doc_generic_odt extends ModeleThirdPartyDoc { - var $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; - var $phpmin = array(5,2,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** @@ -46,7 +54,7 @@ class doc_generic_odt extends ModeleThirdPartyDoc */ function __construct($db) { - global $conf,$langs,$mysoc; + global $conf, $langs, $mysoc; // Load translation files required by the page $langs->loadLangs(array("main","companies")); diff --git a/htdocs/core/modules/societe/mod_codeclient_elephant.php b/htdocs/core/modules/societe/mod_codeclient_elephant.php index 5aba06db359..621bbd08d3e 100644 --- a/htdocs/core/modules/societe/mod_codeclient_elephant.php +++ b/htdocs/core/modules/societe/mod_codeclient_elephant.php @@ -3,7 +3,7 @@ * Copyright (C) 2006-2009 Laurent Destailleur * Copyright (C) 2007-2012 Regis Houssin * Copyright (C) 2011 Juanjo Menent - * Copyright (C) 2013 Philippe Grand + * Copyright (C) 2013-2018 Philippe Grand * * 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 @@ -34,18 +34,39 @@ require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php' */ class mod_codeclient_elephant extends ModeleThirdPartyCode { - var $nom='Elephant'; // Nom du modele - var $name='Elephant'; // Nom du modele - var $code_modifiable; // Code modifiable - var $code_modifiable_invalide; // Code modifiable si il est invalide - var $code_modifiable_null; // Code modifiables si il est null - var $code_null; // Code facultatif - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $code_auto; // Numerotation automatique + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Elephant'; - var $searchcode; // String de recherche - var $numbitcounter; // Nombre de chiffres du compteur - var $prefixIsRequired; // Le champ prefix du tiers doit etre renseigne quand on utilise {pre} + /** + * @var string model name + */ + public $name='Elephant'; + + public $code_modifiable; // Code modifiable + + public $code_modifiable_invalide; // Code modifiable si il est invalide + + public $code_modifiable_null; // Code modifiables si il est null + + public $code_null; // Code facultatif + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $code_auto; // Numerotation automatique + + public $searchcode; // String de recherche + + public $numbitcounter; // Nombre de chiffres du compteur + + public $prefixIsRequired; // Le champ prefix du tiers doit etre renseigne quand on utilise {pre} /** diff --git a/htdocs/core/modules/societe/mod_codeclient_leopard.php b/htdocs/core/modules/societe/mod_codeclient_leopard.php index 94c9c04d2e2..9bdd27d5bee 100644 --- a/htdocs/core/modules/societe/mod_codeclient_leopard.php +++ b/htdocs/core/modules/societe/mod_codeclient_leopard.php @@ -38,14 +38,33 @@ class mod_codeclient_leopard extends ModeleThirdPartyCode * Le fonctionnement de celui-ci doit donc rester le plus ouvert possible */ - var $nom='Leopard'; // Nom du modele - var $name='Leopard'; // Nom du modele - var $code_modifiable; // Code modifiable - var $code_modifiable_invalide; // Code modifiable si il est invalide - var $code_modifiable_null; // Code modifiables si il est null - var $code_null; // Code facultatif - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $code_auto; // Numerotation automatique + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Leopard'; + + /** + * @var string model name + */ + public $name='Leopard'; + + public $code_modifiable; // Code modifiable + + public $code_modifiable_invalide; // Code modifiable si il est invalide + + public $code_modifiable_null; // Code modifiables si il est null + + public $code_null; // Code facultatif + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $code_auto; // Numerotation automatique /** diff --git a/htdocs/core/modules/societe/mod_codeclient_monkey.php b/htdocs/core/modules/societe/mod_codeclient_monkey.php index eb7fb0184f4..d914f6953ae 100644 --- a/htdocs/core/modules/societe/mod_codeclient_monkey.php +++ b/htdocs/core/modules/societe/mod_codeclient_monkey.php @@ -32,18 +32,39 @@ require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php' */ class mod_codeclient_monkey extends ModeleThirdPartyCode { - var $nom='Monkey'; // Nom du modele - var $name='Monkey'; // Nom du modele - var $code_modifiable; // Code modifiable - var $code_modifiable_invalide; // Code modifiable si il est invalide - var $code_modifiable_null; // Code modifiables si il est null - var $code_null; // Code facultatif - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $code_auto; // Numerotation automatique + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Monkey'; - var $prefixcustomer='CU'; - var $prefixsupplier='SU'; - var $prefixIsRequired; // Le champ prefix du tiers doit etre renseigne quand on utilise {pre} + /** + * @var string model name + */ + public $name='Monkey'; + + public $code_modifiable; // Code modifiable + + public $code_modifiable_invalide; // Code modifiable si il est invalide + + public $code_modifiable_null; // Code modifiables si il est null + + public $code_null; // Code facultatif + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $code_auto; // Numerotation automatique + + public $prefixcustomer='CU'; + + public $prefixsupplier='SU'; + + public $prefixIsRequired; // Le champ prefix du tiers doit etre renseigne quand on utilise {pre} /** diff --git a/htdocs/core/modules/societe/mod_codecompta_aquarium.php b/htdocs/core/modules/societe/mod_codecompta_aquarium.php index f6a2a08bee7..772b28f3d6c 100644 --- a/htdocs/core/modules/societe/mod_codecompta_aquarium.php +++ b/htdocs/core/modules/societe/mod_codecompta_aquarium.php @@ -31,12 +31,27 @@ require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php' */ class mod_codecompta_aquarium extends ModeleAccountancyCode { - var $nom='Aquarium'; - var $name='Aquarium'; - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Aquarium'; - var $prefixcustomeraccountancycode; - var $prefixsupplieraccountancycode; + /** + * @var string model name + */ + public $name='Aquarium'; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefixcustomeraccountancycode; + + public $prefixsupplieraccountancycode; /** diff --git a/htdocs/core/modules/societe/mod_codecompta_panicum.php b/htdocs/core/modules/societe/mod_codecompta_panicum.php index 2dd6a81de02..c1e83b75db4 100644 --- a/htdocs/core/modules/societe/mod_codecompta_panicum.php +++ b/htdocs/core/modules/societe/mod_codecompta_panicum.php @@ -30,9 +30,23 @@ require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php' */ class mod_codecompta_panicum extends ModeleAccountancyCode { - var $nom='Panicum'; - var $name='Panicum'; - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Panicum'; + + /** + * @var string model name + */ + public $name='Panicum'; + + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' /** diff --git a/htdocs/core/modules/stock/doc/doc_generic_stock_odt.modules.php b/htdocs/core/modules/stock/doc/doc_generic_stock_odt.modules.php index 4f9de22f975..fb600eee268 100644 --- a/htdocs/core/modules/stock/doc/doc_generic_stock_odt.modules.php +++ b/htdocs/core/modules/stock/doc/doc_generic_stock_odt.modules.php @@ -42,7 +42,11 @@ class doc_generic_stock_odt extends ModelePDFStock */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document diff --git a/htdocs/core/modules/stock/doc/pdf_standard.modules.php b/htdocs/core/modules/stock/doc/pdf_standard.modules.php index 957a4fc2e32..ce01124211a 100644 --- a/htdocs/core/modules/stock/doc/pdf_standard.modules.php +++ b/htdocs/core/modules/stock/doc/pdf_standard.modules.php @@ -68,12 +68,39 @@ class pdf_standard extends ModelePDFStock */ public $version = 'dolibarr'; + /** + * @var int page_largeur + */ public $page_largeur; + + /** + * @var int page_hauteur + */ public $page_hauteur; + + /** + * @var array format + */ public $format; + + /** + * @var int marge_gauche + */ public $marge_gauche; + + /** + * @var int marge_droite + */ public $marge_droite; + + /** + * @var int marge_haute + */ public $marge_haute; + + /** + * @var int marge_basse + */ public $marge_basse; /** diff --git a/htdocs/core/modules/stock/doc/pdf_stdmovement.modules.php b/htdocs/core/modules/stock/doc/pdf_stdmovement.modules.php index 0c9c55b5e7f..2fd86069d01 100644 --- a/htdocs/core/modules/stock/doc/pdf_stdmovement.modules.php +++ b/htdocs/core/modules/stock/doc/pdf_stdmovement.modules.php @@ -69,12 +69,39 @@ class pdf_stdmovement extends ModelePDFMovement */ public $version = 'dolibarr'; + /** + * @var int page_largeur + */ public $page_largeur; + + /** + * @var int page_hauteur + */ public $page_hauteur; + + /** + * @var array format + */ public $format; + + /** + * @var int marge_gauche + */ public $marge_gauche; + + /** + * @var int marge_droite + */ public $marge_droite; + + /** + * @var int marge_haute + */ public $marge_haute; + + /** + * @var int marge_basse + */ public $marge_basse; /** diff --git a/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php b/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php index 2eaa85261d0..28474f094f1 100644 --- a/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php +++ b/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_cactus.php @@ -1,7 +1,7 @@ * Copyright (C) 2005-2009 Regis Houssin - * Copyright (C) 2013 Philippe Grand + * Copyright (C) 2013-2018 Philippe Grand * Copyright (C) 2016 Alexandre Spangaro * * This program is free software; you can redistribute it and/or modify @@ -33,12 +33,34 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_invoice/modules_facturef */ class mod_facture_fournisseur_cactus extends ModeleNumRefSuppliersInvoices { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Cactus'; - var $prefixinvoice='SI'; - var $prefixcreditnote='SA'; - var $prefixdeposit='SD'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Cactus'; + + /** + * @var string model name + */ + public $name='Cactus'; + + public $prefixinvoice='SI'; + + public $prefixcreditnote='SA'; + + public $prefixdeposit='SD'; /** diff --git a/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_tulip.php b/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_tulip.php index 9f4a5b6bbe7..6079006d315 100644 --- a/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_tulip.php +++ b/htdocs/core/modules/supplier_invoice/mod_facture_fournisseur_tulip.php @@ -36,9 +36,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_invoice/modules_facturef */ class mod_facture_fournisseur_tulip extends ModeleNumRefSuppliersInvoices { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Tulip'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Tulip'; + + /** + * @var string model name + */ + public $name='Tulip'; /** @@ -48,7 +67,7 @@ class mod_facture_fournisseur_tulip extends ModeleNumRefSuppliersInvoices */ function info() { - global $conf,$langs; + global $conf, $langs; // Load translation files required by the page $langs->loadLangs(array("bills","admin")); diff --git a/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php b/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php index 60612e90259..8448c61f62b 100644 --- a/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php +++ b/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php @@ -31,10 +31,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_order/modules_commandefo */ class mod_commande_fournisseur_muguet extends ModeleNumRefSuppliersOrders { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Muguet'; - var $prefix='CF'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Muguet'; + + /** + * @var string model name + */ + public $name='Muguet'; + + public $prefix='CF'; /** diff --git a/htdocs/core/modules/supplier_order/mod_commande_fournisseur_orchidee.php b/htdocs/core/modules/supplier_order/mod_commande_fournisseur_orchidee.php index fb800d1d63d..1645ce796b2 100644 --- a/htdocs/core/modules/supplier_order/mod_commande_fournisseur_orchidee.php +++ b/htdocs/core/modules/supplier_order/mod_commande_fournisseur_orchidee.php @@ -32,9 +32,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_order/modules_commandefo */ class mod_commande_fournisseur_orchidee extends ModeleNumRefSuppliersOrders { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Orchidee'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Orchidee'; + + /** + * @var string model name + */ + public $name='Orchidee'; /** @@ -44,7 +63,7 @@ class mod_commande_fournisseur_orchidee extends ModeleNumRefSuppliersOrders */ function info() { - global $conf,$langs; + global $conf, $langs; // Load translation files required by the page $langs->loadLangs(array("bills","admin")); diff --git a/htdocs/core/modules/supplier_payment/mod_supplier_payment_brodator.php b/htdocs/core/modules/supplier_payment/mod_supplier_payment_brodator.php index af69210945e..216bc4bde90 100644 --- a/htdocs/core/modules/supplier_payment/mod_supplier_payment_brodator.php +++ b/htdocs/core/modules/supplier_payment/mod_supplier_payment_brodator.php @@ -30,9 +30,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_payment/modules_supplier */ class mod_supplier_payment_brodator extends ModeleNumRefSupplierPayments { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Brodator'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Brodator'; + + /** + * @var string model name + */ + public $name='Brodator'; /** @@ -42,7 +61,7 @@ class mod_supplier_payment_brodator extends ModeleNumRefSupplierPayments */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/supplier_payment/mod_supplier_payment_bronan.php b/htdocs/core/modules/supplier_payment/mod_supplier_payment_bronan.php index 3126e3df13c..0d64991065a 100644 --- a/htdocs/core/modules/supplier_payment/mod_supplier_payment_bronan.php +++ b/htdocs/core/modules/supplier_payment/mod_supplier_payment_bronan.php @@ -29,13 +29,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_payment/modules_supplier */ class mod_supplier_payment_bronan extends ModeleNumRefSupplierPayments { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='SPAY'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='SPAY'; + /** * @var string Error code (or message) */ public $error=''; - var $nom='Bronan'; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Bronan'; + + /** + * @var string model name + */ + public $name='Bronan'; /** diff --git a/htdocs/core/modules/supplier_proposal/doc/doc_generic_supplier_proposal_odt.modules.php b/htdocs/core/modules/supplier_proposal/doc/doc_generic_supplier_proposal_odt.modules.php index a259fbbe7ee..f483738ecb7 100644 --- a/htdocs/core/modules/supplier_proposal/doc/doc_generic_supplier_proposal_odt.modules.php +++ b/htdocs/core/modules/supplier_proposal/doc/doc_generic_supplier_proposal_odt.modules.php @@ -43,7 +43,11 @@ class doc_generic_supplier_proposal_odt extends ModelePDFSupplierProposal */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document diff --git a/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_marbre.php b/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_marbre.php index b821805f1f9..e7fb65f7612 100644 --- a/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_marbre.php +++ b/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_marbre.php @@ -31,13 +31,30 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_proposal/modules_supplie */ class mod_supplier_proposal_marbre extends ModeleNumRefSupplierProposal { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $prefix='RQ'; // RQ = Request for quotation + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + public $prefix='RQ'; // RQ = Request for quotation + /** * @var string Error code (or message) */ public $error=''; - var $nom = "Marbre"; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Marbre'; + + /** + * @var string model name + */ + public $name='Marbre'; /** diff --git a/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_saphir.php b/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_saphir.php index 1a5995b8fc9..4827acdc9c8 100644 --- a/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_saphir.php +++ b/htdocs/core/modules/supplier_proposal/mod_supplier_proposal_saphir.php @@ -33,9 +33,28 @@ require_once DOL_DOCUMENT_ROOT .'/core/modules/supplier_proposal/modules_supplie */ class mod_supplier_proposal_saphir extends ModeleNumRefSupplierProposal { - var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error = ''; - var $nom = 'Saphir'; + /** + * Dolibarr version of the loaded document + * @public string + */ + public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' + + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Saphir'; + + /** + * @var string model name + */ + public $name='Saphir'; /** @@ -45,7 +64,7 @@ class mod_supplier_proposal_saphir extends ModeleNumRefSupplierProposal */ function info() { - global $conf,$langs; + global $conf, $langs; $langs->load("bills"); diff --git a/htdocs/core/modules/ticket/mod_ticket_simple.php b/htdocs/core/modules/ticket/mod_ticket_simple.php index a2201208534..c744453a899 100644 --- a/htdocs/core/modules/ticket/mod_ticket_simple.php +++ b/htdocs/core/modules/ticket/mod_ticket_simple.php @@ -1,6 +1,6 @@ - * Copyright (C) 2010 Laurent Destailleur +/* Copyright (C) 2010-2012 Regis Houssin + * Copyright (C) 2010 Laurent Destailleur * * 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 @@ -37,9 +37,23 @@ class mod_ticket_simple extends ModeleNumRefTicket public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' public $prefix = 'TS'; + + /** + * @var string Error code (or message) + */ public $error = ''; - public $nom = "Simple"; - public $name = "Simple"; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Simple'; + + /** + * @var string model name + */ + public $name='Simple'; /** * Return description of numbering module diff --git a/htdocs/core/modules/ticket/mod_ticket_universal.php b/htdocs/core/modules/ticket/mod_ticket_universal.php index ee201740eed..b6dd2a2873b 100644 --- a/htdocs/core/modules/ticket/mod_ticket_universal.php +++ b/htdocs/core/modules/ticket/mod_ticket_universal.php @@ -35,9 +35,22 @@ class mod_ticket_universal extends ModeleNumRefTicket */ public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr' - public $error = ''; - public $nom = 'Universal'; - public $name = 'Universal'; + /** + * @var string Error code (or message) + */ + public $error = ''; + + /** + * @var string Nom du modele + * @deprecated + * @see name + */ + public $nom='Universal'; + + /** + * @var string model name + */ + public $name='Universal'; /** * Renvoi la description du modele de numerotation diff --git a/htdocs/core/modules/ticket/modules_ticket.php b/htdocs/core/modules/ticket/modules_ticket.php index d6f8b06d0e8..28587825d34 100644 --- a/htdocs/core/modules/ticket/modules_ticket.php +++ b/htdocs/core/modules/ticket/modules_ticket.php @@ -29,6 +29,9 @@ */ abstract class ModeleNumRefTicket { + /** + * @var string Error code (or message) + */ public $error = ''; /** diff --git a/htdocs/core/modules/user/doc/doc_generic_user_odt.modules.php b/htdocs/core/modules/user/doc/doc_generic_user_odt.modules.php index 41fb48ecec5..bce2aca823a 100644 --- a/htdocs/core/modules/user/doc/doc_generic_user_odt.modules.php +++ b/htdocs/core/modules/user/doc/doc_generic_user_odt.modules.php @@ -41,7 +41,11 @@ class doc_generic_user_odt extends ModelePDFUser */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document diff --git a/htdocs/core/modules/usergroup/doc/doc_generic_usergroup_odt.modules.php b/htdocs/core/modules/usergroup/doc/doc_generic_usergroup_odt.modules.php index 571a12aaf7b..798231ed688 100644 --- a/htdocs/core/modules/usergroup/doc/doc_generic_usergroup_odt.modules.php +++ b/htdocs/core/modules/usergroup/doc/doc_generic_usergroup_odt.modules.php @@ -43,7 +43,11 @@ class doc_generic_usergroup_odt extends ModelePDFUserGroup */ public $emetteur; - public $phpmin = array(5,4,0); // Minimum version of PHP required by module + /** + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) + */ + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document diff --git a/htdocs/core/triggers/interface_20_all_Logevents.class.php b/htdocs/core/triggers/interface_20_all_Logevents.class.php index a8de26e713b..772e9b39a51 100644 --- a/htdocs/core/triggers/interface_20_all_Logevents.class.php +++ b/htdocs/core/triggers/interface_20_all_Logevents.class.php @@ -37,7 +37,13 @@ class InterfaceLogevents extends DolibarrTriggers public $picto = 'technic'; public $family = 'core'; + public $description = "Triggers of this module allows to add security event records inside Dolibarr."; + + /** + * Version of the trigger + * @var string + */ public $version = self::VERSION_DOLIBARR; /** diff --git a/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php b/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php index a719ef0b4fc..90806746da8 100644 --- a/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php +++ b/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php @@ -39,6 +39,11 @@ class InterfaceWorkflowManager extends DolibarrTriggers public $family = 'core'; public $description = "Triggers of this module allows to manage workflows"; + + /** + * Version of the trigger + * @var string + */ public $version = self::VERSION_DOLIBARR; /** diff --git a/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php b/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php index 343b9a1376e..ff24f358083 100644 --- a/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php +++ b/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php @@ -36,6 +36,11 @@ class InterfaceActionsAuto extends DolibarrTriggers { public $family = 'agenda'; public $description = "Triggers of this module add actions in agenda according to setup made in agenda setup."; + + /** + * Version of the trigger + * @var string + */ public $version = self::VERSION_DOLIBARR; /** diff --git a/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php b/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php index 82e6b9e56eb..f2c19394df9 100644 --- a/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php +++ b/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php @@ -32,6 +32,11 @@ class InterfaceActionsBlockedLog extends DolibarrTriggers { public $family = 'system'; public $description = "Triggers of this module add action for BlockedLog module."; + + /** + * Version of the trigger + * @var string + */ public $version = self::VERSION_DOLIBARR; /** diff --git a/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php b/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php index 376ed47c486..7d528b55c30 100644 --- a/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php +++ b/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php @@ -33,6 +33,11 @@ class InterfaceLdapsynchro extends DolibarrTriggers { public $family = 'ldap'; public $description = "Triggers of this module allows to synchronize Dolibarr toward a LDAP database."; + + /** + * Version of the trigger + * @var string + */ public $version = self::VERSION_DOLIBARR; /** diff --git a/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php b/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php index e551086f9e8..0197e6bf280 100644 --- a/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php +++ b/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php @@ -31,6 +31,11 @@ class InterfaceMailmanSpipsynchro extends DolibarrTriggers { public $family = 'mailmanspip'; public $description = "Triggers of this module allows to synchronize Mailman an Spip."; + + /** + * Version of the trigger + * @var string + */ public $version = self::VERSION_DOLIBARR; /** diff --git a/htdocs/core/triggers/interface_50_modNotification_Notification.class.php b/htdocs/core/triggers/interface_50_modNotification_Notification.class.php index 0daf141a208..26b36964676 100644 --- a/htdocs/core/triggers/interface_50_modNotification_Notification.class.php +++ b/htdocs/core/triggers/interface_50_modNotification_Notification.class.php @@ -32,6 +32,11 @@ class InterfaceNotification extends DolibarrTriggers { public $family = 'notification'; public $description = "Triggers of this module send email notifications according to Notification module setup."; + + /** + * Version of the trigger + * @var string + */ public $version = self::VERSION_DOLIBARR; /** diff --git a/htdocs/modulebuilder/template/class/actions_mymodule.class.php b/htdocs/modulebuilder/template/class/actions_mymodule.class.php index 45008aa76f3..7d85d804d25 100644 --- a/htdocs/modulebuilder/template/class/actions_mymodule.class.php +++ b/htdocs/modulebuilder/template/class/actions_mymodule.class.php @@ -32,10 +32,12 @@ class ActionsMyModule * @var DoliDB Database handler. */ public $db; + /** - * @var string Error + * @var string Error code (or message) */ public $error = ''; + /** * @var array Errors */ diff --git a/htdocs/societe/class/societe.class.php b/htdocs/societe/class/societe.class.php index 70d4e4801c2..f2b80b586c6 100644 --- a/htdocs/societe/class/societe.class.php +++ b/htdocs/societe/class/societe.class.php @@ -107,6 +107,11 @@ class Societe extends CommonObject */ public $nom; + /** + * @var string name + */ + public $name; + /** * Alias names (commercial, trademark or alias names) * @var string diff --git a/htdocs/user/class/usergroup.class.php b/htdocs/user/class/usergroup.class.php index 78ef5b7a390..e3ada6efcac 100644 --- a/htdocs/user/class/usergroup.class.php +++ b/htdocs/user/class/usergroup.class.php @@ -1,11 +1,11 @@ - * Copyright (c) 2005-2018 Laurent Destailleur - * Copyright (c) 2005-2018 Regis Houssin - * Copyright (C) 2012 Florian Henry - * Copyright (C) 2014 Juanjo Menent - * Copyright (C) 2014 Alexis Algoud - * Copyright (C) 2018 Nicolas ZABOURI +/* Copyright (c) 2005 Rodolphe Quiedeville + * Copyright (c) 2005-2018 Laurent Destailleur + * Copyright (c) 2005-2018 Regis Houssin + * Copyright (C) 2012 Florian Henry + * Copyright (C) 2014 Juanjo Menent + * Copyright (C) 2014 Alexis Algoud + * Copyright (C) 2018 Nicolas ZABOURI * * 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 @@ -46,6 +46,7 @@ class UserGroup extends CommonObject public $table_element='usergroup'; public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe + public $picto='group'; /** @@ -53,16 +54,26 @@ class UserGroup extends CommonObject */ public $entity; - public $name; // Name of group /** + * @var string * @deprecated * @see name */ - public $nom; // Name of group + public $nom; + + /** + * @var string name + */ + public $name; // Name of group + public $globalgroup; // Global group + public $datec; // Creation date of group + public $datem; // Modification date of group + public $note; // Description + public $members=array(); // Array of users public $nb_rights; // Number of rights granted to the user