This repository has been archived by the owner on Sep 14, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 65
/
cividiscount.php
1210 lines (1090 loc) · 40.1 KB
/
cividiscount.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
require_once 'cividiscount.civix.php';
use CRM_CiviDiscount_ExtensionUtil as E;
/**
* Implements hook_civicrm_install().
*/
function cividiscount_civicrm_install() {
_cividiscount_civix_civicrm_install();
}
/**
* Implements hook_civicrm_postInstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
*/
function cividiscount_civicrm_postInstall() {
_cividiscount_civix_civicrm_postInstall();
}
/**
* Implements hook_civicrm_uninstall().
*/
function cividiscount_civicrm_uninstall() {
_cividiscount_civix_civicrm_uninstall();
}
/**
* Implements hook_civicrm_config().
*/
function cividiscount_civicrm_config(&$config) {
_cividiscount_civix_civicrm_config($config);
}
/**
* Implements hook_civicrm_xmlMenu().
*/
function cividiscount_civicrm_xmlMenu(&$files) {
_cividiscount_civix_civicrm_xmlMenu($files);
}
/**
* Implements hook_civicrm_enable().
*/
function cividiscount_civicrm_enable() {
_cividiscount_civix_civicrm_enable();
}
/**
* Implements hook_civicrm_disable().
*/
function cividiscount_civicrm_disable() {
_cividiscount_civix_civicrm_disable();
}
/**
* Implements hook_civicrm_upgrade().
*
* @param $op string, the type of operation being performed; 'check' or 'enqueue'
* @param CRM_Queue_Queue $queue (for 'enqueue') the modifiable list of pending up upgrade tasks
*
* @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
* for 'enqueue', returns void
*/
function cividiscount_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _cividiscount_civix_civicrm_upgrade($op, $queue);
}
/**
* Implements hook_civicrm_managed().
*
* Generate a list of entities to create/deactivate/delete when this module
* is installed, disabled, uninstalled.
*
* @param array $entities
*/
function cividiscount_civicrm_managed(&$entities) {
_cividiscount_civix_civicrm_managed($entities);
}
/**
* Implements hook_civicrm_tabset().
*
* Display a discounts tab listing discount code usage for that contact.
*/
function cividiscount_civicrm_tabset($path, &$tabs, $context) {
if ($path === 'civicrm/contact/view') {
$cid = $context['contact_id'];
if (_cividiscount_is_org($cid)) {
$tabs[] = [
'id' => 'discounts_assigned',
'count' => _cividiscount_get_tracking_count_by_org($cid),
'title' => E::ts('Codes Assigned'),
'weight' => 115,
'icon' => 'crm-i fa-qrcode',
'url' => CRM_Utils_System::url('civicrm/cividiscount/usage', "reset=1&oid={$cid}", FALSE, NULL, FALSE),
];
}
$tabs[] = [
'id' => 'discounts',
'count' => _cividiscount_get_tracking_count($cid),
'title' => E::ts('Codes Redeemed'),
'weight' => 116,
'icon' => 'crm-i fa-qrcode',
'url' => CRM_Utils_System::url('civicrm/cividiscount/usage', "reset=1&cid={$cid}", FALSE, NULL, FALSE),
];
}
}
/**
* Implements hook_civicrm_buildForm().
*
* If the event id of the form being loaded has a discount code, modify
* the form to include the textfield. Only display the textfield on the
* initial registration screen.
*
* Works for events and membership.
*
* @param string $fname
* @param CRM_Contribute_Form_Contribution_Main|CRM_Core_Form $form
* @return bool
*/
function cividiscount_civicrm_buildForm($fname, &$form) {
// skip for delete action
// also skip when content is loaded via ajax, like payment processor, custom data etc
$snippet = CRM_Utils_Request::retrieve('snippet', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'REQUEST');
if ($snippet == 4 || ($form->getVar('_action') && ($form->getVar('_action') & CRM_Core_Action::DELETE))) {
return FALSE;
}
// Display discount textfield for offline membership/events
if (in_array($fname, [
'CRM_Contribute_Form_Contribution',
'CRM_Event_Form_Participant',
'CRM_Member_Form_Membership',
'CRM_Member_BAO_Membership',
'CRM_Member_Form_MembershipRenewal'
])) {
if ($form->getVar('_single') == 1 || in_array($form->getVar('_context'), ['membership', 'standalone'])) {
_cividiscount_add_discount_textfield($form);
$code = trim(CRM_Utils_Request::retrieve('discountcode', 'String', $form, FALSE, NULL, 'REQUEST'));
if ($code) {
$defaults = ['discountcode' => $code];
$form->setDefaults($defaults);
}
}
}
elseif (in_array($fname, [
'CRM_Event_Form_Registration_Register',
//'CRM_Event_Form_Registration_AdditionalParticipant',
'CRM_Contribute_Form_Contribution_Main',
'CRM_Event_Form_ParticipantFeeSelection',
])) {
// Display the discount textfield for online events (including
// pricesets) and memberships.
$ids = $memtypes = [];
$addDiscountField = FALSE;
if (in_array($fname, [
'CRM_Event_Form_Registration_Register',
//'CRM_Event_Form_Registration_AdditionalParticipant'
'CRM_Event_Form_ParticipantFeeSelection',
])) {
$contact_id = _cividiscount_get_form_contact_id($form);
$discountCalculator = new CRM_CiviDiscount_DiscountCalculator('event', $form->getVar('_eventId'), $contact_id, NULL, TRUE);
$addDiscountField = $discountCalculator->isShowDiscountCodeField();
}
elseif ($fname == 'CRM_Contribute_Form_Contribution_Main') {
CRM_Core_Resources::singleton()
->addScriptFile('org.civicrm.module.cividiscount', 'js/main.js');
$ids = _cividiscount_get_discounted_membership_ids();
if (!empty($form->_membershipBlock['membership_types'])) {
$memtypes = explode(',', $form->_membershipBlock['membership_types']);
}
elseif (isset($form->_membershipTypeValues)) {
$memtypes = array_keys($form->_membershipTypeValues);
}
if (count(array_intersect($ids, $memtypes)) > 0) {
$addDiscountField = TRUE;
}
}
if (empty($ids)) {
$ids = _cividiscount_get_discounted_priceset_ids();
if (!empty($ids)) {
if (in_array($form->getVar('_eventId'), $ids)) {
$addDiscountField = TRUE;
}
}
}
// Try to add the textfield. If in a multi-step form, hide the textfield
// but preserve the value for later processing.
if ($addDiscountField) {
_cividiscount_add_discount_textfield($form);
$code = trim(CRM_Utils_Request::retrieve('discountcode', 'String', $form, FALSE, NULL, 'REQUEST'));
if (empty($code) && $fname == 'CRM_Event_Form_ParticipantFeeSelection') {
$code = _cividiscount_get_item_by_track('civicrm_participant', $form->getVar('_participantId'), $contact_id, TRUE);
}
if ($code) {
$defaults = ['discountcode' => $code];
$form->setDefaults($defaults);
}
}
}
}
/**
* Implements hook_civicrm_validateForm().
*
* Used in the initial event registration screen.
*
* @param string $name
* @param array $fields reference
* @param array $files
* @param CRM_Core_Form $form
* @param $errors
*/
function cividiscount_civicrm_validateForm($name, &$fields, &$files, &$form, &$errors) {
if (!in_array($name, [
'CRM_Contribute_Form_Contribution_Main',
'CRM_Event_Form_Participant',
'CRM_Event_Form_Registration_Register',
//'CRM_Event_Form_Registration_AdditionalParticipant',
'CRM_Member_Form_Membership',
'CRM_Member_Form_MembershipRenewal'
])) {
return;
}
// _discountInfo is assigned in cividiscount_civicrm_buildAmount() or
// cividiscount_civicrm_membershipTypeValues() when a discount is used.
$discountInfo = $form->get('_discountInfo');
$code = trim(CRM_Utils_Request::retrieve('discountcode', 'String', $form, FALSE, NULL, 'REQUEST'));
if ((!$discountInfo || !$discountInfo['autodiscount']) && trim($code) != '') {
if (!$discountInfo) {
$errors['discountcode'] = E::ts('The discount code you entered is invalid.');
return;
}
$discount = $discountInfo['discount'];
if ($discount['count_max'] > 0) {
// Initially 1 for person registering.
$apcount = 1;
$sv = $form->getVar('_submitValues');
if (array_key_exists('additional_participants', $sv)) {
$apcount += $sv['additional_participants'];
}
if (($discount['count_use'] + $apcount) > $discount['count_max']) {
$errors['discountcode'] = E::ts('There are not enough uses remaining for this code.');
}
}
}
}
/**
* Implements hook_civicrm_buildAmount().
*
* If the event id of the form being loaded has a discount code, calculate the
* the discount and update the price and label. Apply the initial autodiscount
* based on a users membership.
*
* Check all priceset items and only apply the discount to the discounted items.
*
* @param string $pageType
* @param CRM_Core_Form $form
* @param $amounts
*/
function cividiscount_civicrm_buildAmount($pageType, &$form, &$amounts) {
if ((!$form->getVar('_action')
|| ($form->getVar('_action') & CRM_Core_Action::PREVIEW)
|| ($form->getVar('_action') & CRM_Core_Action::ADD)
|| ($form->getVar('_action') & CRM_Core_Action::UPDATE)
)
&& !empty($amounts) && is_array($amounts) &&
($pageType == 'event' || $pageType == 'membership')) {
if (!$pageType == 'membership' && in_array(get_class($form), [
'CRM_Contribute_Form_Contribution',
'CRM_Contribute_Form_Contribution_Main',
])) {
return;
}
$contact_id = _cividiscount_get_form_contact_id($form);
$autodiscount = FALSE;
$eid = $form->getVar('_eventId');
$psid = $form->get('priceSetId');
$ps = $form->get('priceSet');
$v = $form->getVar('_values');
$code = trim(CRM_Utils_Request::retrieve('discountcode', 'String', $form, FALSE, NULL, 'REQUEST'));
if (!array_key_exists('discountcode', $form->_submitValues)
&& ($pid = $form->getVar('_participantId'))
&& ($form->getVar('_action') & CRM_Core_Action::UPDATE)
) {
$code = _cividiscount_get_item_by_track('civicrm_participant', $pid, $contact_id, TRUE);
}
if (!empty($v['currency'])) {
$currency = $v['currency'];
}
elseif (!empty($v['event']['currency'])) {
$currency = $v['event']['currency'];
}
else {
$currency = CRM_Core_Config::singleton()->defaultCurrency;
}
// If additional participants are not allowed to receive a discount we need
// to interrupt the form processing on build and POST.
// This is a potential landmine if the form processing ever changes in Civi.
if (!_cividiscount_allow_multiple()) {
// POST from participant form to confirm page
if ($form->getVar('_lastParticipant') == 1) {
return;
}
// On build participant form
$keys = array_keys($_GET);
foreach ($keys as $key) {
if (substr($key, 0, 16) == "_qf_Participant_") {
// We can somewhat safely assume we're in the additional participant
// registration form.
// @todo what is the effect of this?
if ($_GET[$key] == 'true') {
return;
}
}
}
}
$form->set('_discountInfo', NULL);
$discountEntity = ($pageType == 'membership') ? 'membership_type' : 'event';
$discountCalculator = new CRM_CiviDiscount_DiscountCalculator($discountEntity, $eid, $contact_id, $code, FALSE);
$discounts = $discountCalculator->getDiscounts();
if (!empty($code) && empty($discounts)) {
$form->set('discountCodeErrorMsg', E::ts('The discount code you entered is invalid.'));
}
// here we check if discount is configured for events or for membership types.
// There are two scenarios:
// 1. Discount is configure for the event or membership type, in that case we should apply discount only
// if default fee / membership type is configured. ( i.e price set with quick config true )
// 2. Discount is configure at price field level, in this case discount should be applied only for
// that particular price set field.
$keys = array_keys($discounts);
$key = array_shift($keys);
// in this case discount is specified for event id or membership type id, so we need to get info of
// associated price set fields. For events discount we already have the list, but for memberships we
// need to filter at membership type level
//retrieve price set field associated with this priceset
$priceSetInfo = CRM_CiviDiscount_Utils::getPriceSetsInfo($psid);
$originalAmounts = $amounts;
foreach ($discounts as $discountID => $discount) {
if (!empty($discountCalculator->autoDiscounts) && array_key_exists($discountID, $discountCalculator->autoDiscounts)) {
$autodiscount = TRUE;
}
else {
$autodiscount = FALSE;
}
$priceFields = isset($discount['pricesets']) ? $discount['pricesets'] : [];
if (empty($priceFields) && (!empty($code) || $autodiscount)) {
// apply discount to all the price fields if no price set set
if ($pageType == 'event') {
$applyToAllLineItems = TRUE;
if (!empty($key)) {
$discounts[$key]['pricesets'] = array_keys($priceSetInfo);
}
}
else {
// filter only valid membership types that have discount
foreach ($priceSetInfo as $pfID => $priceFieldValues) {
if (!empty($priceFieldValues['membership_type_id']) &&
in_array($priceFieldValues['membership_type_id'], CRM_Utils_Array::value('memberships', $discount, []))) {
$priceFields[$pfID] = $pfID;
}
}
}
}
// we should check for MultParticipant AND set Error Messages only if
// this $discount is autodiscount or used discount
if ($autodiscount || (!empty($code) && strcasecmp($code, $discount['code']) == 0)) {
$apcount = _cividiscount_checkEventDiscountMultipleParticipants($pageType, $form, $discount);
}
else {
// silently set FALSE
$apcount = FALSE;
}
if (empty($apcount)) {
//this was set to return but that doesn't make sense as there might be another discount
continue;
}
$discountApplied = FALSE;
if (!empty($autodiscount) || !empty($code)) {
foreach ($amounts as $fee_id => &$fee) {
if (!is_array($fee['options'])) {
continue;
}
foreach ($fee['options'] as $option_id => &$option) {
if (!empty($applyToAllLineItems) || CRM_Utils_Array::value($option['id'], $priceFields)) {
$originalLabel = $originalAmounts[$fee_id]['options'][$option_id]['label'];
$originalAmount = (float) $originalAmounts[$fee_id]['options'][$option_id]['amount'];
list($amount, $label)
= _cividiscount_calc_discount($originalAmount, $originalLabel, $discount, $autodiscount, $currency);
$discountAmount = $originalAmounts[$fee_id]['options'][$option_id]['amount'] - $amount;
if ($discountAmount > CRM_Utils_Array::value('discount_applied', $option)) {
$option['amount'] = $amount;
$option['label'] = $label;
$option['discount_applied'] = $discountAmount;
$option['discount_code'] = $discount['code'];
$option['discount_description'] = $discount['description'];
// Re-calculate VAT/Sales TAX on discounted amount.
if (array_key_exists('tax_amount', $originalAmounts[$fee_id]['options'][$option_id]) &&
array_key_exists('tax_rate', $originalAmounts[$fee_id]['options'][$option_id])) {
$recalculateTaxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($amount, $originalAmounts[$fee_id]['options'][$option_id]['tax_rate']);
if (!empty($recalculateTaxAmount)) {
$option['tax_amount'] = round($recalculateTaxAmount['tax_amount'], 2);
}
}
}
$appliedDiscountID = $discountID;
$discountApplied = TRUE;
}
}
}
}
if ($autodiscount) {
break;
}
}
// Display discount message if one is available
if ($pageType == 'event' && !$autodiscount) {
foreach ($discounts as $code => $discount) {
if (isset($discount['events']) && array_key_exists($eid, $discount['events']) &&
$discount['discount_msg_enabled'] && (!isset($discountApplied) || !$discountApplied) && !empty($discount['autodiscount'])) {
CRM_Core_Session::setStatus(html_entity_decode($discount['discount_msg']), '', 'no-popup');
}
}
}
if (isset($discountApplied) && $discountApplied && !empty($discounts[$appliedDiscountID])) {
if (!empty($ps['fields'])) {
$ps['fields'] = $amounts;
$form->setVar('_priceSet', $ps);
}
$form->set('_discountInfo', [
'discount' => $discounts[$appliedDiscountID],
'autodiscount' => $autodiscount,
'contact_id' => $contact_id,
]);
}
}
}
/**
* We need a extra check to make sure discount is valid for additional participants
* check the max usage and existing usage of discount code.
*
* @param string $pageType
* @param CRM_Core_Form $form
* @param array $discount
* @return bool|int
*/
function _cividiscount_checkEventDiscountMultipleParticipants($pageType, &$form, $discount) {
$apcount = 1;
if ($pageType == 'event' && _cividiscount_allow_multiple()) {
if ($discount['count_max'] > 0) {
// Initially 1 for person registering.
$apcount = 1;
$sv = $form->getVar('_submitValues');
if (array_key_exists('additional_participants', $sv)) {
$apcount += $sv['additional_participants'];
}
if (($discount['count_use'] + $apcount) > $discount['count_max']) {
$form->set('discountCodeErrorMsg', E::ts('There are not enough uses remaining for this code.'));
return FALSE;
}
}
}
return $apcount;
}
function _cividiscount_get_form_contact_id($form) {
if (!empty($form->_pId)) {
$contact_id = $form->_pId;
}
// Look for contact_id in the form.
elseif ($form->getVar('_contactID')) {
$contact_id = $form->getVar('_contactID');
}
// note that contact id variable is not consistent on some forms hence we need this double check :(
// we need to clean up CiviCRM code sometime in future
elseif ($form->getVar('_contactId')) {
$contact_id = $form->getVar('_contactId');
}
// Otherwise look for contact_id in submit values.
elseif (!empty($form->_submitValues['contact_select_id'][1])) {
$contact_id = $form->_submitValues['contact_select_id'][1];
}
// Otherwise use the current logged-in user.
else {
$contact_id = CRM_Core_Session::singleton()->get('userID');
}
//For anonymous user fetch contact ID on basis of checksum
if (empty($contact_id)) {
$cid = CRM_Utils_Request::retrieve('cid', 'Positive', $form);
if (!empty($cid)) {
//check if this is a checksum authentication
$userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $form);
if ($userChecksum) {
//check for anonymous user.
$validUser = CRM_Contact_BAO_Contact_Utils::validChecksum($cid, $userChecksum);
if ($validUser) {
return $cid;
}
}
}
}
return $contact_id;
}
/**
* Implements hook_civicrm_membershipTypeValues().
*
* Allow discounts to be applied to renewing memberships.
*
* @param CRM_Core_Form $form
* @param $membershipTypeValues
*
* @throws \CRM_Core_Exception
*/
function cividiscount_civicrm_membershipTypeValues(&$form, &$membershipTypeValues) {
// Ignore the thank you page.
if ($form->getVar('_name') == 'ThankYou') {
return;
}
// Only discount new or renewal memberships.
if (!($form->getVar('_action') & (CRM_Core_Action::ADD | CRM_Core_Action::RENEW))) {
return;
}
// Retrieve the contact_id depending on submission context.
// Look for contact_id in the form.
if ($form->getVar('_contactID')) {
$contact_id = $form->getVar('_contactID');
}
// Otherwise look for contact_id in submit values.
elseif (!empty($form->_submitValues['contact_select_id'][1])) {
$contact_id = $form->_submitValues['contact_select_id'][1];
}
// Otherwise use the current logged-in user.
else {
$contact_id = CRM_Core_Session::singleton()->get('userID');
}
$form->set('_discountInfo', NULL);
$code = CRM_Utils_Request::retrieve('discountcode', 'String', $form, FALSE, NULL, 'REQUEST');
$discountCalculator = new CRM_CiviDiscount_DiscountCalculator('membership_type', NULL, $contact_id, $code, FALSE);
$discounts = $discountCalculator->getDiscounts();
if (empty($code)) {
$discounts = $discountCalculator->autoDiscounts;
}
if (!empty($code) && empty($discounts)) {
$form->set('discountCodeErrorMsg', E::ts('The discount code you entered is invalid.'));
}
if (empty($discounts)) {
return;
}
if (is_a($form, 'CRM_Member_Form')) {
// Force a refresh via js once loaded to update 'total_amount'
CRM_Core_Resources::singleton()
->addScriptFile('org.civicrm.module.cividiscount', 'js/membership.js');
}
$discount = array_shift($discounts);
foreach ($membershipTypeValues as &$values) {
if (!empty($discount['memberships']) && CRM_Utils_Array::value($values['id'], $discount['memberships'])) {
[$value, $label] = _cividiscount_calc_discount($values['minimum_fee'], $values['name'], $discount, $discountCalculator->isAutoDiscount());
$values['minimum_fee'] = $value;
$values['name'] = $label;
}
}
$form->set('_discountInfo', [
'discount' => $discount,
'autodiscount' => $discountCalculator->isAutoDiscount(),
'contact_id' => $contact_id,
]);
}
/**
* Implements hook_civicrm_postProcess().
*
* Record information about a discount use.
*/
function cividiscount_civicrm_postProcess($class, &$form) {
if (!in_array($class, [
'CRM_Contribute_Form_Contribution_Confirm',
'CRM_Event_Form_Participant',
'CRM_Event_Form_Registration_Confirm',
'CRM_Member_Form_Membership',
'CRM_Member_Form_MembershipRenewal',
'CRM_Event_Form_ParticipantFeeSelection'
])) {
return;
}
static $done = FALSE;
$discountInfo = $form->get('_discountInfo');
if (!$discountInfo || $done) {
return;
}
$done = TRUE;
$discount = $discountInfo['discount'];
$params = $form->getVar('_params');
$discountParams = [
'item_id' => $discount['id'],
'description' => CRM_Utils_Array::value('amount_level', $params) . " " . CRM_Utils_Array::value('description', $params),
'contribution_id' => CRM_Utils_Array::value('contributionID', $params),
];
// Online event registration.
// Note that CRM_Event_Form_Registration_Register is an intermediate form.
// CRM_Event_Form_Registration_Confirm completes the transaction.
if ($class == 'CRM_Event_Form_Registration_Confirm') {
_cividiscount_consume_discount_code_for_online_event($form->getVar('_participantIDS'), $discountParams);
}
elseif ($class == 'CRM_Contribute_Form_Contribution_Confirm') {
// Note that CRM_Contribute_Form_Contribution_Main is an intermediate form.
// CRM_Contribute_Form_Contribution_Confirm completes the transaction.
_cividiscount_consume_discount_code_for_online_contribution($params, $discountParams, $discount['memberships']);
}
else {
$contribution_id = NULL;
// Offline event registration.
if (in_array($class, ['CRM_Event_Form_Participant', 'CRM_Event_Form_ParticipantFeeSelection'])) {
if ($class == 'CRM_Event_Form_ParticipantFeeSelection') {
$discountParams['entity_id'] = $entity_id = $form->getVar('_participantId');
}
else {
$discountParams['entity_id'] = $entity_id = $form->getVar('_id');
}
$participant_payment = _cividiscount_get_participant_payment($entity_id);
$discountParams['contribution_id'] = $participant_payment['contribution_id'];
$discountParams['entity_table'] = 'civicrm_participant';
$participant = _cividiscount_get_participant($entity_id);
$discountParams['contact_id'] = $participant['contact_id'];
}
// Offline membership.
elseif (in_array($class, ['CRM_Member_Form_Membership', 'CRM_Member_Form_MembershipRenewal'])) {
// @todo check whether this uses price sets in submit & hence can use same
// code as the online section and test whether code is decremented when a price set is used.
$membership_types = $form->getVar('_memTypeSelected');
$membership_type = isset($membership_types[0]) ? $membership_types[0] : NULL;
if (!$membership_type) {
$membership_type = $form->getVar('_memType');
}
// Check to make sure the discount actually applied to this membership.
if (!CRM_Utils_Array::value($membership_type, $discount['memberships'])) {
return;
}
$discountParams['entity_table'] = 'civicrm_membership';
$discountParams['entity_id'] = $entity_id = $form->getVar('_id');
$membership_payment = _cividiscount_get_membership_payment($entity_id);
$discountParams['contribution_id'] = $membership_payment['contribution_id'];
$membership = _cividiscount_get_membership($entity_id);
$discountParams['contact_id'] = $membership['contact_id'];
}
else {
$discountParams['entity_table'] = 'civicrm_contribution';
$discountParams['entity_id'] = $contribution_id;
}
civicrm_api3('DiscountTrack', 'create', $discountParams);
}
}
/**
* Record discount code usage from online contribution page.
*
* Currently (for historical reasons) only membership line items are supported
* for discounts.
*
* @param array $params
* Form Parameters. Only the price_x fields are relevant
* @param array $discountParams
* Already determined discount parameters for recording tracking code.
* @param array $discountedMemberships
* Membership types eligible for discount.
*
* @throws \CiviCRM_API3_Exception
*/
function _cividiscount_consume_discount_code_for_online_contribution($params, $discountParams, $discountedMemberships) {
$membership_types = _cividiscount_extract_memberships_from_line_items($params);
$membershipId = $params['membershipID'];
$discount_membership_matches = array_intersect($membership_types, $discountedMemberships);
// Check to make sure the discount actually applied to this membership.
if (empty($discount_membership_matches) || !$membershipId) {
return;
}
$membership = _cividiscount_get_membership($membershipId);
$discountParams['contact_id'] = $membership['contact_id'];
$discountParams['entity_table'] = 'civicrm_membership';
$discountParams['entity_id'] = $membershipId;
civicrm_api3('DiscountTrack', 'create', $discountParams);
}
/**
* Determine which membership(s) are purchased in this transaction.
*
* Note that independent of whether a price set is configured through the UI
* the post hook will receive price set lines so we only worry about what is
* presented via the price set.
*
* @param array $params
* Parameters from form. We are only interested in price_x fields
*
* @return array
* Membership types that have been purchased.
*/
function _cividiscount_extract_memberships_from_line_items($params) {
$membershipTypes = [];
foreach ($params as $key => $value) {
// We are looking for fields like 'price_4'. The is_numeric is to eliminate the
// possibility of fields like 'price_set' being caught.
if (substr($key, 0, 6) == 'price_' && is_numeric(substr($key, 6, 1))) {
$priceFieldID = substr($key, 6);
$priceFieldType = civicrm_api3('price_field', 'getvalue', [
'id' => $priceFieldID,
'return' => 'html_type',
]);
if ($priceFieldType == 'Text') {
// As of 4.6 membership text fields are not supported.
continue;
}
$values = civicrm_api3('price_field_value', 'get', [
'price_field_id' => $priceFieldID,
'return' => 'membership_type_id',
]);
$membershipTypes[] = $values['values'][$params['price_' . $priceFieldID]]['membership_type_id'];
}
}
return $membershipTypes;
}
/**
* Record discount code usage for online event.
*
* This is different to other related functions in that there can be more than 1.
*
* @param array $participant_ids
* @param array $discountParams
*
* @throws \CiviCRM_API3_Exception
*/
function _cividiscount_consume_discount_code_for_online_event($participant_ids, $discountParams) {
// if multiple participant discount is not enabled then only use primary participant info for discount
// and ignore additional participants
if (!_cividiscount_allow_multiple()) {
$participant_ids = [$participant_ids[0]];
}
foreach ($participant_ids as $participant_id) {
$participant = _cividiscount_get_participant($participant_id);
$participant_payment = _cividiscount_get_participant_payment($participant_id);
$discountParams['contact_id'] = $participant['contact_id'];
$discountParams['contribution_id'] = $participant_payment['contribution_id'];
$discountParams['entity_table'] = 'civicrm_participant';
$discountParams['entity_id'] = $participant_id;
civicrm_api3('DiscountTrack', 'create', $discountParams);
}
}
/**
* For participant and member delete, decrement the code usage value since
* they are no longer using the code.
* When a contact is deleted, we should also delete their tracking info/usage.
* When removing participant (and additional) from events, also delete their tracking info/usage.
*/
function cividiscount_civicrm_pre($op, $name, $id, &$obj) {
if ($op == 'delete') {
if (in_array($name, ['Individual', 'Household', 'Organization'])) {
$result = _cividiscount_get_item_by_track(NULL, NULL, $id);
}
elseif ($name == 'Participant') {
if (($result = _cividiscount_get_participant($id)) && ($contactid = $result['contact_id'])) {
$result = _cividiscount_get_item_by_track('civicrm_participant', $id, $contactid);
}
}
elseif ($name == 'Membership') {
if (($result = _cividiscount_get_membership($id)) && ($contactid = $result['contact_id'])) {
$result = _cividiscount_get_item_by_track('civicrm_membership', $id, $contactid);
}
}
else {
return FALSE;
}
if (!empty($result)) {
foreach ($result as $value) {
if (!empty($value['item_id'])) {
CRM_CiviDiscount_BAO_Item::decrementUsage($value['item_id']);
}
if (!empty($value['id'])) {
CRM_CiviDiscount_BAO_Track::del($value['id']);
}
}
}
}
}
/**
* Returns an array of all discount codes.
*/
function _cividiscount_get_discounts() {
return CRM_CiviDiscount_BAO_Item::getValidDiscounts();
}
/**
* Returns all items within the field specified by 'key' for all discounts.
*/
function _cividiscount_get_items_from_discounts($discounts, $key, $include_autodiscount = FALSE) {
$items = [];
foreach ($discounts as $discount) {
if ($include_autodiscount || empty($discount['autodiscount'])) {
foreach ($discount[$key] as $v) {
$items[$v] = $v;
}
}
}
return $items;
}
/**
* Returns an array of all discountable priceset ids.
*/
function _cividiscount_get_discounted_priceset_ids() {
return _cividiscount_get_items_from_discounts(_cividiscount_get_discounts(), 'pricesets');
}
/**
* Returns an array of all discountable membership ids.
*/
function _cividiscount_get_discounted_membership_ids() {
return _cividiscount_get_items_from_discounts(_cividiscount_get_discounts(), 'memberships');
}
/**
* Calculate either a monetary or percentage discount.
*/
function _cividiscount_calc_discount($amount, $label, $discount, $autodiscount, $currency = 'USD') {
$title = $autodiscount ? E::ts('Includes automatic member discount of') : E::ts('Includes applied discount');
if ($discount['amount_type'] == '2') {
$newamount = CRM_Utils_Rule::cleanMoney($amount) - CRM_Utils_Rule::cleanMoney($discount['amount']);
$fmt_discount = CRM_Utils_Money::format($discount['amount'], $currency);
$newlabel = $label . " ({$title}: {$fmt_discount} {$discount['description']})";
}
else {
$newamount = $amount - ($amount * ($discount['amount'] / 100));
$newlabel = $label . " ({$title}: {$discount['amount']}% {$discount['description']})";
}
$newamount = round($newamount, 2);
// Return a formatted string for zero amount.
// @see http://issues.civicrm.org/jira/browse/CRM-12278
if ($newamount <= 0) {
$newamount = '0.00';
}
return [$newamount, $newlabel];
}
/**
* Returns TRUE if the code is not case sensitive.
*
* TODO: Add settings for admin to set this.
*/
function _cividiscount_ignore_case() {
return TRUE;
}
/**
* Returns TRUE if the code should allow multiple participants.
*
* TODO: Add settings for admin to set this.
*/
function _cividiscount_allow_multiple() {
return TRUE;
}
function _cividiscount_get_tracking_count($cid) {
$sql = "SELECT count(id) as count FROM cividiscount_track WHERE contact_id = $cid";
$count = CRM_Core_DAO::singleValueQuery($sql, []);
return $count;
}
function _cividiscount_get_tracking_count_by_org($cid) {
$sql = "SELECT count(id) as count FROM cividiscount_item WHERE organization_id = $cid";
$count = CRM_Core_DAO::singleValueQuery($sql, []);
return $count;
}
function _cividiscount_get_item_by_track($table, $eid, $cid, $returnCode = FALSE) {
$entityTableClause = "entity_table IN ('civicrm_membership','civicrm_participant')";
if (!empty($eid) && !empty($table)) {
$entityTableClause = "entity_table = '{$table}' AND entity_id = {$eid}";
}
$sql = "SELECT cdt.id as id, item_id, code
FROM cividiscount_track cdt
LEFT JOIN cividiscount_item cdi ON cdt.item_id = cdi.id
WHERE {$entityTableClause} AND contact_id = $cid";
$dao = CRM_Core_DAO::executeQuery($sql, []);
$discountEntries = [];
while ($dao->fetch()) {
if ($returnCode) {
return $dao->code;
}
$discountEntries[] = ['id' => $dao->id, 'item_id' => $dao->item_id];
}
return $discountEntries;
}
/**
* Returns TRUE if contact type is an organization
*/
function _cividiscount_is_org($cid) {
$sql = "SELECT contact_type FROM civicrm_contact WHERE id = $cid";
$dao =& CRM_Core_DAO::executeQuery($sql, []);
while ($dao->fetch()) {
if ($dao->contact_type == "Organization") {
return TRUE;
}
}
return FALSE;
}
function _cividiscount_get_membership($mid = 0) {
$result = civicrm_api('Membership', 'get', ['version' => '3', 'membership_id' => $mid]);
if ($result['is_error'] == 0) {
return array_shift($result['values']);
}
return FALSE;
}
/**
* Get Membership Payment record.
*
* @param int $mid
*
* @return bool|mixed
*/
function _cividiscount_get_membership_payment($mid = 0) {
$result = civicrm_api('MembershipPayment', 'get', ['version' => '3', 'membership_id' => $mid]);
if ($result['is_error'] == 0) {
return array_shift($result['values']);