From f828e6ee90af425fd8ba93b66bec42225ba3f88e Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:15:48 +0200 Subject: [PATCH 01/12] update comments --- .../commande/doc/pdf_eratosthene.modules.php | 39 +++++++++++++++++-- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php b/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php index f7ce304b380..ae14737c530 100644 --- a/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php +++ b/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php @@ -68,10 +68,10 @@ class pdf_eratosthene extends ModelePDFCommandes public $type; /** - * @var array Minimum version of PHP required by module. - * e.g.: PHP ≥ 5.3 = array(5, 3) + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) */ - public $phpmin = array(5, 2); + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document @@ -79,15 +79,46 @@ class pdf_eratosthene extends ModelePDFCommandes */ public $version = 'development'; + /** + * @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; - public $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; /** From ae681eaf06e0ff10a0fe70242b9c1c9824e11f3c Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:18:56 +0200 Subject: [PATCH 02/12] update comments --- .../facture/doc/pdf_sponge.modules.php | 41 ++++++++++++++++--- 1 file changed, 36 insertions(+), 5 deletions(-) diff --git a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php index da45babde4f..4be117bff0b 100644 --- a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php @@ -69,26 +69,57 @@ class pdf_sponge extends ModelePDFFactures public $type; /** - * @var array Minimum version of PHP required by module. - * e.g.: PHP ≥ 5.3 = array(5, 3) + * @var array() Minimum version of PHP required by module. + * e.g.: PHP ≥ 5.4 = array(5, 4) */ - public $phpmin = array(5, 2); + public $phpmin = array(5, 4); /** * Dolibarr version of the loaded document - * @var string + * @public string */ public $version = 'development'; + /** + * @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; - public $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; /** * @var bool Situation invoice type From 2c41610ac82dbc29ff98eab59882ccbf124d256b Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:21:08 +0200 Subject: [PATCH 03/12] update comments --- .../facture/doc/pdf_sponge.modules.php | 2 +- .../modules/propale/doc/pdf_cyan.modules.php | 76 ++++++++++++++++--- 2 files changed, 67 insertions(+), 11 deletions(-) diff --git a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php index 4be117bff0b..aace72ca1da 100644 --- a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php @@ -43,7 +43,7 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php'; */ class pdf_sponge extends ModelePDFFactures { - /** + /** * @var DoliDb Database handler */ public $db; diff --git a/htdocs/core/modules/propale/doc/pdf_cyan.modules.php b/htdocs/core/modules/propale/doc/pdf_cyan.modules.php index 668693e67cc..c25d1d9e3a1 100644 --- a/htdocs/core/modules/propale/doc/pdf_cyan.modules.php +++ b/htdocs/core/modules/propale/doc/pdf_cyan.modules.php @@ -7,7 +7,7 @@ * Copyright (C) 2012 Cedric Salvador * Copyright (C) 2015 Marcos García * Copyright (C) 2017 Ferran Marcet - * Copyright (C) 2018 Frédéric France + * Copyright (C) 2018 Frédéric France * * 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 @@ -45,23 +45,79 @@ class pdf_cyan extends ModelePDFPropales * @var DoliDb Database handler */ public $db; - public $name; - public $description; - public $update_main_doc_field; // Save the name of generated file as the main doc when generating a doc with this template - public $type; - public $phpmin = array(5, 4); // Minimum version of PHP required by module + /** + * @var string model name + */ + public $name; + + /** + * @var string model description (short text) + */ + public $description; + + /** + * @var int Save the name of generated file as the main doc when generating a doc with this template + */ + public $update_main_doc_field; + + /** + * @var string document type + */ + public $type; + + /** + * @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 = 'development'; - public $page_largeur; - public $page_hauteur; - public $format; + /** + * @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; - public $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; /** From 46488f6a0c7236486e62bd64286fc291a4dc3af5 Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:36:52 +0200 Subject: [PATCH 04/12] update comments --- htdocs/core/modules/modAdherent.class.php | 2 +- htdocs/core/modules/modAsset.class.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/modAdherent.class.php b/htdocs/core/modules/modAdherent.class.php index c0d5e8f4116..41a285efc9f 100644 --- a/htdocs/core/modules/modAdherent.class.php +++ b/htdocs/core/modules/modAdherent.class.php @@ -257,7 +257,7 @@ class modAdherent extends DolibarrModules //-------- $r=0; - // $this->export_code[$r] Code unique identifiant l'export (tous modules confondus) + // $this->export_code[$r] Unique code identifying the export (all modules combined) // $this->export_label[$r] Libelle par defaut si traduction de cle "ExportXXX" non trouvee (XXX = Code) // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export // $this->export_fields_sql[$r] Liste des champs exportables en codif sql diff --git a/htdocs/core/modules/modAsset.class.php b/htdocs/core/modules/modAsset.class.php index b162fabc559..0914f2c0dde 100644 --- a/htdocs/core/modules/modAsset.class.php +++ b/htdocs/core/modules/modAsset.class.php @@ -218,7 +218,7 @@ class modAsset extends DolibarrModules //-------- $r=1; - // $this->export_code[$r] Code unique identifiant l'export (tous modules confondus) + // $this->export_code[$r] Unique code identifying the export (all modules combined) // $this->export_label[$r] Libelle par defaut si traduction de cle "ExportXXX" non trouvee (XXX = Code) // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export // $this->export_fields_sql[$r] Liste des champs exportables en codif sql From eb901e7c4e6b25c453d4e04e90ec76abe4e111c7 Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:38:23 +0200 Subject: [PATCH 05/12] update comments --- htdocs/core/modules/modAdherent.class.php | 2 +- htdocs/core/modules/modAsset.class.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/modAdherent.class.php b/htdocs/core/modules/modAdherent.class.php index 41a285efc9f..10eee1c4c2a 100644 --- a/htdocs/core/modules/modAdherent.class.php +++ b/htdocs/core/modules/modAdherent.class.php @@ -258,7 +258,7 @@ class modAdherent extends DolibarrModules $r=0; // $this->export_code[$r] Unique code identifying the export (all modules combined) - // $this->export_label[$r] Libelle par defaut si traduction de cle "ExportXXX" non trouvee (XXX = Code) + // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export // $this->export_fields_sql[$r] Liste des champs exportables en codif sql // $this->export_fields_name[$r] Liste des champs exportables en codif traduction diff --git a/htdocs/core/modules/modAsset.class.php b/htdocs/core/modules/modAsset.class.php index 0914f2c0dde..6610399d2b9 100644 --- a/htdocs/core/modules/modAsset.class.php +++ b/htdocs/core/modules/modAsset.class.php @@ -219,7 +219,7 @@ class modAsset extends DolibarrModules $r=1; // $this->export_code[$r] Unique code identifying the export (all modules combined) - // $this->export_label[$r] Libelle par defaut si traduction de cle "ExportXXX" non trouvee (XXX = Code) + // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export // $this->export_fields_sql[$r] Liste des champs exportables en codif sql // $this->export_fields_name[$r] Liste des champs exportables en codif traduction From 2b41e9166d54f1d2f336c1c70a388921aa3d612c Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:39:22 +0200 Subject: [PATCH 06/12] update comments --- htdocs/core/modules/modAdherent.class.php | 2 +- htdocs/core/modules/modAsset.class.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/modAdherent.class.php b/htdocs/core/modules/modAdherent.class.php index 10eee1c4c2a..fff976a2db8 100644 --- a/htdocs/core/modules/modAdherent.class.php +++ b/htdocs/core/modules/modAdherent.class.php @@ -259,7 +259,7 @@ class modAdherent extends DolibarrModules // $this->export_code[$r] Unique code identifying the export (all modules combined) // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) - // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export + // $this->export_permission[$r] List of permission codes required to export // $this->export_fields_sql[$r] Liste des champs exportables en codif sql // $this->export_fields_name[$r] Liste des champs exportables en codif traduction // $this->export_sql[$r] Requete sql qui offre les donnees a l'export diff --git a/htdocs/core/modules/modAsset.class.php b/htdocs/core/modules/modAsset.class.php index 6610399d2b9..0e0d66614c7 100644 --- a/htdocs/core/modules/modAsset.class.php +++ b/htdocs/core/modules/modAsset.class.php @@ -220,7 +220,7 @@ class modAsset extends DolibarrModules // $this->export_code[$r] Unique code identifying the export (all modules combined) // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) - // $this->export_permission[$r] Liste des codes permissions requis pour faire l'export + // $this->export_permission[$r] List of permission codes required to export // $this->export_fields_sql[$r] Liste des champs exportables en codif sql // $this->export_fields_name[$r] Liste des champs exportables en codif traduction // $this->export_sql[$r] Requete sql qui offre les donnees a l'export From e2c5c49c5235f4860978415a04f8861efcf51139 Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:40:50 +0200 Subject: [PATCH 07/12] update comments --- htdocs/core/modules/modAdherent.class.php | 2 +- htdocs/core/modules/modAsset.class.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/modAdherent.class.php b/htdocs/core/modules/modAdherent.class.php index fff976a2db8..45adea16100 100644 --- a/htdocs/core/modules/modAdherent.class.php +++ b/htdocs/core/modules/modAdherent.class.php @@ -260,7 +260,7 @@ class modAdherent extends DolibarrModules // $this->export_code[$r] Unique code identifying the export (all modules combined) // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) // $this->export_permission[$r] List of permission codes required to export - // $this->export_fields_sql[$r] Liste des champs exportables en codif sql + // $this->export_fields_sql[$r] List of exportable fields in SQL codiffication // $this->export_fields_name[$r] Liste des champs exportables en codif traduction // $this->export_sql[$r] Requete sql qui offre les donnees a l'export diff --git a/htdocs/core/modules/modAsset.class.php b/htdocs/core/modules/modAsset.class.php index 0e0d66614c7..94dfa1624d2 100644 --- a/htdocs/core/modules/modAsset.class.php +++ b/htdocs/core/modules/modAsset.class.php @@ -221,7 +221,7 @@ class modAsset extends DolibarrModules // $this->export_code[$r] Unique code identifying the export (all modules combined) // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) // $this->export_permission[$r] List of permission codes required to export - // $this->export_fields_sql[$r] Liste des champs exportables en codif sql + // $this->export_fields_sql[$r] List of exportable fields in SQL codiffication // $this->export_fields_name[$r] Liste des champs exportables en codif traduction // $this->export_sql[$r] Requete sql qui offre les donnees a l'export From e8e5e5cfb926398d9d2fb732442090689c64f67d Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:42:01 +0200 Subject: [PATCH 08/12] update comments --- htdocs/core/modules/modAdherent.class.php | 2 +- htdocs/core/modules/modAsset.class.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/modAdherent.class.php b/htdocs/core/modules/modAdherent.class.php index 45adea16100..0a7c1c15484 100644 --- a/htdocs/core/modules/modAdherent.class.php +++ b/htdocs/core/modules/modAdherent.class.php @@ -261,7 +261,7 @@ class modAdherent extends DolibarrModules // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) // $this->export_permission[$r] List of permission codes required to export // $this->export_fields_sql[$r] List of exportable fields in SQL codiffication - // $this->export_fields_name[$r] Liste des champs exportables en codif traduction + // $this->export_fields_name[$r] List of exportable fields in translation codiffication // $this->export_sql[$r] Requete sql qui offre les donnees a l'export $r++; diff --git a/htdocs/core/modules/modAsset.class.php b/htdocs/core/modules/modAsset.class.php index 94dfa1624d2..dc1bf799ff4 100644 --- a/htdocs/core/modules/modAsset.class.php +++ b/htdocs/core/modules/modAsset.class.php @@ -222,7 +222,7 @@ class modAsset extends DolibarrModules // $this->export_label[$r] Libelle by default if translation of key "ExportXXX" not found (XXX = Code) // $this->export_permission[$r] List of permission codes required to export // $this->export_fields_sql[$r] List of exportable fields in SQL codiffication - // $this->export_fields_name[$r] Liste des champs exportables en codif traduction + // $this->export_fields_name[$r] List of exportable fields in translation codiffication // $this->export_sql[$r] Requete sql qui offre les donnees a l'export /* From b154ae752a411b21d305cae3c52833f5e6c0c3ed Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:43:07 +0200 Subject: [PATCH 09/12] update comments --- htdocs/core/modules/modAdherent.class.php | 2 +- htdocs/core/modules/modAsset.class.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/modAdherent.class.php b/htdocs/core/modules/modAdherent.class.php index 0a7c1c15484..b77acf288a3 100644 --- a/htdocs/core/modules/modAdherent.class.php +++ b/htdocs/core/modules/modAdherent.class.php @@ -262,7 +262,7 @@ class modAdherent extends DolibarrModules // $this->export_permission[$r] List of permission codes required to export // $this->export_fields_sql[$r] List of exportable fields in SQL codiffication // $this->export_fields_name[$r] List of exportable fields in translation codiffication - // $this->export_sql[$r] Requete sql qui offre les donnees a l'export + // $this->export_sql[$r] SQL query that offers data for export $r++; $this->export_code[$r]=$this->rights_class.'_'.$r; diff --git a/htdocs/core/modules/modAsset.class.php b/htdocs/core/modules/modAsset.class.php index dc1bf799ff4..d856ad05091 100644 --- a/htdocs/core/modules/modAsset.class.php +++ b/htdocs/core/modules/modAsset.class.php @@ -223,7 +223,7 @@ class modAsset extends DolibarrModules // $this->export_permission[$r] List of permission codes required to export // $this->export_fields_sql[$r] List of exportable fields in SQL codiffication // $this->export_fields_name[$r] List of exportable fields in translation codiffication - // $this->export_sql[$r] Requete sql qui offre les donnees a l'export + // $this->export_sql[$r] SQL query that offers data for export /* $r++; From 5d25c33ff57b50c6b24e5067880fd27b2ce8418a Mon Sep 17 00:00:00 2001 From: ptibogxiv Date: Mon, 1 Apr 2019 20:49:41 +0200 Subject: [PATCH 10/12] fix term --- htdocs/core/lib/functions2.lib.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/htdocs/core/lib/functions2.lib.php b/htdocs/core/lib/functions2.lib.php index ffdf161fc7a..d8eddf79b3b 100644 --- a/htdocs/core/lib/functions2.lib.php +++ b/htdocs/core/lib/functions2.lib.php @@ -2457,7 +2457,7 @@ function dolEscapeXML($string) * @param int $color 0=texte only, 1=Text is formated with a color font style ('ok' or 'error'), 2=Text is formated with 'ok' color. * @return string HTML string */ -function autoOrMamual($automaticmanual, $case = 1, $color = 0) +function autoOrManual($automaticmanual, $case = 1, $color = 0) { global $langs; $result='unknown'; $classname=''; From b978014fb9ec0d4df7dd8f44d6afd3d69d5787e0 Mon Sep 17 00:00:00 2001 From: Philippe Grand Date: Tue, 2 Apr 2019 15:32:01 +0200 Subject: [PATCH 11/12] Update pdf_eratosthene.modules.php --- htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php b/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php index ae14737c530..a9b82751ab3 100644 --- a/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php +++ b/htdocs/core/modules/commande/doc/pdf_eratosthene.modules.php @@ -68,14 +68,14 @@ class pdf_eratosthene extends ModelePDFCommandes public $type; /** - * @var array() 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 - * @public string + * @var string */ public $version = 'development'; From ebe50a4efea64e9717cd5721bdaf81774466254e Mon Sep 17 00:00:00 2001 From: Philippe Grand Date: Tue, 2 Apr 2019 15:33:10 +0200 Subject: [PATCH 12/12] Update pdf_sponge.modules.php --- htdocs/core/modules/facture/doc/pdf_sponge.modules.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php index aace72ca1da..fd26a68c849 100644 --- a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php @@ -69,14 +69,14 @@ class pdf_sponge extends ModelePDFFactures public $type; /** - * @var array() 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 - * @public string + * @var string */ public $version = 'development';