-
-
Notifications
You must be signed in to change notification settings - Fork 812
/
LineItem.php
1224 lines (1131 loc) · 47.1 KB
/
LineItem.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 CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
/**
* Business objects for Line Items generated by monetary transactions
*/
class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem {
/**
* Creates a new entry in the database.
*
* @param array $params
* (reference) an assoc array of name/value pairs.
*
* @return CRM_Price_BAO_LineItem
*
* @throws \CRM_Core_Exception
* @throws \Exception
*/
public static function create(&$params) {
$id = $params['id'] ?? NULL;
// unset entity table and entity id in $params
// we never update the entity table and entity id during update mode
if ($id) {
$entity_id = $params['entity_id'] ?? NULL;
$entity_table = $params['entity_table'] ?? NULL;
unset($params['entity_id'], $params['entity_table']);
}
else {
if (!isset($params['unit_price'])) {
$params['unit_price'] = 0;
}
}
if (isset($params['financial_type_id'], $params['line_total'])) {
$params['tax_amount'] = self::getTaxAmountForLineItem($params);
}
// Call the hooks after tax is set in case hooks wish to alter it.
if ($id) {
CRM_Utils_Hook::pre('edit', 'LineItem', $id, $params);
}
else {
CRM_Utils_Hook::pre('create', 'LineItem', $id, $params);
}
$lineItemBAO = new CRM_Price_BAO_LineItem();
$lineItemBAO->copyValues($params);
$return = $lineItemBAO->save();
if ($lineItemBAO->entity_table === 'civicrm_membership' && $lineItemBAO->contribution_id && $lineItemBAO->entity_id) {
$membershipPaymentParams = [
'membership_id' => $lineItemBAO->entity_id,
'contribution_id' => $lineItemBAO->contribution_id,
];
if (!civicrm_api3('MembershipPayment', 'getcount', $membershipPaymentParams)) {
// If we are creating the membership payment row from the line item then we
// should have correct line item & membership payment should not need to fix.
$membershipPaymentParams['isSkipLineItem'] = TRUE;
civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
}
}
if ($lineItemBAO->entity_table === 'civicrm_participant' && $lineItemBAO->contribution_id && $lineItemBAO->entity_id) {
$participantPaymentParams = [
'participant_id' => $lineItemBAO->entity_id,
'contribution_id' => $lineItemBAO->contribution_id,
];
if (!civicrm_api3('ParticipantPayment', 'getcount', $participantPaymentParams)) {
civicrm_api3('ParticipantPayment', 'create', $participantPaymentParams);
}
}
if ($id) {
// CRM-21281: Restore entity reference in case the post hook needs it
$lineItemBAO->entity_id = $entity_id;
$lineItemBAO->entity_table = $entity_table;
CRM_Utils_Hook::post('edit', 'LineItem', $id, $lineItemBAO);
}
else {
CRM_Utils_Hook::post('create', 'LineItem', $lineItemBAO->id, $lineItemBAO);
}
return $return;
}
/**
* Retrieve DB object and copy to defaults array.
*
* @param array $params
* Array of criteria values.
* @param array $defaults
* Array to be populated with found values.
*
* @return self|null
* The DAO object, if found.
*
* @deprecated
*/
public static function retrieve($params, &$defaults = []) {
return self::commonRetrieve(self::class, $params, $defaults);
}
/**
* @param int $contributionId
*
* @return null|string
*/
public static function getLineTotal($contributionId) {
$sqlLineItemTotal = "SELECT SUM(li.line_total + COALESCE(li.tax_amount,0))
FROM civicrm_line_item li
WHERE li.contribution_id = %1";
$params = [1 => [$contributionId, 'Integer']];
$lineItemTotal = CRM_Core_DAO::singleValueQuery($sqlLineItemTotal, $params);
return $lineItemTotal;
}
/**
* (quasi-deprecated) Wrapper for line item retrieval when contribution ID is known.
* @param int $contributionID
*
* @internal - apiv4 is recommended.
*
* @return array
*/
public static function getLineItemsByContributionID($contributionID) {
return self::getLineItems($contributionID, 'contribution', NULL, TRUE, TRUE);
}
/**
* Given a participant id/contribution id,
* return contribution/fee line items
*
* Try to use the `BAO_Order` in internal code rather than accessing this
* directly (external code should use the api). We aim to deprecate this
* over time.
*
* @internal
*
* @param int $entityId
* participant/contribution id.
* @param string $entity
* participant/contribution.
*
* @param bool $isQuick
* @param bool $isQtyZero
* @param bool $relatedEntity
*
* @return array
* Array of line items
*/
public static function getLineItems($entityId, $entity = 'participant', $isQuick = FALSE, $isQtyZero = TRUE, $relatedEntity = FALSE) {
$whereClause = $fromClause = NULL;
$selectClause = '
SELECT li.id,
li.label,
li.contribution_id,
li.qty,
li.unit_price,
li.line_total,
li.entity_table,
li.entity_id,
pf.label as field_title,
pf.html_type,
pf.price_set_id,
pfv.membership_type_id,
pfv.membership_num_terms,
li.price_field_id,
li.participant_count,
li.price_field_value_id,
li.financial_type_id,
li.tax_amount,
pfv.description';
$condition = "li.entity_id = civicrm_%2.id AND li.entity_table = 'civicrm_%2'";
if ($relatedEntity) {
$condition = 'li.contribution_id = civicrm_%2.id ';
}
$fromClause = "
FROM civicrm_%2
LEFT JOIN civicrm_line_item li ON ({$condition})
LEFT JOIN civicrm_price_field_value pfv ON (pfv.id = li.price_field_value_id)
LEFT JOIN civicrm_price_field pf ON (pf.id = li.price_field_id )";
$whereClause = " WHERE civicrm_%2.id = %1";
$orderByClause = " ORDER BY pf.weight, pfv.weight";
if ($isQuick) {
$fromClause .= ' LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ';
$whereClause .= ' and cps.is_quick_config = 0';
}
if (!$isQtyZero) {
$whereClause .= " and li.qty != 0";
}
$lineItems = [];
if (!$entityId || !$entity || !$fromClause) {
return $lineItems;
}
$params = [
1 => [$entityId, 'Integer'],
2 => [$entity, 'Text'],
];
$getTaxDetails = FALSE;
$dao = CRM_Core_DAO::executeQuery("$selectClause $fromClause $whereClause $orderByClause", $params);
while ($dao->fetch()) {
if (!$dao->id) {
continue;
}
$lineItems[$dao->id] = [
'qty' => (float) $dao->qty,
'label' => $dao->label,
'unit_price' => $dao->unit_price,
'line_total' => $dao->line_total,
'price_field_id' => $dao->price_field_id,
'participant_count' => $dao->participant_count,
'price_field_value_id' => $dao->price_field_value_id,
'field_title' => $dao->field_title,
'html_type' => $dao->html_type,
'description' => $dao->description,
'entity_id' => $dao->entity_id,
'entity_table' => $dao->entity_table,
'contribution_id' => $dao->contribution_id,
'financial_type_id' => $dao->financial_type_id,
'financial_type' => CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'financial_type_id', $dao->financial_type_id),
'membership_type_id' => $dao->membership_type_id,
'membership_num_terms' => $dao->membership_num_terms,
'tax_amount' => (float) $dao->tax_amount,
'price_set_id' => $dao->price_set_id,
];
$taxRates = CRM_Core_PseudoConstant::getTaxRates();
if (isset($lineItems[$dao->id]['financial_type_id']) && array_key_exists($lineItems[$dao->id]['financial_type_id'], $taxRates)) {
// Cast to float so trailing zero decimals are removed for display.
$lineItems[$dao->id]['tax_rate'] = (float) $taxRates[$lineItems[$dao->id]['financial_type_id']];
}
else {
// There is no Tax Rate associated with this Financial Type
$lineItems[$dao->id]['tax_rate'] = FALSE;
}
$lineItems[$dao->id]['subTotal'] = $lineItems[$dao->id]['qty'] * $lineItems[$dao->id]['unit_price'];
if ($lineItems[$dao->id]['tax_amount'] != '') {
$getTaxDetails = TRUE;
}
}
return $lineItems;
}
/**
* This method will create the lineItem array required for
* processAmount method
*
* @param int $fid
* Price set field id.
* @param array $params
* Reference to form values.
* @param array $fields
* Array of fields belonging to the price set used for particular event
* @param array $values
* Reference to the values array(.
* this is
* lineItem array)
* @param string $amount_override
* Amount override must be in format 1000.00 - ie no thousand separator & if
* a decimal point is used it should be a decimal
*
* @todo - this parameter is only used for partial payments. It's unclear why a partial
* payment would change the line item price.
*/
public static function format($fid, $params, $fields, &$values, $amount_override = NULL) {
if (empty($params["price_{$fid}"])) {
return;
}
//lets first check in fun parameter,
//since user might modified w/ hooks.
$options = [];
if (array_key_exists('options', $fields)) {
$options = $fields['options'];
}
else {
CRM_Price_BAO_PriceFieldValue::getValues($fid, $options, 'weight', TRUE);
}
$fieldTitle = $fields['label'] ?? NULL;
if (!$fieldTitle) {
$fieldTitle = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'label');
}
foreach ($params["price_{$fid}"] as $oid => $qty) {
$qty = (float) $qty;
$price = (float) ($amount_override === NULL ? $options[$oid]['amount'] : $amount_override);
$participantsPerField = (int) ($options[$oid]['count'] ?? 0);
$values[$oid] = [
'price_field_id' => $fid,
'price_field_value_id' => $oid,
'label' => $options[$oid]['label'] ?? NULL,
'field_title' => $fieldTitle,
'description' => $options[$oid]['description'] ?? NULL,
'qty' => $qty,
'unit_price' => $price,
'line_total' => $qty * $price,
'participant_count' => $qty * $participantsPerField,
'max_value' => $options[$oid]['max_value'] ?? NULL,
'membership_type_id' => $options[$oid]['membership_type_id'] ?? NULL,
'membership_num_terms' => $options[$oid]['membership_num_terms'] ?? NULL,
'auto_renew' => !empty($options[$oid]['auto_renew']) ? (int) $options[$oid]['auto_renew'] : NULL,
'html_type' => $fields['html_type'],
'financial_type_id' => $options[$oid]['financial_type_id'] ?? NULL,
'tax_amount' => $options[$oid]['tax_amount'] ?? 0,
'non_deductible_amount' => $options[$oid]['non_deductible_amount'] ?? NULL,
];
if ($values[$oid]['membership_type_id'] && empty($values[$oid]['auto_renew'])) {
$values[$oid]['auto_renew'] = (int) CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $values[$oid]['membership_type_id'], 'auto_renew');
}
}
}
/**
* Delete line items for given entity.
*
* @param int $entityId
* @param int $entityTable
*
* @return bool
*/
public static function deleteLineItems($entityId, $entityTable) {
if (!$entityId || !$entityTable) {
return FALSE;
}
if ($entityId && !is_array($entityId)) {
$entityId = [$entityId];
}
$params = [];
foreach ($entityId as $id) {
CRM_Utils_Hook::pre('delete', 'LineItem', $id, $params);
}
$query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
$dao = CRM_Core_DAO::executeQuery($query);
return TRUE;
}
/**
* Process price set and line items.
*
* @param int $entityId
* @param array $lineItems
* Line item array.
* @param object $contributionDetails
* @param string $entityTable
* Entity table.
*
* @param bool $update
*
* @throws \CRM_Core_Exception
*/
public static function processPriceSet($entityId, $lineItems, $contributionDetails = NULL, $entityTable = 'civicrm_contribution', $update = FALSE) {
if (!$entityId || !is_array($lineItems)
|| CRM_Utils_System::isNull($lineItems)
) {
return;
}
foreach ($lineItems as &$values) {
foreach ($values as &$line) {
if (empty($line['entity_table'])) {
$line['entity_table'] = $entityTable;
}
if (empty($line['entity_id'])) {
$line['entity_id'] = $entityId;
}
if (!empty($line['membership_type_id'])) {
if (($line['entity_table'] ?? '') !== 'civicrm_membership') {
CRM_Core_Error::deprecatedWarning('entity table should be already set');
}
$line['entity_table'] = 'civicrm_membership';
}
if (!empty($contributionDetails->id)) {
$line['contribution_id'] = $contributionDetails->id;
if ($line['entity_table'] === 'civicrm_contribution') {
$line['entity_id'] = $contributionDetails->id;
}
}
// if financial type is not set and if price field value is NOT NULL
// get financial type id of price field value
if (!empty($line['price_field_value_id']) && empty($line['financial_type_id'])) {
$line['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $line['price_field_value_id'], 'financial_type_id');
}
$createdLineItem = CRM_Price_BAO_LineItem::create($line);
if (!$update && $contributionDetails) {
$financialItem = CRM_Financial_BAO_FinancialItem::add($createdLineItem, $contributionDetails);
$line['financial_item_id'] = $financialItem->id;
if (!empty($line['tax_amount'])) {
CRM_Financial_BAO_FinancialItem::add($createdLineItem, $contributionDetails, TRUE);
}
}
}
}
if (!$update && $contributionDetails) {
CRM_Core_BAO_FinancialTrxn::createDeferredTrxn($lineItems, $contributionDetails);
}
}
/**
* Build line items array.
*
* @param array $params
* Form values.
*
* @param string[]|null $entityId
* Entity id.
*
* @param string $entityTable
* Entity Table.
*
* @param bool $isRelatedID
*/
public static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution', $isRelatedID = FALSE) {
if (!$entityId) {
$priceSetDetails = CRM_Price_BAO_PriceSet::getDefaultPriceSet($entityTable);
$totalAmount = $params['total_amount'] ?? 0;
$financialType = $params['financial_type_id'] ?? NULL;
foreach ($priceSetDetails as $values) {
if ($entityTable === 'membership') {
if ($isRelatedID != $values['membership_type_id']) {
continue;
}
if (!$totalAmount) {
$totalAmount = $values['amount'];
}
$financialType = $values['financial_type_id'];
}
$taxRates = CRM_Core_PseudoConstant::getTaxRates();
$taxRate = $taxRates[$financialType] ?? 0;
$taxAmount = ($taxRate / 100) * $totalAmount / (1 + ($taxRate / 100));
$lineItem = [
'price_field_id' => $values['priceFieldID'],
'price_field_value_id' => $values['priceFieldValueID'],
'label' => $values['label'],
'qty' => 1,
'unit_price' => $totalAmount - $taxAmount,
'line_total' => $totalAmount - $taxAmount,
'financial_type_id' => $financialType,
'membership_type_id' => $values['membership_type_id'],
'tax_amount' => $taxAmount,
];
$params['line_item'][$values['setID']][$values['priceFieldID']] = $lineItem;
break;
}
}
else {
$setID = NULL;
$totalEntityId = count($entityId);
if ($entityTable == 'contribution') {
$isRelatedID = TRUE;
}
foreach ($entityId as $id) {
$lineItems = CRM_Price_BAO_LineItem::getLineItems($id, $entityTable, FALSE, TRUE, $isRelatedID);
foreach ($lineItems as $key => $values) {
if (!$setID && $values['price_field_id']) {
$setID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $values['price_field_id'], 'price_set_id');
$params['is_quick_config'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'is_quick_config');
}
if (!empty($params['is_quick_config']) && array_key_exists('total_amount', $params)
&& $totalEntityId == 1 && count($lineItems) == 1
) {
$values['line_total'] = $values['unit_price'] = $params['total_amount'];
}
$values['id'] = $key;
$params['line_item'][$setID][$key] = $values;
}
}
}
}
/**
* Build the line items for the submitted price field.
*
* This is when first building them - not an update where an entityId is already present
* as this is intended as a subfunction of that. Ideally getLineItemArray would call this
* (resolving to the same format regardless of what type of price set is being used first).
*
* @param array $priceParams
* These are per the way the form processes them - ie
* ['price_1' => 1, 'price_2' => 8]
* This would mean price field id 1, option 1 (or 1 unit if using is_enter_qty).
* @param float|null $overrideAmount
* Optional override of the amount.
*
* @param int|null $financialTypeID
* Financial type ID is the type should be overridden.
*
* @return array
* Line items formatted for processing. These will look like
* [4] => ['price_field_id' => 4, 'price_field_value_id' => x, 'label....qty...unit_price...line_total...financial_type_id]
* [5] => ['price_field_id' => 5, 'price_field_value_id' => x, 'label....qty...unit_price...line_total...financial_type_id]
*
*/
public static function buildLineItemsForSubmittedPriceField($priceParams, $overrideAmount = NULL, $financialTypeID = NULL): array {
$lineItems = [];
foreach ($priceParams as $key => $value) {
$priceField = self::getPriceFieldMetaData($key);
if ($priceField['html_type'] === 'Text') {
$valueSpec = reset($priceField['values']);
}
else {
$valueSpec = $priceField['values'][$value];
}
$qty = $priceField['is_enter_qty'] ? $value : 1;
$lineItems[$priceField['id']] = [
'price_field_id' => $priceField['id'],
'price_field_value_id' => $valueSpec['id'],
'label' => $valueSpec['label'],
'qty' => $qty,
'unit_price' => $overrideAmount ?: $valueSpec['amount'],
'line_total' => $qty * ($overrideAmount ?: $valueSpec['amount']),
'financial_type_id' => $financialTypeID ?: $valueSpec['financial_type_id'],
'membership_type_id' => $valueSpec['membership_type_id'],
'price_set_id' => $priceField['price_set_id'],
];
}
return $lineItems;
}
/**
* Function to update related contribution of a entity and
* add/update/cancel financial records
*
* @param array $params
* @param int $entityID
* @param int $entity
* @param int $contributionId
* @param \CRM_Core_Form|null $form
*
* @throws \CRM_Core_Exception
*/
public static function changeFeeSelections(
$params,
$entityID,
$entity,
$contributionId,
$form = NULL
) {
$order = new CRM_Financial_BAO_Order();
$order->setPriceSelectionFromUnfilteredInput($params);
if ($form) {
// This will cause the buildAmount hook to be called.
$order->setForm($form);
}
unset($params);
$feeAmount = $updatedAmount = $order->getTotalAmount();
$taxAmount = $order->getTotalTaxAmount();
$submittedLineItems = $order->getLineItems();
$entityTable = 'civicrm_' . $entity;
// initialize empty Lineitem instance to call protected helper functions
$lineItemObj = new CRM_Price_BAO_LineItem();
$requiredChanges = $lineItemObj->getLineItemsToAlter($submittedLineItems, $entityID, $entity);
// get financial information that need to be recorded on basis on submitted price field value IDs
if (!empty($requiredChanges['line_items_to_cancel']) || !empty($requiredChanges['line_items_to_update'])) {
// @todo - this IF is to get this through PR merge but I suspect that it should not
// be necessary & is masking something else.
$financialItemsArray = $lineItemObj->getAdjustedFinancialItemsToRecord(
$entityID,
$entityTable,
$contributionId,
array_keys($requiredChanges['line_items_to_cancel']),
$requiredChanges['line_items_to_update']
);
}
// update line item with changed line total and other information
$totalParticipant = $participantCount = 0;
$amountLevel = [];
if (!empty($requiredChanges['line_items_to_update'])) {
foreach ($requiredChanges['line_items_to_update'] as $priceFieldValueID => $value) {
$amountLevel[] = $value['label'] . ' - ' . (float) $value['qty'];
if ($entity == 'participant' && isset($value['participant_count'])) {
$totalParticipant += $value['participant_count'];
}
}
}
foreach (array_merge($requiredChanges['line_items_to_resurrect'], $requiredChanges['line_items_to_cancel'], $requiredChanges['line_items_to_update']) as $lineItemToAlter) {
// Must use BAO rather than api because a bad line it in the api which we want to avoid.
CRM_Price_BAO_LineItem::create($lineItemToAlter);
}
$lineItemObj->addLineItemOnChangeFeeSelection($requiredChanges['line_items_to_add'], $entityID, $entityTable, $contributionId);
$count = 0;
if ($entity == 'participant') {
$count = count(CRM_Event_BAO_Participant::getParticipantIds($contributionId));
}
else {
$count = CRM_Utils_Array::value('count', civicrm_api3('MembershipPayment', 'getcount', ['contribution_id' => $contributionId]));
}
if ($count > 1) {
$updatedAmount = CRM_Price_BAO_LineItem::getLineTotal($contributionId);
}
$displayParticipantCount = '';
if ($totalParticipant > 0) {
$displayParticipantCount = ' Participant Count -' . $totalParticipant;
}
$updateAmountLevel = NULL;
if (!empty($amountLevel)) {
$updateAmountLevel = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $amountLevel) . $displayParticipantCount . CRM_Core_DAO::VALUE_SEPARATOR;
}
$trxn = $lineItemObj->_recordAdjustedAmt($updatedAmount, $contributionId, $taxAmount, $updateAmountLevel);
$contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_DAO_Contribution', 'contribution_status_id', CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'contribution_status_id'));
if (!empty($financialItemsArray)) {
foreach ($financialItemsArray as $updateFinancialItemInfoValues) {
$newFinancialItem = CRM_Financial_BAO_FinancialItem::create($updateFinancialItemInfoValues);
// record reverse transaction only if Contribution is Completed because for pending refund or
// partially paid we are already recording the surplus owed or refund amount
if (!empty($updateFinancialItemInfoValues['financialTrxn']) && ($contributionStatus == 'Completed')) {
$updateFinancialItemInfoValues = array_merge($updateFinancialItemInfoValues['financialTrxn'], [
'entity_id' => $newFinancialItem->id,
'entity_table' => 'civicrm_financial_item',
]);
$reverseTrxn = CRM_Core_BAO_FinancialTrxn::create($updateFinancialItemInfoValues);
// record reverse entity financial trxn linked to membership's related contribution
civicrm_api3('EntityFinancialTrxn', 'create', [
'entity_table' => "civicrm_contribution",
'entity_id' => $contributionId,
'financial_trxn_id' => $reverseTrxn->id,
'amount' => $reverseTrxn->total_amount,
]);
unset($updateFinancialItemInfoValues['financialTrxn']);
}
elseif ($trxn && $newFinancialItem->amount != 0) {
civicrm_api3('EntityFinancialTrxn', 'create', [
'entity_id' => $newFinancialItem->id,
'entity_table' => 'civicrm_financial_item',
'financial_trxn_id' => $trxn->id,
'amount' => $newFinancialItem->amount,
]);
}
}
}
$lineItemObj->addFinancialItemsOnLineItemsChange(array_merge($requiredChanges['line_items_to_add'], $requiredChanges['line_items_to_resurrect']), $entityID, $entityTable, $contributionId, $trxn->id ?? NULL);
// update participant fee_amount column
$lineItemObj->updateEntityRecordOnChangeFeeSelection($feeAmount, $entityID, $entity);
}
/**
* Function to retrieve financial items that need to be recorded as result of changed fee
*
* @param int $entityID
* @param string $entityTable
* @param int $contributionID
* @param array $priceFieldValueIDsToCancel
* @param array $lineItemsToUpdate
*
* @return array
* List of formatted reverse Financial Items to be recorded
*/
protected function getAdjustedFinancialItemsToRecord($entityID, $entityTable, $contributionID, $priceFieldValueIDsToCancel, $lineItemsToUpdate) {
$previousLineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, str_replace('civicrm_', '', $entityTable));
$financialItemsArray = [];
$financialItemResult = $this->getNonCancelledFinancialItems($entityID, $entityTable);
foreach ($financialItemResult as $updateFinancialItemInfoValues) {
$updateFinancialItemInfoValues['transaction_date'] = date('YmdHis');
// the below params are not needed as we are creating new financial item
$previousFinancialItemID = $updateFinancialItemInfoValues['id'];
$totalFinancialAmount = $this->checkFinancialItemTotalAmountByLineItemID($updateFinancialItemInfoValues['entity_id']);
unset($updateFinancialItemInfoValues['id']);
unset($updateFinancialItemInfoValues['created_date']);
$previousLineItem = $previousLineItems[$updateFinancialItemInfoValues['entity_id']];
// if not submitted and difference is not 0 make it negative
if ((empty($lineItemsToUpdate) || (in_array($updateFinancialItemInfoValues['price_field_value_id'], $priceFieldValueIDsToCancel) &&
$totalFinancialAmount == $updateFinancialItemInfoValues['amount'])
) && $updateFinancialItemInfoValues['amount'] > 0
) {
// INSERT negative financial_items
$updateFinancialItemInfoValues['amount'] = -$updateFinancialItemInfoValues['amount'];
// reverse the related financial trxn too
$updateFinancialItemInfoValues['financialTrxn'] = $this->getRelatedCancelFinancialTrxn($previousFinancialItemID);
if ($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']) {
$updateFinancialItemInfoValues['tax']['amount'] = -($previousLineItem['tax_amount']);
$updateFinancialItemInfoValues['tax']['description'] = $this->getSalesTaxTerm();
}
// INSERT negative financial_items for tax amount
$financialItemsArray[$updateFinancialItemInfoValues['entity_id']] = $updateFinancialItemInfoValues;
}
// INSERT a financial item to record surplus/lesser amount when a text price fee is changed
elseif (
!empty($lineItemsToUpdate)
&& isset($lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']])
&& $lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['html_type'] == 'Text'
&& $updateFinancialItemInfoValues['amount'] > 0
) {
$amountChangeOnTextLineItem = $lineItemsToUpdate[$updateFinancialItemInfoValues['price_field_value_id']]['line_total'] - $totalFinancialAmount;
if ($amountChangeOnTextLineItem !== (float) 0) {
// calculate the amount difference, considered as financial item amount
$updateFinancialItemInfoValues['amount'] = $amountChangeOnTextLineItem;
if ($previousLineItem['tax_amount']
&& $previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount'] !== 0.00) {
$updateFinancialItemInfoValues['tax']['amount'] = $lineItemsToUpdate[$updateFinancialItemInfoValues['entity_id']]['tax_amount'] - $previousLineItem['tax_amount'];
$updateFinancialItemInfoValues['tax']['description'] = $this->getSalesTaxTerm();
}
$financialItemsArray[$updateFinancialItemInfoValues['entity_id']] = $updateFinancialItemInfoValues;
}
}
}
return $financialItemsArray;
}
/**
* Helper function to return sum of financial item's amount related to a line-item
* @param int $lineItemID
*
* @return float $financialItem
*/
protected function checkFinancialItemTotalAmountByLineItemID($lineItemID) {
return CRM_Core_DAO::singleValueQuery("
SELECT SUM(amount)
FROM civicrm_financial_item
WHERE entity_table = 'civicrm_line_item' AND entity_id = {$lineItemID}
");
}
/**
* Helper function to retrieve submitted line items from form values $inputParams and used $feeBlock
*
* @param array $inputParams
* @param array $feeBlock
*
* @return array
* List of submitted line items
*/
protected function getSubmittedLineItems($inputParams, $feeBlock) {
$submittedLineItems = [];
foreach ($feeBlock as $id => $values) {
CRM_Price_BAO_LineItem::format($id, $inputParams, $values, $submittedLineItems);
}
return $submittedLineItems;
}
/**
* Helper function to retrieve line items that need to be altered.
*
* We iterate through the previous line items for the given entity to determine
* what alterations to line items need to be made to reflect the new line items.
*
* There are 4 possible changes required - per the keys in the return array.
*
* @param array $submittedLineItems
* @param int $entityID
* @param string $entity
*
* @return array
* Array of line items to alter with the following keys
* - line_items_to_add. If the line items required are new radio options that
* have not previously been set then we should add line items for them
* - line_items_to_update. If we have already been an active option and a change has
* happened then it should be in this array.
* - line_items_to_cancel. Line items currently selected but not selected in the new selection.
* These need to be zero'd out.
* - line_items_to_resurrect. Line items previously selected and then deselected. These need to be
* re-enabled rather than a new one added.
*/
protected function getLineItemsToAlter($submittedLineItems, $entityID, $entity) {
$previousLineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, $entity);
$lineItemsToAdd = $submittedLineItems;
$lineItemsToUpdate = [];
$submittedPriceFieldValueIDs = array_keys($submittedLineItems);
$lineItemsToCancel = $lineItemsToResurrect = [];
foreach ($previousLineItems as $id => $previousLineItem) {
if (in_array($previousLineItem['price_field_value_id'], $submittedPriceFieldValueIDs)) {
$submittedLineItem = $submittedLineItems[$previousLineItem['price_field_value_id']];
if (($lineItemsToAdd[$previousLineItem['price_field_value_id']]['html_type'] ?? NULL) == 'Text') {
// If a 'Text' price field was updated by changing qty value, then we are not adding new line-item but updating the existing one,
// because unlike other kind of price-field, it's related price-field-value-id isn't changed and thats why we need to make an
// exception here by adding financial item for updated line-item and will reverse any previous financial item entries.
$lineItemsToUpdate[$previousLineItem['price_field_value_id']] = array_merge($submittedLineItem, ['id' => $id]);
unset($lineItemsToAdd[$previousLineItem['price_field_value_id']]);
}
else {
$submittedLineItem = $submittedLineItems[$previousLineItem['price_field_value_id']];
// for updating the line items i.e. use-case - once deselect-option selecting again
if (($previousLineItem['line_total'] != $submittedLineItem['line_total'])
|| (
// This would be a $0 line item - but why it should be catered to
// other than when the above condition is unclear.
$submittedLineItem['line_total'] == 0 && $submittedLineItem['qty'] == 1
)
|| (
$previousLineItem['qty'] != $submittedLineItem['qty']
)
) {
$lineItemsToUpdate[$previousLineItem['price_field_value_id']] = $submittedLineItem;
$lineItemsToUpdate[$previousLineItem['price_field_value_id']]['id'] = $id;
// Format is actually '0.00'
if ($previousLineItem['line_total'] == 0) {
$lineItemsToAdd[$previousLineItem['price_field_value_id']]['id'] = $id;
$lineItemsToResurrect[] = $lineItemsToAdd[$previousLineItem['price_field_value_id']];
}
}
// If there was previously a submitted line item for the same option value then there is
// either no change or a qty adjustment. In either case we are not doing an add + reversal.
unset($lineItemsToAdd[$previousLineItem['price_field_value_id']]);
unset($lineItemsToCancel[$previousLineItem['price_field_value_id']]);
}
}
else {
if (!$this->isCancelled($previousLineItem)) {
$cancelParams = ['qty' => 0, 'line_total' => 0, 'tax_amount' => 0, 'participant_count' => 0, 'non_deductible_amount' => 0, 'id' => $id];
$lineItemsToCancel[$previousLineItem['price_field_value_id']] = array_merge($previousLineItem, $cancelParams);
}
}
}
return [
'line_items_to_add' => $lineItemsToAdd,
'line_items_to_update' => $lineItemsToUpdate,
'line_items_to_cancel' => $lineItemsToCancel,
'line_items_to_resurrect' => $lineItemsToResurrect,
];
}
/**
* Check if a line item has already been cancelled.
*
* @param array $lineItem
*
* @return bool
*/
protected function isCancelled($lineItem) {
if ($lineItem['qty'] == 0 && $lineItem['line_total'] == 0) {
return TRUE;
}
}
/**
* Add line Items as result of fee change.
*
* @param array $lineItemsToAdd
* @param int $entityID
* @param string $entityTable
* @param int $contributionID
*/
protected function addLineItemOnChangeFeeSelection(
$lineItemsToAdd,
$entityID,
$entityTable,
$contributionID
) {
// if there is no line item to add, do not proceed
if (empty($lineItemsToAdd)) {
return;
}
$changedFinancialTypeID = NULL;
$updatedContribution = new CRM_Contribute_BAO_Contribution();
$updatedContribution->id = (int) $contributionID;
// insert financial items
foreach ($lineItemsToAdd as $priceFieldValueID => $lineParams) {
$lineParams = array_merge($lineParams, [
'entity_table' => $entityTable,
'entity_id' => $entityID,
'contribution_id' => $contributionID,
]);
if (!array_key_exists('skip', $lineParams)) {
self::create($lineParams);
}
}
if ($changedFinancialTypeID) {
$updatedContribution->financial_type_id = $changedFinancialTypeID;
$updatedContribution->save();
}
}
/**
* Add financial transactions when an array of line items is changed.
*
* @param array $lineItemsToAdd
* @param int $entityID
* @param string $entityTable
* @param int $contributionID
* @param bool $trxnID
* Is there a change to the total balance requiring additional transactions to be created.
*/
protected function addFinancialItemsOnLineItemsChange($lineItemsToAdd, $entityID, $entityTable, $contributionID, $trxnID) {
$updatedContribution = new CRM_Contribute_BAO_Contribution();
$updatedContribution->id = $contributionID;
$updatedContribution->find(TRUE);
$trxnArray = $trxnID ? ['id' => $trxnID] : NULL;
foreach ($lineItemsToAdd as $priceFieldValueID => $lineParams) {
$lineParams = array_merge($lineParams, [
'entity_table' => $entityTable,
'entity_id' => $entityID,
'contribution_id' => $contributionID,
]);
$lineObj = CRM_Price_BAO_LineItem::retrieve($lineParams);
// insert financial items
// ensure entity_financial_trxn table has a linking of it.
CRM_Financial_BAO_FinancialItem::add($lineObj, $updatedContribution, NULL, $trxnArray);
if (isset($lineObj->tax_amount) && (float) $lineObj->tax_amount !== 0.00) {
CRM_Financial_BAO_FinancialItem::add($lineObj, $updatedContribution, TRUE, $trxnArray);
}
}
}
/**
* Helper function to update entity record on change fee selection
*
* @param int|float $feeAmount
* @param int $entityID
* @param string $entity
*
*/
protected function updateEntityRecordOnChangeFeeSelection($feeAmount, $entityID, $entity) {
$entityTable = "civicrm_{$entity}";
if ($entity == 'participant') {
$partUpdateFeeAmt = ['id' => $entityID];
$getUpdatedLineItems = "SELECT *
FROM civicrm_line_item
WHERE (entity_table = '{$entityTable}' AND entity_id = {$entityID} AND qty > 0)";
$getUpdatedLineItemsDAO = CRM_Core_DAO::executeQuery($getUpdatedLineItems);
$line = [];
while ($getUpdatedLineItemsDAO->fetch()) {
$line[$getUpdatedLineItemsDAO->price_field_value_id] = $getUpdatedLineItemsDAO->label . ' - ' . (float) $getUpdatedLineItemsDAO->qty;
}
$partUpdateFeeAmt['fee_level'] = $line;
$partUpdateFeeAmt['fee_amount'] = $feeAmount;
CRM_Event_BAO_Participant::add($partUpdateFeeAmt);
//activity creation
CRM_Event_BAO_Participant::addActivityForSelection($entityID, 'Change Registration');
}
}
/**
* Get the metadata for a price field.
*
* @param string|int $key
* Price field id. Either as an integer or as 'price_4' where 4 is the id
*
* @return array
* Metadata for the price field with a values key for option values.
*/
protected static function getPriceFieldMetaData($key) {
$priceFieldID = str_replace('price_', '', $key);
if (!isset(Civi::$statics[__CLASS__]['price_fields'][$priceFieldID])) {
$values = civicrm_api3('PriceFieldValue', 'get', [
'price_field_id' => $priceFieldID,
'return' => [
'id',
'amount',
'financial_type_id',
'membership_type_id',
'label',
'price_field_id',
'price_field_id.price_set_id',
'price_field_id.html_type',
'is_enter_qty',
],
]);