From 78e9e05f955e6ff2427a42d331b9384fcb802f1f Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Fri, 17 Aug 2018 18:35:51 +0200 Subject: [PATCH] Update and standardize code --- htdocs/core/modules/action/modules_action.php | 5 ++++- htdocs/core/modules/bank/modules_bank.php | 5 ++++- htdocs/core/modules/barcode/doc/phpbarcode.modules.php | 6 +++++- .../core/modules/barcode/doc/tcpdfbarcode.modules.php | 7 ++++++- htdocs/core/modules/barcode/modules_barcode.class.php | 10 ++++++++-- htdocs/core/modules/cheque/mod_chequereceipt_mint.php | 5 ++++- htdocs/core/modules/cheque/modules_chequereceipts.php | 10 ++++++++-- htdocs/core/modules/commande/mod_commande_marbre.php | 5 ++++- htdocs/core/modules/commande/modules_commande.php | 10 ++++++++-- htdocs/core/modules/contract/mod_contract_serpis.php | 5 ++++- htdocs/core/modules/contract/modules_contract.php | 10 ++++++++-- htdocs/core/modules/dons/modules_don.php | 10 ++++++++-- .../core/modules/expedition/mod_expedition_safor.php | 5 ++++- htdocs/core/modules/expedition/modules_expedition.php | 10 ++++++++-- .../modules/expensereport/mod_expensereport_jade.php | 5 ++++- .../modules/expensereport/modules_expensereport.php | 10 ++++++++-- 16 files changed, 95 insertions(+), 23 deletions(-) diff --git a/htdocs/core/modules/action/modules_action.php b/htdocs/core/modules/action/modules_action.php index 2971b6f59ee..d4c55ce6bdc 100644 --- a/htdocs/core/modules/action/modules_action.php +++ b/htdocs/core/modules/action/modules_action.php @@ -28,7 +28,10 @@ require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php'; */ abstract class ModeleAction extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return list of active generation modules diff --git a/htdocs/core/modules/bank/modules_bank.php b/htdocs/core/modules/bank/modules_bank.php index b0a121d7dc5..703f61cda10 100644 --- a/htdocs/core/modules/bank/modules_bank.php +++ b/htdocs/core/modules/bank/modules_bank.php @@ -31,7 +31,10 @@ require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php'; */ abstract class ModeleBankAccountDoc extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** diff --git a/htdocs/core/modules/barcode/doc/phpbarcode.modules.php b/htdocs/core/modules/barcode/doc/phpbarcode.modules.php index d04c6a70c04..86c292ee80d 100644 --- a/htdocs/core/modules/barcode/doc/phpbarcode.modules.php +++ b/htdocs/core/modules/barcode/doc/phpbarcode.modules.php @@ -33,7 +33,11 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/barcode.lib.php'; // This is to inc class modPhpbarcode extends ModeleBarCode { var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error=''; + + /** + * @var string Error code (or message) + */ + public $error=''; /** diff --git a/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php b/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php index 5b9422b15e7..741c247579d 100644 --- a/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php +++ b/htdocs/core/modules/barcode/doc/tcpdfbarcode.modules.php @@ -32,7 +32,12 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/barcode.lib.php'; // This is to inc class modTcpdfbarcode extends ModeleBarCode { var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' - var $error=''; + + /** + * @var string Error code (or message) + */ + public $error=''; + var $is2d = false; /** diff --git a/htdocs/core/modules/barcode/modules_barcode.class.php b/htdocs/core/modules/barcode/modules_barcode.class.php index 4720ffb1341..279a5f0abf8 100644 --- a/htdocs/core/modules/barcode/modules_barcode.class.php +++ b/htdocs/core/modules/barcode/modules_barcode.class.php @@ -29,7 +29,10 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; */ abstract class ModeleBarCode { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** @@ -50,7 +53,10 @@ abstract class ModeleBarCode */ abstract class ModeleNumRefBarCode { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** Return default description of numbering model * diff --git a/htdocs/core/modules/cheque/mod_chequereceipt_mint.php b/htdocs/core/modules/cheque/mod_chequereceipt_mint.php index 680357ce9bb..8906bdcc14f 100644 --- a/htdocs/core/modules/cheque/mod_chequereceipt_mint.php +++ b/htdocs/core/modules/cheque/mod_chequereceipt_mint.php @@ -31,7 +31,10 @@ class mod_chequereceipt_mint extends ModeleNumRefChequeReceipts { var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' var $prefix='CHK'; - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; var $name='Mint'; diff --git a/htdocs/core/modules/cheque/modules_chequereceipts.php b/htdocs/core/modules/cheque/modules_chequereceipts.php index bbf20761f5f..6d9e359c859 100644 --- a/htdocs/core/modules/cheque/modules_chequereceipts.php +++ b/htdocs/core/modules/cheque/modules_chequereceipts.php @@ -36,7 +36,10 @@ require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php'; // Requ */ abstract class ModeleNumRefChequeReceipts { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return if a module can be used or not @@ -119,7 +122,10 @@ abstract class ModeleNumRefChequeReceipts */ abstract class ModeleChequeReceipts extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return list of active generation modules diff --git a/htdocs/core/modules/commande/mod_commande_marbre.php b/htdocs/core/modules/commande/mod_commande_marbre.php index 9941811006b..69c25f73d68 100644 --- a/htdocs/core/modules/commande/mod_commande_marbre.php +++ b/htdocs/core/modules/commande/mod_commande_marbre.php @@ -31,7 +31,10 @@ class mod_commande_marbre extends ModeleNumRefCommandes { var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' var $prefix='CO'; - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; var $nom='Marbre'; diff --git a/htdocs/core/modules/commande/modules_commande.php b/htdocs/core/modules/commande/modules_commande.php index aa6da728f56..1e58104c9ca 100644 --- a/htdocs/core/modules/commande/modules_commande.php +++ b/htdocs/core/modules/commande/modules_commande.php @@ -39,7 +39,10 @@ require_once DOL_DOCUMENT_ROOT.'/core/class/discount.class.php'; */ abstract class ModelePDFCommandes extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return list of active generation modules @@ -71,7 +74,10 @@ abstract class ModelePDFCommandes extends CommonDocGenerator abstract class ModeleNumRefCommandes { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return if a module can be used or not diff --git a/htdocs/core/modules/contract/mod_contract_serpis.php b/htdocs/core/modules/contract/mod_contract_serpis.php index 5dcb8a72baa..1f85e4d57fc 100644 --- a/htdocs/core/modules/contract/mod_contract_serpis.php +++ b/htdocs/core/modules/contract/mod_contract_serpis.php @@ -30,7 +30,10 @@ class mod_contract_serpis extends ModelNumRefContracts { var $version='dolibarr'; var $prefix='CT'; - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; var $nom='Serpis'; var $code_auto=1; diff --git a/htdocs/core/modules/contract/modules_contract.php b/htdocs/core/modules/contract/modules_contract.php index 47a882b7b56..f0af2e7f78a 100644 --- a/htdocs/core/modules/contract/modules_contract.php +++ b/htdocs/core/modules/contract/modules_contract.php @@ -37,7 +37,10 @@ */ abstract class ModelePDFContract extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** @@ -67,7 +70,10 @@ abstract class ModelePDFContract extends CommonDocGenerator */ class ModelNumRefContracts { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return if a module can be used or not diff --git a/htdocs/core/modules/dons/modules_don.php b/htdocs/core/modules/dons/modules_don.php index 4949cce94e1..f2cba175a60 100644 --- a/htdocs/core/modules/dons/modules_don.php +++ b/htdocs/core/modules/dons/modules_don.php @@ -34,7 +34,10 @@ require_once DOL_DOCUMENT_ROOT.'/don/class/don.class.php'; */ abstract class ModeleDon extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return list of active generation modules @@ -63,7 +66,10 @@ abstract class ModeleDon extends CommonDocGenerator */ abstract class ModeleNumRefDons { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return if a module can be used or not diff --git a/htdocs/core/modules/expedition/mod_expedition_safor.php b/htdocs/core/modules/expedition/mod_expedition_safor.php index 826ba6665c4..e9e0adc7e39 100644 --- a/htdocs/core/modules/expedition/mod_expedition_safor.php +++ b/htdocs/core/modules/expedition/mod_expedition_safor.php @@ -30,7 +30,10 @@ class mod_expedition_safor extends ModelNumRefExpedition { var $version='dolibarr'; var $prefix='SH'; - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; var $nom='Safor'; diff --git a/htdocs/core/modules/expedition/modules_expedition.php b/htdocs/core/modules/expedition/modules_expedition.php index f46fa33c5f1..0fc12428d62 100644 --- a/htdocs/core/modules/expedition/modules_expedition.php +++ b/htdocs/core/modules/expedition/modules_expedition.php @@ -36,7 +36,10 @@ */ abstract class ModelePdfExpedition extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** @@ -66,7 +69,10 @@ abstract class ModelePdfExpedition extends CommonDocGenerator */ abstract class ModelNumRefExpedition { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** Return if a model can be used or not * diff --git a/htdocs/core/modules/expensereport/mod_expensereport_jade.php b/htdocs/core/modules/expensereport/mod_expensereport_jade.php index c6153d422eb..b1e01d40bb9 100644 --- a/htdocs/core/modules/expensereport/mod_expensereport_jade.php +++ b/htdocs/core/modules/expensereport/mod_expensereport_jade.php @@ -30,7 +30,10 @@ class mod_expensereport_jade extends ModeleNumRefExpenseReport { var $version='dolibarr'; // 'development', 'experimental', 'dolibarr' var $prefix='ER'; - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; var $nom='Jade'; diff --git a/htdocs/core/modules/expensereport/modules_expensereport.php b/htdocs/core/modules/expensereport/modules_expensereport.php index e97766b38f6..f60899eee0a 100644 --- a/htdocs/core/modules/expensereport/modules_expensereport.php +++ b/htdocs/core/modules/expensereport/modules_expensereport.php @@ -23,7 +23,10 @@ require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php'; */ abstract class ModeleExpenseReport extends CommonDocGenerator { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** @@ -73,7 +76,10 @@ function expensereport_pdf_create(DoliDB $db, ExpenseReport $object, $message, $ abstract class ModeleNumRefExpenseReport { - var $error=''; + /** + * @var string Error code (or message) + */ + public $error=''; /** * Return if a module can be used or not