/
Contribution.php
1457 lines (1337 loc) · 46.7 KB
/
Contribution.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Copyright © 2003-2024 The Galette Team
*
* This file is part of Galette (https://galette.eu).
*
* Galette is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Galette is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Galette. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Galette\Entity;
use ArrayObject;
use DateInterval;
use DateTime;
use Galette\Events\GaletteEvent;
use Galette\Features\HasEvent;
use Throwable;
use Analog\Analog;
use Laminas\Db\Sql\Expression;
use Galette\Core\Db;
use Galette\Core\Login;
use Galette\IO\ExternalScript;
use Galette\IO\PdfContribution;
use Galette\Repository\PaymentTypes;
use Galette\Features\Dynamics;
use Galette\Helpers\EntityHelper;
/**
* Contribution class for galette
* Manage membership fees and donations.
*
* @author Johan Cwiklinski <johan@x-tnd.be>
*
* @property integer $id
* @property string $date
* @property DateTime $raw_date
* @property integer $member
* @property ContributionsTypes $type
* @property double $amount
* @property integer $payment_type
* @property double $orig_amount
* @property string $info
* @property string $begin_date
* @property DateTime $raw_begin_date
* @property string $end_date
* @property DateTime $raw_end_date
* @property Transaction|null $transaction
* @property integer $extension
* @property integer $duration
* @property integer $model
* @property array<string, array<string, string>> $fields
*/
class Contribution
{
use Dynamics;
use HasEvent;
use EntityHelper {
getFieldLabel as protected trait_getFieldLabel;
__isset as protected trait___isset;
}
public const TABLE = 'cotisations';
public const PK = 'id_cotis';
public const TYPE_FEE = 'fee';
public const TYPE_DONATION = 'donation';
public const STATUS_NEVER = -1;
public const STATUS_UNKNOWN = 0;
public const STATUS_UPTODATE = 1;
public const STATUS_DUEFREE = 2;
public const STATUS_IMPENDING = 3;
public const STATUS_LATE = 4;
public const STATUS_OLD = 5;
private int $id;
private ?string $date = null;
private ?int $member = null;
private ?ContributionsTypes $type = null;
private ?float $amount = null;
private ?int $payment_type;
private ?float $orig_amount = null;
private ?string $info = null;
private ?string $begin_date = null;
private ?string $end_date = null;
private ?Transaction $transaction = null;
private bool $is_cotis;
private ?int $extension = null;
/** @var array<int, PaymentType> */
private array $ptypes_list;
private Db $zdb;
private Login $login;
/** @var array<string> */
protected array $errors = [];
private bool $sendmail = false;
/** @var string[] */
protected array $forbidden_fields = ['is_cotis'];
/** @var string[] */
protected array $virtual_fields = [
'duration',
'model',
'raw_date',
'raw_begin_date',
'raw_end_date',
];
/**
* Default constructor
*
* @param Db $zdb Database
* @param Login $login Login instance
* @param null|int|array<string,mixed>|ArrayObject<string,int|string> $args Either a ResultSet row to load
* a specific contribution, or a type id
* to just instantiate object
*/
public function __construct(Db $zdb, Login $login, int|array|ArrayObject $args = null)
{
$this->zdb = $zdb;
$this->login = $login;
global $preferences;
$this->payment_type = $preferences->pref_default_paymenttype;
$this
->setFields()
->withAddEvent()
->withEditEvent()
->withoutDeleteEvent()
->activateEvents();
if (is_int($args)) {
$this->load($args);
} elseif (is_array($args)) {
$this->date = date("Y-m-d");
if (isset($args['adh']) && $args['adh'] != '') {
$this->member = (int)$args['adh'];
}
if (isset($args['trans'])) {
$this->transaction = new Transaction($this->zdb, $this->login, (int)$args['trans']);
if (!isset($this->member)) {
$this->member = $this->transaction->member;
}
$this->amount = $this->transaction->getMissingAmount();
}
$this->setContributionType((int)$args['type']);
//calculate begin date for membership fee
$this->begin_date = $this->date;
if ($this->is_cotis) {
$due_date = self::getDueDate($this->zdb, $this->member);
if ($due_date != '') {
$now = new \DateTime();
$due_date = new \DateTime($due_date);
if ($due_date < $now) {
// Member didn't renew on time
$this->begin_date = $now->format('Y-m-d');
} else {
// Caution : the next_begin_date is the day after the due_date.
$next_begin_date = clone $due_date;
$next_begin_date->add(new DateInterval('P1D'));
$this->begin_date = $next_begin_date->format('Y-m-d');
}
}
$this->retrieveEndDate();
}
if (isset($args['payment_type'])) {
$this->setPaymentType((int)$args['payment_type']);
}
} elseif (is_object($args)) {
$this->loadFromRS($args);
}
$this->loadDynamicFields();
}
/**
* Set fields, must populate $this->fields
*
* @return self
*/
protected function setFields(): self
{
$this->fields = array(
'id_cotis' => array(
'label' => _T('Contribution id'), //not a field in the form
'propname' => 'id'
),
Adherent::PK => array(
'label' => _T("Contributor:"),
'propname' => 'member'
),
ContributionsTypes::PK => array(
'label' => _T("Contribution type:"),
'propname' => 'type'
),
'montant_cotis' => array(
'label' => _T("Amount:"),
'propname' => 'amount'
),
'type_paiement_cotis' => array(
'label' => _T("Payment type:"),
'propname' => 'payment_type'
),
'info_cotis' => array(
'label' => _T("Comments:"),
'propname' => 'info'
),
'date_enreg' => array(
'label' => _T('Date'), //not a field in the form
'propname' => 'date'
),
'date_debut_cotis' => array(
'label' => _T("Date of contribution:"),
'cotlabel' => _T("Start date of membership:"), //if contribution is a membership fee, label differs
'propname' => 'begin_date'
),
'date_fin_cotis' => array(
'label' => _T("End date of membership:"),
'propname' => 'end_date'
),
Transaction::PK => array(
'label' => _T('Transaction ID'), //not a field in the form
'propname' => 'transaction'
),
//this one is not really a field, but is required in some cases...
//adding it here make more simple to check required fields
'duree_mois_cotis' => array(
'label' => _T("Membership extension:"),
'propname' => 'extension'
)
);
return $this;
}
/**
* Sets end contribution date
*
* @return void
*/
private function retrieveEndDate(): void
{
global $preferences;
$now = new \DateTime();
$begin_date = new \DateTime($this->begin_date);
if ($preferences->pref_beg_membership != '') {
//case beginning of membership
if ($this->type->extension < 1) { // 0 = donate; -1= else duration (months)
list($j, $m) = explode('/', $preferences->pref_beg_membership);
$next_begin_date = new DateTime($begin_date->format('Y') . '-' . $m . '-' . $j);
while ($next_begin_date <= $begin_date) {
$next_begin_date->add(new DateInterval('P1Y'));
}
if ($preferences->pref_membership_offermonths > 0) {
//count days until next membership begin date
$diff1 = (int)$now->diff($next_begin_date)->format('%a');
//count days between next membership begin date and offered months
$tdate = clone $next_begin_date;
$tdate->sub(new DateInterval('P' . $preferences->pref_membership_offermonths . 'M'));
$diff2 = (int)$next_begin_date->diff($tdate)->format('%a');
//when number of days until next membership begin date is less than or equal to the offered months, it's free :)
if ($diff1 <= $diff2) {
$next_begin_date->add(new DateInterval('P1Y'));
}
}
// Caution : the end_date to retrieve is the day before the next_begin_date.
$end_date = clone $next_begin_date;
$end_date->sub(new DateInterval('P1D'));
} else {
$dext = new DateInterval('P' . $this->type->extension . 'M');
$end_date = $begin_date->add($dext);
$end_date->sub(new DateInterval('P1D')); //-1 day
}
} elseif ($preferences->pref_membership_ext != '') {
//case membership extension
if ($this->extension == null) {
$this->extension = $preferences->pref_membership_ext;
}
$dext = new DateInterval('P' . $this->extension . 'M');
// Caution : the end_date to retrieve is the day before the next_begin_date.
$next_begin_date = $begin_date->add($dext);
$end_date = clone $next_begin_date;
$end_date->sub(new DateInterval('P1D'));
$this->end_date = $end_date->format('Y-m-d');
} else {
throw new \RuntimeException(
'Unable to define end date; none of pref_beg_membership nor pref_membership_ext are defined!'
);
}
}
/**
* Loads a contribution from its id
*
* @param int $id the identifier for the contribution to load
*
* @return bool true if query succeed, false otherwise
*/
public function load(int $id): bool
{
if (!$this->login->isLogged() && $this->login->id == '') {
return false;
}
try {
$select = $this->zdb->select(self::TABLE, 'c');
$select->join(
array('a' => PREFIX_DB . Adherent::TABLE),
'c.' . Adherent::PK . '=a.' . Adherent::PK,
array()
);
//restrict query on current member id if he's not admin nor staff member
if (!$this->login->isAdmin() && !$this->login->isStaff()) {
$select->where
->nest()
->equalTo('a.' . Adherent::PK, $this->login->id)
->or
->equalTo('a.parent_id', $this->login->id)
->unnest()
->and
->equalTo('c.' . self::PK, $id)
;
} else {
$select->where->equalTo(self::PK, $id);
}
$results = $this->zdb->execute($select);
if ($results->count() > 0) {
$row = $results->current();
$this->loadFromRS($row);
return true;
} else {
Analog::log(
'No contribution #' . $id . ' (user ' . $this->login->id . ')',
Analog::ERROR
);
return false;
}
} catch (Throwable $e) {
Analog::log(
'An error occurred attempting to load contribution #' . $id .
$e->getMessage(),
Analog::ERROR
);
throw $e;
}
}
/**
* Populate object from a resultset row
*
* @param ArrayObject<string, int|string> $r the resultset row
*
* @return void
*/
private function loadFromRS(ArrayObject $r): void
{
$pk = self::PK;
$this->id = (int)$r->$pk;
$this->date = $r->date_enreg;
$this->amount = (double)$r->montant_cotis;
//save original amount, we need it for transactions parts calculations
$this->orig_amount = (double)$r->montant_cotis;
$this->payment_type = $r->type_paiement_cotis;
$this->info = $r->info_cotis;
$this->begin_date = $r->date_debut_cotis;
$end_date = $r->date_fin_cotis;
//do not work with knows bad dates...
//the one with BC comes from 0.63/pgsql demo... Why the hell a so
//strange date? don't know :(
if (
$end_date !== '0000-00-00'
&& $end_date !== '1901-01-01'
&& $end_date !== '0001-01-01 BC'
) {
$this->end_date = $r->date_fin_cotis;
}
$adhpk = Adherent::PK;
$this->member = (int)$r->$adhpk;
$transpk = Transaction::PK;
if ($r->$transpk != '') {
$this->transaction = new Transaction($this->zdb, $this->login, (int)$r->$transpk);
}
$this->setContributionType((int)$r->id_type_cotis);
$this->loadDynamicFields();
}
/**
* Check posted values validity
*
* @param array<string,mixed> $values All values to check, basically the $_POST array
* after sending the form
* @param array<string,int> $required Array of required fields
* @param array<string> $disabled Array of disabled fields
*
* @return true|array<string>
*/
public function check(array $values, array $required, array $disabled): bool|array
{
global $preferences;
$this->errors = array();
$fields = array_keys($this->fields);
foreach ($fields as $key) {
//first, let's sanitize values
$key = strtolower($key);
$prop = $this->fields[$key]['propname'];
if (isset($values[$key])) {
$value = trim($values[$key]);
} else {
$value = '';
}
// if the field is enabled, check it
if (!isset($disabled[$key])) {
// fill up the adherent structure
//$this->$prop = stripslashes($value); //not relevant here!
// now, check validity
switch ($key) {
// dates
case 'date_enreg':
case 'date_debut_cotis':
case 'date_fin_cotis':
if ($value != '') {
$this->setDate($key, $value);
}
break;
case Adherent::PK:
if ($value != '') {
$this->member = (int)$value;
}
break;
case ContributionsTypes::PK:
if ($value != '') {
$this->setContributionType((int)$value);
}
break;
case 'montant_cotis':
$value = strtr($value, ',', '.');
if (!empty($value) || $value === '0') {
$this->amount = (double)$value;
}
if (!is_numeric($value) && $value !== '') {
$this->errors[] = _T("- The amount must be an integer!");
}
break;
case 'type_paiement_cotis':
if ($value != '') {
$this->setPaymentType((int)$value);
}
break;
case 'info_cotis':
$this->info = $value;
break;
case Transaction::PK:
if ($value != '') {
$this->transaction = new Transaction($this->zdb, $this->login, (int)$value);
}
break;
case 'duree_mois_cotis':
if ($value != '') {
if (!is_numeric($value) || $value <= 0) {
$this->errors[] = _T("- The duration must be a positive integer!");
}
$this->$prop = $value;
$this->retrieveEndDate();
}
break;
}
}
}
// missing required fields?
foreach ($required as $key => $val) {
if ($val === 1) {
$prop = $this->fields[$key]['propname'];
if (
!isset($disabled[$key])
&& (!isset($this->$prop)
|| (!is_object($this->$prop) && trim($this->$prop) == '')
|| (is_object($this->$prop) && trim($this->$prop->id) == ''))
) {
$this->errors[] = str_replace(
'%field',
'<a href="#' . $key . '">' . $this->getFieldLabel($key) . '</a>',
_T("- Mandatory field %field empty.")
);
}
}
}
if ($this->transaction != null && $this->amount != null) {
$missing = $this->transaction->getMissingAmount();
//calculate new missing amount
$missing = $missing + $this->orig_amount - $this->amount;
if ($missing < 0) {
$this->errors[] = _T("- Sum of all contributions exceed corresponding transaction amount.");
}
}
if ($this->isFee() && count($this->errors) == 0) {
$overlap = $this->checkOverlap();
if ($overlap !== true) {
//method directly return error message
$this->errors[] = $overlap;
}
}
$this->dynamicsCheck($values, $required, $disabled);
if (count($this->errors) > 0) {
Analog::log(
'Some errors has been threw attempting to edit/store a contribution' .
print_r($this->errors, true),
Analog::ERROR
);
return $this->errors;
} else {
Analog::log(
'Contribution checked successfully.',
Analog::DEBUG
);
return true;
}
}
/**
* Check that membership fees does not overlap
*
* @return boolean|string True if all is ok, false if error,
* error message if overlap
*/
public function checkOverlap(): bool|string
{
try {
$select = $this->zdb->select(self::TABLE, 'c');
//@phpstan-ignore-next-line
$select->columns(
array('date_debut_cotis', 'date_fin_cotis')
)->join(
array('ct' => PREFIX_DB . ContributionsTypes::TABLE),
'c.' . ContributionsTypes::PK . '=ct.' . ContributionsTypes::PK,
array()
)->where([Adherent::PK => $this->member])
->where->notEqualTo('cotis_extension', ContributionType::TYPE_DONATION)
->where->nest->nest
->greaterThanOrEqualTo('date_debut_cotis', $this->begin_date)
->lessThanOrEqualTo('date_debut_cotis', $this->end_date)
->unnest
->or->nest
->greaterThanOrEqualTo('date_fin_cotis', $this->begin_date)
->lessThanOrEqualTo('date_fin_cotis', $this->end_date);
if (isset($this->id)) {
$select->where->notEqualTo(self::PK, $this->id);
}
$results = $this->zdb->execute($select);
if ($results->count() > 0) {
$result = $results->current();
$d_begin = new \DateTime($result->date_debut_cotis);
$d_end = new \DateTime($result->date_fin_cotis);
if ($d_begin->format('m-d') == $d_end->format('m-d') && $result->date_fin_cotis == $this->begin_date) {
//see https://bugs.galette.eu/issues/1762
return true;
}
return _T("- Membership period overlaps period starting at ") .
$d_begin->format(__("Y-m-d"));
}
return true;
} catch (Throwable $e) {
Analog::log(
'An error occurred checking overlapping fee. ' . $e->getMessage(),
Analog::ERROR
);
throw $e;
}
}
/**
* Store the contribution
*
* @return boolean
*/
public function store(): bool
{
global $hist, $emitter;
$event = null;
if (count($this->errors) > 0) {
throw new \RuntimeException(
'Existing errors prevents storing contribution: ' .
print_r($this->errors, true)
);
}
try {
$this->zdb->connection->beginTransaction();
$values = array();
$fields = self::getDbFields($this->zdb);
foreach ($fields as $field) {
$prop = $this->fields[$field]['propname'];
if (!isset($this->$prop)) {
continue;
}
switch ($field) {
case ContributionsTypes::PK:
case Transaction::PK:
$values[$field] = $this->$prop->id;
break;
default:
$values[$field] = $this->$prop;
break;
}
}
//no end date, let's take database defaults
if (!$this->isFee() && !$this->end_date) {
unset($values['date_fin_cotis']);
}
if (!isset($this->id) || $this->id == '') {
//we're inserting a new contribution
unset($values[self::PK]);
$insert = $this->zdb->insert(self::TABLE);
$insert->values($values);
$add = $this->zdb->execute($insert);
if ($add->count() > 0) {
$this->id = $this->zdb->getLastGeneratedValue($this);
// logging
$hist->add(
_T("Contribution added"),
Adherent::getSName($this->zdb, $this->member)
);
$event = $this->getAddEventName();
} else {
$hist->add(_T("Fail to add new contribution."));
throw new \Exception(
'An error occurred inserting new contribution!'
);
}
} else {
//we're editing an existing contribution
$update = $this->zdb->update(self::TABLE);
$update->set($values)->where([self::PK => $this->id]);
$edit = $this->zdb->execute($update);
//edit == 0 does not mean there were an error, but that there
//were nothing to change
if ($edit->count() > 0) {
$hist->add(
_T("Contribution updated"),
Adherent::getSName($this->zdb, $this->member)
);
}
$event = $this->getEditEventName();
}
//update deadline
if ($this->isFee()) {
$this->updateDeadline();
}
//dynamic fields
$this->dynamicsStore(true);
$this->zdb->connection->commit();
$this->orig_amount = $this->amount;
//send event at the end of process, once all has been stored
if ($event !== null && $this->areEventsEnabled()) {
$emitter->dispatch(new GaletteEvent($event, $this));
}
return true;
} catch (Throwable $e) {
if ($this->zdb->connection->inTransaction()) {
$this->zdb->connection->rollBack();
}
throw $e;
}
}
/**
* Update member deadline
*
* @return boolean
*/
private function updateDeadline(): bool
{
try {
$due_date = self::getDueDate($this->zdb, $this->member);
if ($due_date != '') {
$due_date_update = $due_date;
} else {
$due_date_update = new Expression('NULL');
}
$update = $this->zdb->update(Adherent::TABLE);
$update->set(
array('date_echeance' => $due_date_update)
)->where(
[Adherent::PK => $this->member]
);
$this->zdb->execute($update);
return true;
} catch (Throwable $e) {
Analog::log(
'An error occurred updating member ' . $this->member .
'\'s deadline |' .
$e->getMessage(),
Analog::ERROR
);
throw $e;
}
}
/**
* Remove contribution from database
*
* @param boolean $transaction Activate transaction mode (defaults to true)
*
* @return boolean
*/
public function remove(bool $transaction = true): bool
{
global $emitter;
try {
if ($transaction) {
$this->zdb->connection->beginTransaction();
}
$delete = $this->zdb->delete(self::TABLE);
$delete->where([self::PK => $this->id]);
$del = $this->zdb->execute($delete);
if ($del->count() > 0) {
$this->updateDeadline();
$this->dynamicsRemove(true);
} else {
Analog::log(
'Contribution has not been removed!',
Analog::WARNING
);
return false;
}
if ($transaction) {
$this->zdb->connection->commit();
}
$emitter->dispatch(new GaletteEvent('contribution.remove', $this));
return true;
} catch (Throwable $e) {
if ($transaction) {
$this->zdb->connection->rollBack();
}
Analog::log(
'An error occurred trying to remove contribution #' .
$this->id . ' | ' . $e->getMessage(),
Analog::ERROR
);
throw $e;
}
}
/**
* Get field label
*
* @param string $field Field name
* @param string $entry Array entry to use (defaults to "label")
*
* @return string
*/
public function getFieldLabel(string $field, string $entry = 'label'): string
{
if ($field == 'date_debut_cotis' && !empty($this->is_cotis) && $this->isFee()) {
$entry = 'cotlabel';
}
return $this->trait_getFieldLabel($field, $entry);
}
/**
* Retrieve fields from database
*
* @param Db $zdb Database instance
*
* @return array<string>
*/
public static function getDbFields(Db $zdb): array
{
$columns = $zdb->getColumns(self::TABLE);
$fields = array();
foreach ($columns as $col) {
$fields[] = $col->getName();
}
return $fields;
}
/**
* Get the relevant CSS class for current contribution
*
* @return string current contribution row class
*/
public function getRowClass(): string
{
return ($this->end_date != $this->begin_date && $this->is_cotis) ?
'cotis-normal' : 'cotis-give';
}
/**
* Retrieve member due date
*
* @param Db $zdb Database instance
* @param ?integer $member_id Member identifier
*
* @return string|null
*/
public static function getDueDate(Db $zdb, ?int $member_id): ?string
{
if (!$member_id) {
return '';
}
try {
$select = $zdb->select(self::TABLE, 'c');
$select->columns(
array(
'max_date' => new Expression('MAX(date_fin_cotis)')
)
)->join(
array('ct' => PREFIX_DB . ContributionsTypes::TABLE),
'c.' . ContributionsTypes::PK . '=ct.' . ContributionsTypes::PK,
array()
)->where(
[Adherent::PK => $member_id]
)
->where->notEqualTo('cotis_extension', ContributionType::TYPE_DONATION);
$results = $zdb->execute($select);
$result = $results->current();
$due_date = $result->max_date;
//avoid bad dates in postgres and bad mysql return from zenddb
if ($due_date == '0001-01-01 BC' || $due_date == '1901-01-01') {
$due_date = '';
}
return $due_date;
} catch (Throwable $e) {
Analog::log(
'An error occurred trying to retrieve member\'s due date',
Analog::ERROR
);
throw $e;
}
}
/**
* Detach a contribution from a transaction
*
* @param Db $zdb Database instance
* @param Login $login Login instance
* @param int $trans_id Transaction identifier
* @param int $contrib_id Contribution identifier
*
* @return boolean
*/
public static function unsetTransactionPart(Db $zdb, Login $login, int $trans_id, int $contrib_id): bool
{
try {
//first, we check if contribution is part of transaction
$c = new Contribution($zdb, $login, (int)$contrib_id);
if ($c->isTransactionPartOf($trans_id)) {
$update = $zdb->update(self::TABLE);
$update->set(
array(Transaction::PK => null)
)->where(
[self::PK => $contrib_id]
);
$zdb->execute($update);
return true;
} else {
Analog::log(
'Contribution #' . $contrib_id .
' is not actually part of transaction #' . $trans_id,
Analog::WARNING
);
return false;
}
} catch (Throwable $e) {
Analog::log(
'Unable to detach contribution #' . $contrib_id .
' to transaction #' . $trans_id . ' | ' . $e->getMessage(),
Analog::ERROR
);
throw $e;
}
}
/**
* Set a contribution as a transaction part
*
* @param Db $zdb Database instance
* @param int $trans_id Transaction identifier
* @param int $contrib_id Contribution identifier
*
* @return boolean
*/
public static function setTransactionPart(Db $zdb, int $trans_id, int $contrib_id): bool
{
try {
$update = $zdb->update(self::TABLE);
$update->set(
array(Transaction::PK => $trans_id)
)->where([self::PK => $contrib_id]);
$zdb->execute($update);
return true;
} catch (Throwable $e) {
Analog::log(
'Unable to attach contribution #' . $contrib_id .
' to transaction #' . $trans_id . ' | ' . $e->getMessage(),
Analog::ERROR
);
throw $e;
}
}
/**
* Is current contribution a membership fee
*
* @return boolean
*/
public function isFee(): bool
{
return $this->is_cotis;
}
/**
* Is current contribution part of specified transaction
*
* @param int $id Transaction identifier
*
* @return boolean
*/
public function isTransactionPartOf(int $id): bool
{
if ($this->isTransactionPart()) {
return $id == $this->transaction->id;
} else {
return false;
}
}
/**
* Is current contribution part of transaction
*
* @return boolean
*/
public function isTransactionPart(): bool
{
return $this->transaction != null;
}
/**
* Execute post contribution script
*
* @param ExternalScript $es External script to execute
* @param ?array<string,mixed> $extra Extra information on contribution
* Defaults to null