-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass-gf-campaignmonitor.php
1564 lines (1203 loc) · 41.8 KB
/
class-gf-campaignmonitor.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
// don't load directly
if ( ! defined( 'ABSPATH' ) ) {
die();
}
GFForms::include_feed_addon_framework();
/**
* Gravity Forms Campaign Monitor Add-On.
*
* @since Unknown
* @package GravityForms
* @author Rocketgenius
* @copyright Copyright (c) 2017, Rocketgenius
*/
class GFCampaignMonitor extends GFFeedAddOn {
/**
* Contains an instance of this class, if available.
*
* @since Unknown
* @access private
* @var object $_instance If available, contains an instance of this class.
*/
private static $_instance = null;
/**
* Defines the version of the Campaign Monitor Add-On.
*
* @since Unknown
* @access protected
* @var string $_version Contains the version, defined from campaignmonitor.php
*/
protected $_version = GF_CAMPAIGN_MONITOR_VERSION;
/**
* Defines the minimum Gravity Forms version required.
*
* @since Unknown
* @access protected
* @var string $_min_gravityforms_version The minimum version required.
*/
protected $_min_gravityforms_version = '2.3';
/**
* Defines the plugin slug.
*
* @since Unknown
* @access protected
* @var string $_slug The slug used for this plugin.
*/
protected $_slug = 'gravityformscampaignmonitor';
/**
* Defines the main plugin file.
*
* @since Unknown
* @access protected
* @var string $_path The path to the main plugin file, relative to the plugins folder.
*/
protected $_path = 'gravityformscampaignmonitor/campaignmonitor.php';
/**
* Defines the full path to this class file.
*
* @since Unknown
* @access protected
* @var string $_full_path The full path.
*/
protected $_full_path = __FILE__;
/**
* Defines the URL where this Add-On can be found.
*
* @since Unknown
* @access protected
* @var string The URL of the Add-On.
*/
protected $_url = 'http://www.gravityforms.com';
/**
* Defines the title of this Add-On.
*
* @since Unknown
* @access protected
* @var string $_title The title of the Add-On.
*/
protected $_title = 'Campaign Monitor Add-On';
/**
* Defines the short title of the Add-On.
*
* @since Unknown
* @access protected
* @var string $_short_title The short title.
*/
protected $_short_title = 'Campaign Monitor';
/**
* Defines if Add-On should use Gravity Forms servers for update data.
*
* @since Unknown
* @access protected
* @var bool
*/
protected $_enable_rg_autoupgrade = true;
/**
* Defines the capability needed to access the Add-On settings page.
*
* @since Unknown
* @access protected
* @var string $_capabilities_settings_page The capability needed to access the Add-On settings page.
*/
protected $_capabilities_settings_page = 'gravityforms_campaignmonitor';
/**
* Defines the capability needed to access the Add-On form settings page.
*
* @since Unknown
* @access protected
* @var string $_capabilities_form_settings The capability needed to access the Add-On form settings page.
*/
protected $_capabilities_form_settings = 'gravityforms_campaignmonitor';
/**
* Defines the capability needed to uninstall the Add-On.
*
* @since Unknown
* @access protected
* @var string $_capabilities_uninstall The capability needed to uninstall the Add-On.
*/
protected $_capabilities_uninstall = 'gravityforms_campaignmonitor_uninstall';
/**
* Defines the capabilities needed for the Campaign Monitor Add-On
*
* @since Unknown
* @access protected
* @var array $_capabilities The capabilities needed for the Add-On
*/
protected $_capabilities = array( 'gravityforms_campaignmonitor', 'gravityforms_campaignmonitor_uninstall' );
/**
* Enabling background feed processing to prevent performance issues delaying form submission completion.
*
* @since 4.0
*
* @var bool
*/
protected $_async_feed_processing = true;
/**
* Contains an instance of the Campaign Monitor API library, if available.
*
* @since 3.5
* @access protected
* @var object $api If available, contains an instance of the Campaign Monitor API library.
*/
public $api = null;
/**
* Get instance of this class.
*
* @since Unknown
* @access public
* @static
*
* @return $_instance
*/
public static function get_instance() {
if ( null === self::$_instance ) {
self::$_instance = new self;
}
return self::$_instance;
}
/**
* Register needed hooks for Add-On.
*
* @since Unknown
* @access public
*/
public function init() {
parent::init();
$this->add_delayed_payment_support(
array(
'option_label' => esc_html__( 'Subscribe user to Campaign Monitor only when payment is received.', 'gravityformscampaignmonitor' )
)
);
}
/**
* Return the plugin's icon for the plugin/form settings menu.
*
* @since 3.9
*
* @return string
*/
public function get_menu_icon() {
return file_get_contents( $this->get_base_path() . '/images/menu-icon.svg' );
}
// # PLUGIN SETTINGS -----------------------------------------------------------------------------------------------
/**
* Prepare plugin settings fields.
*
* @since Unknown
* @access public
*
* @uses GFCampaignMonitor::get_clients_as_choices()
*
* @return array
*/
public function plugin_settings_fields() {
return array(
array(
'title' => esc_html__( 'Campaign Monitor Account Information', 'gravityformscampaignmonitor' ),
'description' => sprintf(
'<p>%s</p>',
sprintf(
esc_html__( 'Campaign Monitor is an email marketing software for designers and their clients. Use Gravity Forms to collect customer information and automatically add it to your client\'s Campaign Monitor subscription list. If you don\'t have a Campaign Monitor account, you can %1$ssign up for one here.%2$s', 'gravityformscampaignmonitor' ),
'<a href="http://www.campaignmonitor.com" target="_blank">',
'</a>'
)
),
'fields' => array(
array(
'name' => 'apiKey',
'label' => esc_html__( 'API Key', 'gravityformscampaignmonitor' ),
'type' => 'text',
'class' => 'medium',
'feedback_callback' => array( $this, 'initialize_api' ),
'description' => esc_html__( "To locate your API key, in your Campaign Monitor account, click on your profile image and then select 'Account settings'. On the Account settings page click 'API keys' and then click 'Show API key'. If you haven't generated one yet, click 'Generate API key' instead.", 'gravityformscampaignmonitor' ),
),
)
),
);
}
// # FEED SETTINGS -------------------------------------------------------------------------------------------------
/**
* Configures the settings which should be rendered on the feed edit page.
*
* @since Unknown
* @access public
*
* @uses GFCampaignMonitor::get_clients_as_choices()
* @uses GFCampaignMonitor::get_custom_fields_as_field_map()
* @uses GFCampaignMonitor::get_lists_as_choices()
* @uses GFCampaignMonitor::is_clients_hidden()
*
* @return array The feed settings.
*/
public function feed_settings_fields() {
return array(
array(
'title' => esc_html__( 'Campaign Monitor Feed', 'gravityformscampaignmonitor' ),
'fields' => array(
array(
'name' => 'feedName',
'label' => esc_html__( 'Name', 'gravityformscampaignmonitor' ),
'type' => 'text',
'required' => true,
'class' => 'medium',
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Name', 'gravityformscampaignmonitor' ),
esc_html__( 'Enter a feed name to uniquely identify this setup.', 'gravityformscampaignmonitor' )
),
),
array(
'name' => 'client',
'label' => esc_html__( 'Client', 'gravityformscampaignmonitor' ),
'type' => 'select',
'onchange' => 'jQuery(this).parents("form").submit();',
'hidden' => $this->is_clients_hidden(),
'choices' => $this->get_clients_as_choices(),
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Client', 'gravityformscampaignmonitor' ),
esc_html__( 'Select the Campaign Monitor client you would like to add your contacts to.', 'gravityformscampaignmonitor' )
),
),
array(
'name' => 'contactList',
'label' => esc_html__( 'Contact List', 'gravityformscampaignmonitor' ),
'type' => 'select',
'required' => true,
'choices' => $this->get_lists_as_choices(),
'onchange' => 'jQuery(this).parents("form").submit();',
'dependency' => array( $this, 'has_selected_client' ),
'no_choices' => sprintf(
esc_html__( 'No clients found. Please configure one or more clients in your %sCampaign Monitor%s account.', 'gravityformscampaignmonitor' ),
'<a href="http://www.campaignmonitor.com" target="_blank">',
'</a>'
),
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Contact List', 'gravityformscampaignmonitor' ),
esc_html__( 'Select the Campaign Monitor list you would like to add your contacts to.', 'gravityformscampaignmonitor' )
),
),
array(
'name' => 'listFields',
'label' => esc_html__( 'Map Fields', 'gravityformscampaignmonitor' ),
'type' => 'field_map',
'dependency' => 'contactList',
'field_map' => $this->get_custom_fields_as_field_map(),
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Map Fields', 'gravityformscampaignmonitor' ),
esc_html__( 'Associate your Campaign Monitor custom fields to the appropriate Gravity Form fields by selecting the appropriate form field from the list.', 'gravityformscampaignmonitor' )
),
),
array(
'name' => 'optin',
'label' => esc_html__( 'Conditional Logic', 'gravityformscampaignmonitor' ),
'type' => 'feed_condition',
'dependency' => 'contactList',
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Conditional Logic', 'gravityformscampaignmonitor' ),
esc_html__( 'When conditional logic is enabled, form submissions will only be exported to Campaign Monitor when the condition is met. When disabled all form submissions will be exported.', 'gravityformscampaignmonitor' )
),
),
array(
'name' => 'resubscribe',
'label' => esc_html__( 'Options', 'gravityformscampaignmonitor' ),
'type' => 'option_resubscribe',
'dependency' => 'contactList',
'onclick' => "if(this.checked){jQuery('#campaignmonitor_resubscribe_warning').slideDown();} else{jQuery('#campaignmonitor_resubscribe_warning').slideUp();}",
),
array(
'type' => 'save',
'dependency' => 'contactList',
),
)
),
);
}
/**
* Check if the clients setting should be displayed.
*
* @since Unknown
* @access public
*
* @uses GFCampaignMonitor::has_multiple_clients()
*
* @return bool
*/
public function is_clients_hidden() {
return ! $this->has_multiple_clients();
}
/**
* Prepare Campaign Monitor custom fields as a field map.
*
* @since 3.5
* @access public
*
* @uses GFAddOn::get_setting()
* @uses GFAddOn::log_error()
* @uses GFCampaignMonitor::initialize_api()
* @uses GF_CampaignMonitor_API::get_custom_fields()
*
* @return array
*/
public function get_custom_fields_as_field_map() {
// Initialize field map.
$field_map = array(
array(
'name' => 'email',
'label' => esc_html__( 'Email Address', 'gravityformscampaignmonitor' ),
'required' => true,
),
array(
'name' => 'fullname',
'label' => esc_html__( 'Full Name', 'gravityformscampaignmonitor' ),
),
);
// If API is not initialized, return.
if ( ! $this->initialize_api() ) {
return $field_map;
}
// Get the list ID.
$list_id = $this->get_setting( 'contactList' );
try {
// Get custom fields.
$custom_fields = $this->api->get_custom_fields( $list_id );
} catch ( \Exception $e ) {
// Log that we could not retrieve custom fields.
$this->log_error( __METHOD__ . '(): Unable to retrieve custom fields; ' . $e->getMessage() );
return $field_map;
}
// Loop through custom fields.
foreach ( $custom_fields as $custom_field ) {
// Prepare custom field key.
$field_key = str_replace( array( '[', ']' ), '', $custom_field['Key'] );
// Add custom field to field map.
$field_map[] = array(
'name' => $field_key,
'label' => esc_html( $custom_field['FieldName'] ),
);
}
return $field_map;
}
/**
* Define the markup for the option_resubscribe type field.
*
* @since Unknown
* @access public
*
* @param array $field The field properties.
* @param bool|true $echo Should the setting markup be echoed.
*
* @uses GFAddOn::get_setting()
* @uses GFAddOn::settings_checkbox()
*
* @return string|void
*/
public function settings_option_resubscribe( $field, $echo = true ) {
// Define field type.
$field['type'] = 'checkbox';
// Prepare field choices.
$field['choices'] = array(
array(
'label' => esc_html__( 'Resubscribe', 'gravityformscampaignmonitor' ),
'name' => 'resubscribe',
),
);
// Display checkbox field.
unset( $field['callback'] );
$html = $this->settings_checkbox( $field, false );
// Prepare field tooltip.
$tooltip_content = sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Resubscribe', 'gravityformscampaignmonitor' ),
esc_html__( 'When this option is enabled, if the subscriber is in an inactive state or has previously been unsubscribed, they will be re-added to the active list. Therefore, this option should be used with caution and only when appropriate.', 'gravityformscampaignmonitor' )
);
// Display tooltip.
$html = str_replace( '</div>', ' ' . gform_tooltip( $tooltip_content, '', true ) . '</div>', $html );
// Display warning.
$html .= sprintf(
'<small><span id="campaignmonitor_resubscribe_warning" style="%s">%s</span></small>',
$this->get_setting( 'resubscribe' ) ? '' : 'display:none',
esc_html__( 'This option will re-subscribe users that have been unsubscribed. Use with caution and only when appropriate.', 'gravityformscampaignmonitor' )
);
if ( $echo ) {
echo $html;
}
return $html;
}
// # FEED LIST -------------------------------------------------------------------------------------------------
/**
* Prevent feeds being listed or created if the api key or client id aren't valid.
*
* @since Unknown
* @access public
*
* @uses GFCampaignMonitor::initialize_api()
*
* @return bool
*/
public function can_create_feed() {
return $this->initialize_api();
}
/**
* Allow the feed to be duplicated.
*
* @since 3.8
*
* @param array|int $id The ID of the feed to be duplicated or the feed object when duplicating a form.
*
* @return bool
*/
public function can_duplicate_feed( $id ) {
return true;
}
/**
* Configures which columns should be displayed on the feed list page.
*
* @since Unknown
* @access public
*
* @return array
*/
public function feed_list_columns() {
return array(
'feedName' => esc_html__( 'Name', 'gravityformscampaignmonitor' ),
'client' => esc_html__( 'Campaign Monitor Client', 'gravityformscampaignmonitor' ),
'contactList' => esc_html__( 'Campaign Monitor List', 'gravityformscampaignmonitor' )
);
}
/**
* Returns the value to be displayed in the client column.
*
* @since Unknown
* @access public
*
* @param array $feed The feed being included in the feed list.
*
* @uses GFAddOn::log_error()
* @uses GFAddOn::get_plugin_settings()
* @uses GFAddOn::get_setting()
* @uses GFCampaignMonitor::initialize_api()
* @uses GF_CampaignMonitor_API::get_client()
*
* @return string
*/
public function get_column_value_client( $feed ) {
// If we cannot initialize the API, return client ID.
if ( ! $this->initialize_api() ) {
return $feed['meta']['client'];
}
// Set client ID to feed client ID.
if ( rgars( $feed, 'meta/client' ) ) {
$client_id = $feed['meta']['client'];
} else {
// Use default client.
$client_id = $this->get_default_client();
}
try {
// Get client.
$client = $this->api->get_client( $client_id );
return esc_html( $client['BasicDetails']['CompanyName'] );
} catch ( \Exception $e ) {
// Log that we could not get the client.
$this->log_error( __METHOD__ . '(): Unable to get client; ' . $e->getMessage() );
return sprintf(
'<strong>%s</strong>',
esc_html__( 'Client could not be found.', 'gravityformscampaignmonitor' )
);
}
}
/**
* Returns the value to be displayed in the contactList column.
*
* @since Unknown
* @access public
*
* @param array $feed The feed being included in the feed list.
*
* @uses GFAddOn::log_error()
* @uses GFCampaignMonitor::initialize_api()
* @uses GF_CampaignMonitor_API::get_list()
*
* @return string
*/
public function get_column_value_contactList( $feed ) {
// If we cannot initialize the API, return list ID.
if ( ! $this->initialize_api() || ! rgars( $feed, 'meta/contactList' ) ) {
return rgars( $feed, 'meta/contactList' );
}
try {
// Get list.
$list = $this->api->get_list( $feed['meta']['contactList'] );
return esc_html( $list['Title'] );
} catch ( \Exception $e ) {
// Log that we could not get the list.
$this->log_error( __METHOD__ . '(): Unable to get list; ' . $e->getMessage() );
return sprintf(
'<strong>%s</strong>',
esc_html__( 'List could not be found.', 'gravityformscampaignmonitor' )
);
}
}
// # FEED PROCESSING -----------------------------------------------------------------------------------------------
/**
* Initiate processing the feed.
*
* @since Unknown
* @access public
*
* @param array $feed The feed object to be processed.
* @param array $entry The entry object currently being processed.
* @param array $form The form object currently being processed.
*
* @uses GFAddOn::get_field_map_fields()
* @uses GFAddOn::get_field_value()
* @uses GFAddOn::log_debug()
* @uses GFCampaignMonitor::initialize_api()
* @uses GF_CampaignMonitor_API::add_subscriber()
* @uses GFCommon::is_invalid_or_empty_email()
* @uses GFFeedAddOn::add_feed_error()
*/
public function process_feed( $feed, $entry, $form ) {
// If API cannot be initialized, exit.
if ( ! $this->initialize_api() ) {
// Log that API could not be initialized.
$this->add_feed_error( esc_html__( 'User could not be subscribed because API could not be initialized.', 'gravityformscampaignmonitor' ), $feed, $entry, $form );
return;
}
// Initialize subscriber object.
$subscriber = array(
'EmailAddress' => $this->get_field_value( $form, $entry, $feed['meta']['listFields_email'] ),
'Name' => $this->get_field_value( $form, $entry, rgars( $feed, 'meta/listFields_fullname' ) ),
'CustomFields' => array(),
'Resubscribe' => rgars( $feed, 'meta/resubscribe' ) ? true : false,
);
// If provided email address is empty or invalid, exit.
if ( GFCommon::is_invalid_or_empty_email( $subscriber['EmailAddress'] ) ) {
// Log that subscriber could not be added.
$this->add_feed_error( esc_html__( 'User could not be subscribed because provided email address was empty or invalid.', 'gravityformscampaignmonitor' ), $feed, $entry, $form );
return;
}
// Get field map.
$field_map = $this->get_field_map_fields( $feed, 'listFields' );
/**
* Modify how Campaign Monitor Add-On handles blank custom fields.
* The default behaviour is to remove custom fields which don't have a value from the CustomFields array so they aren't sent to Campaign Monitor.
*
* @since Unknown
*
* @param bool $override The default is false.
* @param array $entry The Entry which is currently being processed.
* @param array $form The Form which is currently being processed.
* @param array $feed The Feed which is currently being processed.
*/
$override_custom_fields = gf_apply_filters( array( 'gform_campaignmonitor_override_blank_custom_fields', $form['id'], $feed['id'] ), false, $entry, $form, $feed );
// Loop through field map.
foreach ( $field_map as $key => $field_id ) {
// If this is an email or name field, skip it.
if ( in_array( $key, array( 'email', 'fullname' ) ) ) {
continue;
}
// Get field value.
$field_values = $this->get_field_value( $form, $entry, $field_id );
// Convert field value to array.
if ( ! is_array( $field_values ) ) {
$field_values = array( $field_values );
}
// Loop through values and add to subscriber custom fields.
foreach ( $field_values as $field_value ) {
// If we are not overriding custom fields and the field value is blank, skip it.
if ( ! $override_custom_fields && rgblank( $field_value ) ) {
continue;
}
// Add custom field.
$subscriber['CustomFields'][] = array(
'Key' => $key,
'Value' => $field_value,
);
}
}
/**
* Modify the subscriber parameters before they are sent to Campaign Monitor.
*
* @since Unknown
*
* @param array $subscriber An associative array containing all the parameters to be passed to Campaign Monitor.
* @param array $entry The Entry which is currently being processed.
* @param array $form The Form which is currently being processed.
* @param array $feed The Feed which is currently being processed.
*/
$subscriber = gf_apply_filters( 'gform_campaignmonitor_override_subscriber', $form['id'], $subscriber, $entry, $form, $feed );
$this->log_debug( __METHOD__ . '(): Subscriber to be added => ' . print_r( $subscriber, true ) );
try {
// Subscribe user.
$this->api->add_subscriber( $subscriber, rgars( $feed, 'meta/contactList' ) );
// Log that user was subscribed.
$this->log_debug( __METHOD__ . '(): User was subscribed to list.' );
return;
} catch ( \Exception $e ) {
// Log that user could not be subscribed.
$this->add_feed_error( sprintf( esc_html__( 'User could not be subscribed: %s', 'gravityformscampaignmonitor' ), $e->getMessage() ), $feed, $entry, $form );
return;
}
}
/**
* Returns the value of the selected field.
*
* @param array $form The form object currently being processed.
* @param array $entry The entry object currently being processed.
* @param string $field_id The ID of the field being processed.
*
* @return array
*/
public function get_field_value( $form, $entry, $field_id ) {
$field_value = '';
switch ( strtolower( $field_id ) ) {
case 'form_title':
$field_value = rgar( $form, 'title' );
break;
case 'date_created':
$date_created = rgar( $entry, strtolower( $field_id ) );
if ( empty( $date_created ) ) {
//the date created may not yet be populated if this function is called during the validation phase and the entry is not yet created
$field_value = gmdate( 'Y-m-d H:i:s' );
} else {
$field_value = $date_created;
}
break;
case 'ip':
case 'source_url':
$field_value = rgar( $entry, strtolower( $field_id ) );
break;
default:
$field = GFFormsModel::get_field( $form, $field_id );
if ( is_object( $field ) ) {
$is_integer = $field_id == intval( $field_id );
$input_type = RGFormsModel::get_input_type( $field );
if ( $is_integer && $input_type == 'address' ) {
$field_value = $this->get_full_address( $entry, $field_id );
} elseif ( $is_integer && $input_type == 'name' ) {
$field_value = $this->get_full_name( $entry, $field_id );
} elseif ( $is_integer && $input_type == 'checkbox' ) {
$field_value = array();
foreach ( $field->inputs as $input ) {
$index = (string) $input['id'];
$field_value[] = $this->maybe_override_field_value( rgar( $entry, $index ), $form, $entry, $index );
}
} elseif ( $input_type == 'multiselect' ) {
$value = $this->maybe_override_field_value( rgar( $entry, $field_id ), $form, $entry, $field_id );
if ( ! empty( $value ) ) {
/** @var GF_Field_MultiSelect $field */
$field_value = $field->to_array( $value );
}
} elseif ( GFCommon::is_product_field( $field->type ) && $field->enablePrice ) {
$ary = explode( '|', rgar( $entry, $field_id ) );
$field_value = count( $ary ) > 0 ? $ary[0] : '';
} else {
if ( is_callable( array( 'GF_Field', 'get_value_export' ) ) ) {
$field_value = $field->get_value_export( $entry, $field_id );
} else {
$field_value = rgar( $entry, $field_id );
}
}
if ( ! in_array( $input_type, array( 'checkbox', 'multiselect' ) ) ) {
$field_value = $this->maybe_override_field_value( $field_value, $form, $entry, $field_id );
}
} else {
$field_value = $this->maybe_override_field_value( rgar( $entry, $field_id ), $form, $entry, $field_id );
}
}
return $field_value;
}
/**
* Use the legacy gform_campaignmonitor_field_value filter instead of the framework gform_SLUG_field_value filter.
*
* @param string $field_value The field value.
* @param array $form The form object currently being processed.
* @param array $entry The entry object currently being processed.
* @param string $field_id The ID of the field being processed.
*
* @return string
*/
public function maybe_override_field_value( $field_value, $form, $entry, $field_id ) {
return gf_apply_filters( 'gform_campaignmonitor_field_value', array(
$form['id'],
$field_id
), $field_value, $form['id'], $field_id, $entry );
}
// # HELPER METHODS ------------------------------------------------------------------------------------------------
/**
* Initializes Campaign Monitor API if credentials are valid.
*
* @since 3.5
* @access public
*
* @uses GFAddOn::get_plugin_settings()
* @uses GFAddOn::log_debug()
* @uses GFAddOn::log_error()
* @uses GF_CampaignMonitor_API::auth_test()
*
* @return bool|null
*/
public function initialize_api() {
// If API is alredy initialized and license key is not provided, return true.
if ( ! is_null( $this->api ) ) {
return true;
}
// Load the API library.
if ( ! class_exists( 'GF_CampaignMonitor_API' ) ) {
require_once( 'includes/class-gf-campaignmonitor-api.php' );
}
// Get the plugin settings.
$settings = $this->get_plugin_settings();
// If the API key is empty, do not run a validation check.
if ( ! rgar( $settings, 'apiKey' ) ) {
return null;
}
// Log validation step.
$this->log_debug( __METHOD__ . '(): Validating API Info.' );
// Setup a new Fillable PDFs API object with the API credentials.
$api = new GF_CampaignMonitor_API( $settings['apiKey'] );
try {
// Get system date.
$api->auth_test();
// Assign API library to instance.
$this->api = $api;
// Log that authentication test passed.
$this->log_debug( __METHOD__ . '(): API credentials are valid.' );
return true;
} catch ( \Exception $e ) {
// Log that authentication test failed.
$this->log_error( __METHOD__ . '(): API credentials are invalid; '. $e->getMessage() );
return false;
}
}
/**
* Get default Campaign Monitor client ID.
*
* @since 3.5
* @access public
*
* @uses GFAddOn::log_error()
* @uses GFCampaignMonitor::initialize_api()
* @uses GF_CampaignMonitor_API::get_clients()
*
* @return bool|array|string
*/
public function get_default_client( $return_id = true ) {
// If API cannot be initialized, return false.
if ( ! $this->initialize_api() ) {