From 2ca26b5fe9b5f82799ccf522dc91ec843bed1709 Mon Sep 17 00:00:00 2001 From: thibdrev Date: Mon, 12 Feb 2024 16:44:01 +0100 Subject: [PATCH] qual: phpdoc for classes using $num_payment (and not inheriting it from another class) (#28133) * phpdoc for classes using $num_payment (and not inheriting it from another class) * Update loanschedule.class.php * Update paymentloan.class.php * Update don.class.php * Update paymentdonation.class.php * Update paymentsalary.class.php * Update paymentsocialcontribution.class.php * Update paymentvarious.class.php * Update paiement.class.php * Update paymentvat.class.php * Update tva.class.php * phpcs * phpcs --- htdocs/compta/bank/class/paymentvarious.class.php | 3 ++- htdocs/compta/paiement/class/paiement.class.php | 5 +++-- .../sociales/class/paymentsocialcontribution.class.php | 4 +++- htdocs/compta/tva/class/paymentvat.class.php | 4 +++- htdocs/compta/tva/class/tva.class.php | 5 +++++ htdocs/don/class/don.class.php | 4 ++++ htdocs/don/class/paymentdonation.class.php | 4 ++++ htdocs/expensereport/class/paymentexpensereport.class.php | 4 ++++ htdocs/loan/class/loanschedule.class.php | 3 ++- htdocs/loan/class/paymentloan.class.php | 3 ++- htdocs/salaries/class/paymentsalary.class.php | 3 ++- 11 files changed, 34 insertions(+), 8 deletions(-) diff --git a/htdocs/compta/bank/class/paymentvarious.class.php b/htdocs/compta/bank/class/paymentvarious.class.php index 33e33291bc8..1bda9521470 100644 --- a/htdocs/compta/bank/class/paymentvarious.class.php +++ b/htdocs/compta/bank/class/paymentvarious.class.php @@ -87,7 +87,8 @@ class PaymentVarious extends CommonObject public $type_payment; /** - * @var string Payment reference + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") */ public $num_payment; diff --git a/htdocs/compta/paiement/class/paiement.class.php b/htdocs/compta/paiement/class/paiement.class.php index 3014a2be721..b44d2563c91 100644 --- a/htdocs/compta/paiement/class/paiement.class.php +++ b/htdocs/compta/paiement/class/paiement.class.php @@ -147,14 +147,15 @@ class Paiement extends CommonObject public $type_code; /** - * @var string Numero du CHQ, VIR, etc... + * @var string * @deprecated * @see $num_payment */ public $num_paiement; /** - * @var string Numero du CHQ, VIR, etc... + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") */ public $num_payment; diff --git a/htdocs/compta/sociales/class/paymentsocialcontribution.class.php b/htdocs/compta/sociales/class/paymentsocialcontribution.class.php index b6b42347d29..3449b18a715 100644 --- a/htdocs/compta/sociales/class/paymentsocialcontribution.class.php +++ b/htdocs/compta/sociales/class/paymentsocialcontribution.class.php @@ -98,11 +98,13 @@ class PaymentSocialContribution extends CommonObject /** * @var string * @deprecated + * @see $num_payment */ public $num_paiement; /** - * @var string + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") */ public $num_payment; diff --git a/htdocs/compta/tva/class/paymentvat.class.php b/htdocs/compta/tva/class/paymentvat.class.php index 0190b4d2e22..6e853036f6e 100644 --- a/htdocs/compta/tva/class/paymentvat.class.php +++ b/htdocs/compta/tva/class/paymentvat.class.php @@ -73,11 +73,13 @@ class PaymentVAT extends CommonObject /** * @var string * @deprecated + * @see $num_payment */ public $num_paiement; /** - * @var string + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") */ public $num_payment; diff --git a/htdocs/compta/tva/class/tva.class.php b/htdocs/compta/tva/class/tva.class.php index 7a0c249992c..ca4b48085f0 100644 --- a/htdocs/compta/tva/class/tva.class.php +++ b/htdocs/compta/tva/class/tva.class.php @@ -60,6 +60,11 @@ class Tva extends CommonObject public $datev; public $amount; public $type_payment; + + /** + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") + */ public $num_payment; /** diff --git a/htdocs/don/class/don.class.php b/htdocs/don/class/don.class.php index a1e90e39904..19cc0ed8dee 100644 --- a/htdocs/don/class/don.class.php +++ b/htdocs/don/class/don.class.php @@ -139,6 +139,10 @@ class Don extends CommonObject */ public $fk_typepayment; + /** + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") + */ public $num_payment; public $date_valid; diff --git a/htdocs/don/class/paymentdonation.class.php b/htdocs/don/class/paymentdonation.class.php index 9eae77ae97a..f53a7f97d1f 100644 --- a/htdocs/don/class/paymentdonation.class.php +++ b/htdocs/don/class/paymentdonation.class.php @@ -67,6 +67,10 @@ class PaymentDonation extends CommonObject public $fk_typepayment; // Payment mode ID public $paymenttype; // Payment mode ID or Code. TODO Use only the code in this field. + /** + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") + */ public $num_payment; /** diff --git a/htdocs/expensereport/class/paymentexpensereport.class.php b/htdocs/expensereport/class/paymentexpensereport.class.php index 6ce84881a73..38a48059c4f 100644 --- a/htdocs/expensereport/class/paymentexpensereport.class.php +++ b/htdocs/expensereport/class/paymentexpensereport.class.php @@ -66,6 +66,10 @@ class PaymentExpenseReport extends CommonObject */ public $fk_typepayment; + /** + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") + */ public $num_payment; /** diff --git a/htdocs/loan/class/loanschedule.class.php b/htdocs/loan/class/loanschedule.class.php index 8b2fd532568..ffe1942998e 100644 --- a/htdocs/loan/class/loanschedule.class.php +++ b/htdocs/loan/class/loanschedule.class.php @@ -66,7 +66,8 @@ class LoanSchedule extends CommonObject public $fk_typepayment; /** - * @var int Payment ID + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") */ public $num_payment; diff --git a/htdocs/loan/class/paymentloan.class.php b/htdocs/loan/class/paymentloan.class.php index f9a5a119411..13581bbfa19 100644 --- a/htdocs/loan/class/paymentloan.class.php +++ b/htdocs/loan/class/paymentloan.class.php @@ -77,7 +77,8 @@ class PaymentLoan extends CommonObject public $fk_typepayment; /** - * @var string Payment ID (ex: 12345-chq1) + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") */ public $num_payment; diff --git a/htdocs/salaries/class/paymentsalary.class.php b/htdocs/salaries/class/paymentsalary.class.php index fd1a6e5acc7..3a2d6bfff75 100644 --- a/htdocs/salaries/class/paymentsalary.class.php +++ b/htdocs/salaries/class/paymentsalary.class.php @@ -110,7 +110,8 @@ class PaymentSalary extends CommonObject public $num_paiement; /** - * @var string Payment reference + * @var string Payment reference + * (Cheque or bank transfer reference. Can be "ABC123") */ public $num_payment;