forked from wp-premium/gravityforms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclass-gf-feed-addon.php
More file actions
1266 lines (965 loc) · 38.6 KB
/
Copy pathclass-gf-feed-addon.php
File metadata and controls
1266 lines (965 loc) · 38.6 KB
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
if ( ! class_exists( 'GFForms' ) ) {
die();
}
/**
* Specialist Add-On class designed for use by Add-Ons that require form feed settings
* on the form settings tab.
*
* @package GFFeedAddOn
*/
require_once( 'class-gf-addon.php' );
abstract class GFFeedAddOn extends GFAddOn {
protected $_multiple_feeds = true;
/**
* If true, only first matching feed will be processed.
* @var bool
*/
protected $_single_feed_submission = false;
/**
* If $_single_feed_submission is true, $_single_submission_feed will store the current single submission feed as stored by the get_single_submission_feed() method.
* @var bool
*/
protected $_single_submission_feed = false;
/**
* @var string Version number of the Add-On Framework
*/
private $_feed_version = '0.11';
private $_feed_settings_fields = array();
private $_current_feed_id = false;
public function init() {
parent::init();
add_filter( 'gform_entry_post_save', array( $this, 'maybe_process_feed' ), 10, 2 );
}
public function init_ajax() {
parent::init_ajax();
add_action( "wp_ajax_gf_feed_is_active_{$this->_slug}", array( $this, 'ajax_toggle_is_active' ) );
}
protected function setup() {
global $wpdb;
$table_name = $wpdb->prefix . 'gf_addon_feed';
//upgrading Feed Add-On base class
$installed_version = get_option( 'gravityformsaddon_feed-base_version' );
if ( $installed_version != $this->_feed_version || ! $this->table_exists( $table_name ) ) {
$this->upgrade_base( $installed_version );
update_option( 'gravityformsaddon_feed-base_version', $this->_feed_version );
}
parent::setup();
}
private function upgrade_base( $previous_version ) {
global $wpdb;
require_once( ABSPATH . '/wp-admin/includes/upgrade.php' );
if ( ! empty( $wpdb->charset ) ) {
$charset_collate = "DEFAULT CHARACTER SET $wpdb->charset";
}
if ( ! empty( $wpdb->collate ) ) {
$charset_collate .= " COLLATE $wpdb->collate";
}
$sql = "CREATE TABLE {$wpdb->prefix}gf_addon_feed (
id mediumint(8) unsigned not null auto_increment,
form_id mediumint(8) unsigned not null,
is_active tinyint(1) not null default 1,
meta longtext,
addon_slug varchar(50),
PRIMARY KEY (id),
KEY addon_form (addon_slug,form_id)
) $charset_collate;";
//Fixes issue with dbDelta lower-casing table names, which cause problems on case sensitive DB servers.
add_filter( 'dbdelta_create_queries', array( 'RGForms', 'dbdelta_fix_case' ) );
dbDelta( $sql );
remove_filter( 'dbdelta_create_queries', array( 'RGForms', 'dbdelta_fix_case' ) );
}
public function scripts() {
$scripts = array(
array(
'handle' => 'gform_form_admin',
'enqueue' => array( array( 'admin_page' => array( 'form_settings' ) ) )
),
array(
'handle' => 'gform_gravityforms',
'enqueue' => array( array( 'admin_page' => array( 'form_settings' ) ) )
),
array(
'handle' => 'gform_forms',
'enqueue' => array( array( 'admin_page' => array( 'form_settings' ) ) )
),
array(
'handle' => 'json2',
'enqueue' => array( array( 'admin_page' => array( 'form_settings' ) ) )
),
array(
'handle' => 'gform_placeholder',
'enqueue' => array(
array(
'admin_page' => array( 'form_settings' ),
'field_types' => array( 'feed_condition' )
),
)
),
);
return array_merge( parent::scripts(), $scripts );
}
protected function uninstall() {
global $wpdb;
$sql = $wpdb->prepare( "DELETE FROM {$wpdb->prefix}gf_addon_feed WHERE addon_slug=%s", $this->_slug );
$wpdb->query( $sql );
}
//-------- Front-end methods ---------------------------
public function maybe_process_feed( $entry, $form ) {
$feeds = false;
//Getting all feeds for current add-on
if ( $this->_single_feed_submission ) {
$feed = $this->get_single_submission_feed( $entry, $form );
if ( $feed ) {
$feeds = array( $feed );
}
} else {
$feeds = $this->get_feeds( $form['id'] );
}
if ( empty( $feeds ) ) {
//no feeds to process
return $entry;
}
if ( $entry['status'] == 'spam' ) {
$this->log_debug( 'GFFeedAddOn::maybe_process_feed(): Entry #' . $entry['id'] . ' is marked as spam.' );
return $entry;
}
$is_delayed = false;
if ( class_exists( 'GFPayPal' ) ) {
//get paypal feed to pass for delay check, must be done per add-on
$paypal_feeds = $this->get_feeds_by_slug( 'gravityformspaypal', $form['id'] );
$active_paypal_feed = '';
//loop through paypal feeds to get active one for this form submission, needed to see if add-on processing should be delayed
foreach ( $paypal_feeds as $paypal_feed ) {
if ( $paypal_feed['is_active'] && $this->is_feed_condition_met( $paypal_feed, $form, $entry ) ) {
$active_paypal_feed = $paypal_feed;
break;
}
}
if ( ! empty( $active_paypal_feed ) && $this->is_delayed( $active_paypal_feed ) && $this->has_paypal_payment( $active_paypal_feed, $form, $entry ) ) {
$this->log_debug( 'GFFeedAddOn::maybe_process_feed(): Feed processing is delayed pending payment, not processing feed for entry #' . $entry['id'] . ' for ' . $this->_slug );
$is_delayed = true;
}
}
//Processing feeds
$processed_feeds = array();
foreach ( $feeds as $feed ) {
$feed_name = rgempty( 'feed_name', $feed['meta'] ) ? rgar( $feed['meta'], 'feedName' ) : rgar( $feed['meta'], 'feed_name' );
if ( ! $feed['is_active'] ) {
$this->log_debug( "GFFeedAddOn::maybe_process_feed(): Feed is inactive, not processing feed (#{$feed['id']} - {$feed_name}) for entry #{$entry['id']} for {$this->_slug}" );
continue;
}
if ( ! $this->is_feed_condition_met( $feed, $form, $entry ) ) {
$this->log_debug( "GFFeedAddOn::maybe_process_feed(): Feed condition not met, not processing feed (#{$feed['id']} - {$feed_name}) for entry #{$entry['id']} for {$this->_slug}" );
continue;
}
$processed_feeds[] = $feed['id'];
//process feed if not delayed
if ( ! $is_delayed ) {
//all requirements met, process feed
$this->log_debug( "GFFeedAddOn::maybe_process_feed(): Starting to process feed (#{$feed['id']} - {$feed_name}) for entry #{$entry['id']} for {$this->_slug}" );
$this->process_feed( $feed, $entry, $form );
//should the add-on fulfill be done here????
$this->log_debug( 'GFFeedAddOn::maybe_process_feed(): Marking entry #' . $entry['id'] . ' as fulfilled for ' . $this->_slug );
gform_update_meta( $entry['id'], "{$this->_slug}_is_fulfilled", true );
} else {
$this->delay_feed( $feed, $entry, $form );
}
}
//Saving processed feeds
if ( ! empty( $processed_feeds ) ) {
$meta = gform_get_meta( $entry['id'], 'processed_feeds' );
if ( empty( $meta ) ) {
$meta = array();
}
$meta[ $this->_slug ] = $processed_feeds;
gform_update_meta( $entry['id'], 'processed_feeds', $meta );
}
return $entry;
}
public function is_delayed( $paypal_feed ) {
//look for delay in paypal feed specific to add-on
$delay = rgar( $paypal_feed['meta'], 'delay_' . $this->_slug );
return $delay;
}
public function process_feed( $feed, $entry, $form ) {
return;
}
public function delay_feed( $feed, $entry, $form ) {
return;
}
public function is_feed_condition_met( $feed, $form, $entry ) {
$feed_meta = $feed['meta'];
$is_condition_enabled = rgar( $feed_meta, 'feed_condition_conditional_logic' ) == true;
$logic = rgars( $feed_meta, 'feed_condition_conditional_logic_object/conditionalLogic' );
if ( ! $is_condition_enabled || empty( $logic ) ) {
return true;
}
return GFCommon::evaluate_conditional_logic( $logic, $form, $entry );
}
public function get_paypal_feed( $form_id, $entry ) {
if ( ! class_exists( 'GFPayPal' ) ) {
return false;
}
if ( method_exists( 'GFPayPal', 'get_config_by_entry' ) ) {
$feed = GFPayPal::get_config_by_entry( $entry );
} elseif ( method_exists( 'GFPayPal', 'get_config' ) ) {
$feed = GFPayPal::get_config( $form_id );
} else {
$feed = false;
}
return $feed;
}
public function has_paypal_payment( $feed, $form, $entry ) {
$products = GFCommon::get_product_fields( $form, $entry );
$payment_field = $feed['meta']['transactionType'] == 'product' ? $feed['meta']['paymentAmount'] : $feed['meta']['recurringAmount'];
$setup_fee_field = rgar( $feed['meta'], 'setupFee_enabled' ) ? $feed['meta']['setupFee_product'] : false;
$trial_field = rgar( $feed['meta'], 'trial_enabled' ) ? rgars( $feed, 'meta/trial_product' ) : false;
$amount = 0;
$line_items = array();
$discounts = array();
$fee_amount = 0;
$trial_amount = 0;
foreach ( $products['products'] as $field_id => $product ) {
$quantity = $product['quantity'] ? $product['quantity'] : 1;
$product_price = GFCommon::to_number( $product['price'] );
$options = array();
if ( is_array( rgar( $product, 'options' ) ) ) {
foreach ( $product['options'] as $option ) {
$options[] = $option['option_name'];
$product_price += $option['price'];
}
}
$is_trial_or_setup_fee = false;
if ( ! empty( $trial_field ) && $trial_field == $field_id ) {
$trial_amount = $product_price * $quantity;
$is_trial_or_setup_fee = true;
} elseif ( ! empty( $setup_fee_field ) && $setup_fee_field == $field_id ) {
$fee_amount = $product_price * $quantity;
$is_trial_or_setup_fee = true;
}
//Do not add to line items if the payment field selected in the feed is not the current field.
if ( is_numeric( $payment_field ) && $payment_field != $field_id ) {
continue;
}
//Do not add to line items if the payment field is set to "Form Total" and the current field was used for trial or setup fee.
if ( $is_trial_or_setup_fee && ! is_numeric( $payment_field ) ) {
continue;
}
$amount += $product_price * $quantity;
}
if ( ! empty( $products['shipping']['name'] ) && ! is_numeric( $payment_field ) ) {
$line_items[] = array( 'id' => '', 'name' => $products['shipping']['name'], 'description' => '', 'quantity' => 1, 'unit_price' => GFCommon::to_number( $products['shipping']['price'] ), 'is_shipping' => 1 );
$amount += $products['shipping']['price'];
}
return $amount > 0;
}
//-------- Feed data methods -------------------------
public function get_feeds( $form_id = null ) {
global $wpdb;
$form_filter = is_numeric( $form_id ) ? $wpdb->prepare( 'AND form_id=%d', absint( $form_id ) ) : '';
$sql = $wpdb->prepare(
"SELECT * FROM {$wpdb->prefix}gf_addon_feed
WHERE addon_slug=%s {$form_filter}", $this->_slug
);
$results = $wpdb->get_results( $sql, ARRAY_A );
foreach ( $results as &$result ) {
$result['meta'] = json_decode( $result['meta'], true );
}
return $results;
}
public function get_feeds_by_slug ( $slug, $form_id = null ) {
global $wpdb;
$form_filter = is_numeric( $form_id ) ? $wpdb->prepare( 'AND form_id=%d', absint( $form_id ) ) : '';
$sql = $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}gf_addon_feed
WHERE addon_slug=%s {$form_filter}", $slug );
$results = $wpdb->get_results( $sql, ARRAY_A );
foreach( $results as &$result ) {
$result['meta'] = json_decode( $result['meta'], true );
}
return $results;
}
public function get_current_feed() {
$feed_id = $this->get_current_feed_id();
return empty( $feed_id ) ? false : $this->get_feed( $feed_id );
}
public function get_current_feed_id() {
if ( $this->_current_feed_id ) {
return $this->_current_feed_id;
} elseif ( ! rgempty( 'gf_feed_id' ) ) {
return rgpost( 'gf_feed_id' );
} else {
return rgget( 'fid' );
}
}
public function get_feed( $id ) {
global $wpdb;
$sql = $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}gf_addon_feed WHERE id=%d", $id );
$row = $wpdb->get_row( $sql, ARRAY_A );
if ( ! $row ) {
return false;
}
$row['meta'] = json_decode( $row['meta'], true );
return $row;
}
public function get_feeds_by_entry( $entry_id ) {
$processed_feeds = gform_get_meta( $entry_id, 'processed_feeds' );
if ( ! $processed_feeds ) {
return false;
}
return rgar( $processed_feeds, $this->_slug );
}
public function get_default_feed_name(){
//query db to look for two formats that the feed name could have been auto-generated with
//format from migration to add-on framework: 'Feed ' . $counter
//new auto-generated format when adding new feed: $short_title . ' Feed ' . $counter
$counter_to_use = 0; //set to zero unless a new number is found while checking existing feed names (will be incremented by 1 at the end)
//$feeds_to_filter = GFFeedAddOn::get_feeds_by_slug( $this->_slug );
$feeds_to_filter = $this->get_feeds_by_slug( $this->_slug );
if ( $feeds_to_filter ){
//loop through and look for name pattern to find what to make default feed name
foreach ( $feeds_to_filter as $check ){
$name = rgar( $check['meta'], 'feed_name' ) ? trim( $check['meta']['feed_name'] ) : trim( $check['meta']['feedName'] );
$pattern = '/(^Feed|^' . $this->_short_title . ' Feed)\s\d+/';
preg_match( $pattern,$name,$matches );
if ( $matches ){
//number should be characters at the end after a space
$last_space = strrpos( $matches[0],' ' );
$digit = substr( $matches[0],$last_space );
if ( $digit >= $counter_to_use ){
//counter in existing feed name greater, use it instead
$counter_to_use = $digit;
}
}
}
}
//set default feed name
$value = $this->_short_title . ' Feed ' . ($counter_to_use + 1);
return $value;
}
public function update_feed_meta( $id, $meta ) {
global $wpdb;
$meta = json_encode( $meta );
$wpdb->update( "{$wpdb->prefix}gf_addon_feed", array( 'meta' => $meta ), array( 'id' => $id ), array( '%s' ), array( '%d' ) );
return $wpdb->rows_affected > 0;
}
public function update_feed_active( $id, $is_active ) {
global $wpdb;
$is_active = $is_active ? '1' : '0';
$wpdb->update( "{$wpdb->prefix}gf_addon_feed", array( 'is_active' => $is_active ), array( 'id' => $id ), array( '%d' ), array( '%d' ) );
return $wpdb->rows_affected > 0;
}
public function insert_feed( $form_id, $is_active, $meta ) {
global $wpdb;
$meta = json_encode( $meta );
$wpdb->insert( "{$wpdb->prefix}gf_addon_feed", array( 'addon_slug' => $this->_slug, 'form_id' => $form_id, 'is_active' => $is_active, 'meta' => $meta ), array( '%s', '%d', '%d', '%s' ) );
return $wpdb->insert_id;
}
public function delete_feed( $id ) {
global $wpdb;
$wpdb->delete( "{$wpdb->prefix}gf_addon_feed", array( 'id' => $id ), array( '%d' ) );
}
public function delete_feeds( $form_id = null ) {
global $wpdb;
$where = is_numeric( $form_id ) ? array( 'addon_slug' => $this->_slug, 'form_id' => $form_id ) : array( 'addon_slug' => $this->_slug );
$format = is_numeric( $form_id ) ? array( '%s', '%d' ) : array( '%s' );
$wpdb->delete( "{$wpdb->prefix}gf_addon_feed", $where, $format );
}
//---------- Form Settings Pages --------------------------
public function form_settings_init() {
parent::form_settings_init();
}
public function ajax_toggle_is_active() {
$feed_id = rgpost( 'feed_id' );
$is_active = rgpost( 'is_active' );
$this->update_feed_active( $feed_id, $is_active );
die();
}
public function form_settings_sections() {
return array();
}
public function form_settings( $form ) {
if ( ! $this->_multiple_feeds || $this->is_detail_page() ) {
// feed edit page
$feed_id = $this->_multiple_feeds ? $this->get_current_feed_id() : $this->get_default_feed_id( $form['id'] );
$this->feed_edit_page( $form, $feed_id );
} else {
// feed list UI
$this->feed_list_page( $form );
}
}
public function is_feed_list_page() {
return ! isset( $_GET['fid'] );
}
public function is_detail_page() {
return ! $this->is_feed_list_page();
}
public function form_settings_header() {
if ( $this->is_feed_list_page() ) {
$title = $this->form_settings_title();
$url = add_query_arg( array( 'fid' => 0 ) );
return $title . " <a class='add-new-h2' href='" . esc_html( $url ) . "'>" . esc_html__( 'Add New', 'gravityforms' ) . '</a>';
}
}
public function form_settings_title() {
return sprintf( esc_html__( '%s Feeds', 'gravityforms' ), $this->_title );
}
protected function feed_edit_page( $form, $feed_id ) {
// Save feed if appropriate
$feed_id = $this->maybe_save_feed_settings( $feed_id, $form['id'] );
$this->_current_feed_id = $feed_id; //So that current feed functions work when creating a new feed
?>
<script type="text/javascript">
<?php GFFormSettings::output_field_scripts() ?>
</script>
<h3><span><?php echo $this->feed_settings_title() ?></span></h3>
<?php
$feed = $this->get_feed( $feed_id );
$this->set_settings( $feed['meta'] );
GFCommon::display_admin_message();
$this->render_settings( $this->get_feed_settings_fields( $form ) );
}
public function settings( $sections ) {
parent::settings( $sections );
?>
<input type="hidden" name="gf_feed_id" value="<?php echo esc_attr( $this->get_current_feed_id() ); ?>" />
<?php
}
public function feed_settings_title() {
return esc_html__( 'Feed Settings', 'gravityforms' );
}
public function feed_list_page( $form = null ) {
$action = $this->get_bulk_action();
if ( $action ) {
check_admin_referer( 'feed_list', 'feed_list' );
$this->process_bulk_action( $action );
}
$single_action = rgpost( 'single_action' );
if ( ! empty( $single_action ) ) {
check_admin_referer( 'feed_list', 'feed_list' );
$this->process_single_action( $single_action );
}
?>
<h3><span><?php echo $this->feed_list_title() ?></span></h3>
<form id="gform-settings" action="" method="post">
<?php
$feed_list = $this->get_feed_table( $form );
$feed_list->prepare_items();
$feed_list->display();
?>
<!--Needed to save state after bulk operations-->
<input type="hidden" value="gf_edit_forms" name="page">
<input type="hidden" value="settings" name="view">
<input type="hidden" value="<?php echo esc_attr( $this->_slug ); ?>" name="subview">
<input type="hidden" value="<?php echo esc_attr( rgar( $form, 'id' ) ); ?>" name="id">
<input id="single_action" type="hidden" value="" name="single_action">
<input id="single_action_argument" type="hidden" value="" name="single_action_argument">
<?php wp_nonce_field( 'feed_list', 'feed_list' ) ?>
</form>
<script type="text/javascript">
<?php GFCommon::gf_vars() ?>
</script>
<?php
}
public function get_feed_table( $form ) {
$columns = $this->feed_list_columns();
$column_value_callback = array( $this, 'get_column_value' );
$feeds = $this->get_feeds( rgar( $form, 'id' ) );
$bulk_actions = $this->get_bulk_actions();
$action_links = $this->get_action_links();
$no_item_callback = array( $this, 'feed_list_no_item_message' );
$message_callback = array( $this, 'feed_list_message' );
return new GFAddOnFeedsTable( $feeds, $this->_slug, $columns, $bulk_actions, $action_links, $column_value_callback, $no_item_callback, $message_callback );
}
public function feed_list_title() {
if ( ! $this->can_create_feed() ) {
return sprintf( __( '%s Feeds', 'gravityforms' ), $this->get_short_title() );
}
$url = add_query_arg( array( 'fid' => '0' ) );
$url = esc_url( $url );
return sprintf( esc_html__( '%s Feeds', 'gravityforms' ), $this->get_short_title() ) . " <a class='add-new-h2' href='{$url}'>" . esc_html__( 'Add New' , 'gravityforms' ) . '</a>';
}
protected function maybe_save_feed_settings( $feed_id, $form_id ) {
if ( ! rgpost( 'gform-settings-save' ) ) {
return $feed_id;
}
// store a copy of the previous settings for cases where action would only happen if value has changed
$feed = $this->get_feed( $feed_id );
$this->set_previous_settings( $feed['meta'] );
$settings = $this->get_posted_settings();
$sections = $this->get_feed_settings_fields();
$settings = $this->trim_conditional_logic_vales( $settings, $form_id );
$is_valid = $this->validate_settings( $sections, $settings );
$result = false;
if ( $is_valid ) {
$settings = $this->filter_settings( $sections, $settings );
$feed_id = $this->save_feed_settings( $feed_id, $form_id, $settings );
if ( $feed_id ) {
GFCommon::add_message( $this->get_save_success_message( $sections ) );
} else {
GFCommon::add_error_message( $this->get_save_error_message( $sections ) );
}
} else {
GFCommon::add_error_message( $this->get_save_error_message( $sections ) );
}
return $feed_id;
}
protected function trim_conditional_logic_vales( $settings, $form_id ) {
if ( ! is_array( $settings ) ) {
return $settings;
}
if ( isset( $settings['feed_condition_conditional_logic_object'] ) && is_array( $settings['feed_condition_conditional_logic_object'] ) ) {
$form = GFFormsModel::get_form_meta( $form_id );
$settings['feed_condition_conditional_logic_object'] = GFFormsModel::trim_conditional_logic_values_from_element( $settings['feed_condition_conditional_logic_object'], $form );
}
return $settings;
}
protected function get_save_success_message( $sections ) {
$save_button = $this->get_save_button( $sections );
return isset( $save_button['messages']['success'] ) ? $save_button['messages']['success'] : esc_html__( 'Feed updated successfully.', 'gravityforms' );
}
protected function get_save_error_message( $sections ) {
$save_button = $this->get_save_button( $sections );
return isset( $save_button['messages']['error'] ) ? $save_button['messages']['error'] : esc_html__( 'There was an error updating this feed. Please review all errors below and try again.', 'gravityforms' );
}
protected function save_feed_settings( $feed_id, $form_id, $settings ) {
if ( $feed_id ) {
$this->update_feed_meta( $feed_id, $settings );
$result = $feed_id;
} else {
$result = $this->insert_feed( $form_id, true, $settings );
}
return $result;
}
public function get_feed_settings_fields() {
if ( ! empty( $this->_feed_settings_fields ) ) {
return $this->_feed_settings_fields;
}
$this->_feed_settings_fields = $this->add_default_feed_settings_fields_props( $this->feed_settings_fields() );
return $this->_feed_settings_fields;
}
public function feed_settings_fields() {
return array();
}
public function add_default_feed_settings_fields_props( $fields ) {
foreach ( $fields as &$section ) {
foreach ( $section['fields'] as &$field ) {
switch ( $field['type'] ) {
case 'hidden':
$field['hidden'] = true;
break;
}
if ( $field['name'] == 'feedName' ){
$field['default_value'] = $this->get_default_feed_name();
}
}
}
return $fields;
}
private function get_bulk_action() {
$action = rgpost( 'action' );
if ( empty( $action ) || $action == '-1' ) {
$action = rgpost( 'action2' );
}
return empty( $action ) || $action == '-1' ? false : $action;
}
/***
* Override this function to add custom bulk actions
*/
protected function get_bulk_actions() {
$bulk_actions = array( 'delete' => esc_html__( 'Delete', 'gravityforms' ) );
return $bulk_actions;
}
/***
* Override this function to process custom bulk actions added via the get_bulk_actions() function
*
* @param string $action : The bulk action selected by the user
*/
protected function process_bulk_action( $action ) {
if ( $action == 'delete' ) {
$feeds = rgpost( 'feed_ids' );
if ( is_array( $feeds ) ) {
foreach ( $feeds as $feed_id ) {
$this->delete_feed( $feed_id );
}
}
}
}
protected function process_single_action( $action ) {
if ( $action == 'delete' ) {
$feed_id = absint( rgpost( 'single_action_argument' ) );
$this->delete_feed( $feed_id );
}
}
protected function get_action_links() {
$feed_id = '_id_';
$edit_url = add_query_arg( array( 'fid' => $feed_id ) );
$links = array(
'edit' => '<a title="' . esc_attr__( 'Edit this feed', 'gravityforms' ) . '" href="' . esc_url( $edit_url ) . '">' . esc_html__( 'Edit', 'gravityforms' ) . '</a>',
'delete' => '<a title="' . esc_attr__( 'Delete this feed', 'gravityforms' ) . '" class="submitdelete" onclick="javascript: if(confirm(\'' . esc_js( __( 'WARNING: You are about to delete this item.', 'gravityforms' ) ) . esc_js( __( "'Cancel' to stop, 'OK' to delete.", 'gravityforms' ) ) . '\')){ gaddon.deleteFeed(\'' . esc_js( $feed_id ) . '\'); }" style="cursor:pointer;">' . esc_html__( 'Delete', 'gravityforms' ) . '</a>'
);
return $links;
}
protected function feed_list_columns() {
return array();
}
/**
* Override this function to change the message that is displayed when the feed list is empty
* @return string The message
*/
public function feed_list_no_item_message() {
$url = add_query_arg( array( 'fid' => 0 ) );
return sprintf( esc_html__( "You don't have any feeds configured. Let's go %screate one%s!", 'gravityforms' ), "<a href='" . esc_url( $url ) . "'>", '</a>' );
}
/**
* Override this function to force a message to be displayed in the feed list (instead of data). Useful to alert users when main plugin settings haven't been completed.
* @return string|false
*/
public function feed_list_message() {
if ( ! $this->can_create_feed() ) {
return $this->configure_addon_message();
}
return false;
}
public function configure_addon_message() {
$settings_label = sprintf( __( '%s Settings', 'gravityforms' ), $this->get_short_title() );
$settings_link = sprintf( '<a href="%s">%s</a>', esc_url( $this->get_plugin_settings_url() ), $settings_label );
return sprintf( __( 'To get started, please configure your %s.', 'gravityforms' ), $settings_link );
}
/**
* Override this function to prevent the feed creation UI from being rendered.
* @return boolean|true
*/
public function can_create_feed() {
return true;
}
public function get_column_value( $item, $column ) {
if ( is_callable( array( $this, "get_column_value_{$column}" ) ) ) {
return call_user_func( array( $this, "get_column_value_{$column}" ), $item );
} elseif ( isset( $item[ $column ] ) ) {
return $item[ $column ];
} elseif ( isset( $item['meta'][ $column ] ) ) {
return $item['meta'][ $column ];
}
}
protected function update_form_settings( $form, $new_form_settings ) {
$feed_id = rgar( $new_form_settings, 'id' );
foreach ( $new_form_settings as $key => $value ) {
$form[ $this->_slug ]['feeds'][ $feed_id ][ $key ] = $value;
}
return $form;
}
protected function get_default_feed_id( $form_id ) {
global $wpdb;
$sql = $wpdb->prepare( "SELECT id FROM {$wpdb->prefix}gf_addon_feed WHERE addon_slug=%s AND form_id = %d LIMIT 0,1", $this->_slug, $form_id );
$feed_id = $wpdb->get_var( $sql );
if ( ! $feed_id ) {
$feed_id = 0;
}
return $feed_id;
}
protected function settings_feed_condition( $field, $echo = true ) {
$checkbox_label = isset( $field['checkbox_label'] ) ? $field['checkbox_label'] : esc_html__( 'Enable Condition', 'gravityforms' );
$checkbox_field = array(
'name' => 'feed_condition_conditional_logic',
'type' => 'checkbox',
'choices' => array(
array(
'label' => $checkbox_label,
'name' => 'feed_condition_conditional_logic',
),
),
'onclick' => 'ToggleConditionalLogic( false, "feed_condition" );',
);
$conditional_logic_object = $this->get_setting( 'feed_condition_conditional_logic_object' );
if ( $conditional_logic_object ) {
$form_id = rgget( 'id' );
$form = GFFormsModel::get_form_meta( $form_id );
$conditional_logic = json_encode( GFFormsModel::trim_conditional_logic_values_from_element( $conditional_logic_object, $form ) );
} else {
$conditional_logic = '{}';
}
$hidden_field = array(
'name' => 'feed_condition_conditional_logic_object',
'value' => $conditional_logic,
);
$instructions = isset( $field['instructions'] ) ? $field['instructions'] : esc_html__( 'Process this feed if', 'gravityforms' );
$html = $this->settings_checkbox( $checkbox_field, '', false );
$html .= $this->settings_hidden( $hidden_field, '', false );
$html .= '<div id="feed_condition_conditional_logic_container"><!-- dynamically populated --></div>';
$html .= '<script type="text/javascript"> var feedCondition = new FeedConditionObj({' .
'strings: { objectDescription: "' . esc_attr( $instructions ) . '" },' .
'logicObject: ' . $conditional_logic .
'}); </script>';
if ( $echo ) {
echo $html;
}
return $html;
}
public static function add_entry_meta( $form ) {
$entry_meta = GFFormsModel::get_entry_meta( $form['id'] );
$keys = array_keys( $entry_meta );
foreach ( $keys as $key ) {
array_push( $form['fields'], array( 'id' => $key, 'label' => $entry_meta[ $key ]['label'] ) );
}
return $form;
}
protected function has_feed_condition_field() {
$fields = $this->settings_fields_only( 'feed' );
foreach ( $fields as $field ) {
if ( $field['type'] == 'feed_condition' ) {
return true;
}
}
return false;
}
protected function add_delayed_payment_support( $options ) {
$this->delayed_payment_integration = $options;
if ( is_admin() ) {
add_action( 'gform_paypal_action_fields', array( $this, 'add_paypal_settings' ), 10, 2 );
add_filter( 'gform_paypal_save_config', array( $this, 'save_paypal_settings' ) );
}
add_action( 'gform_paypal_fulfillment', array( $this, 'paypal_fulfillment' ), 10, 4 );
}
public function add_paypal_settings( $feed, $form ) {
$form_id = rgar( $form, 'id' );
$feed_meta = $feed['meta'];
$settings_style = $this->has_feed( $form_id ) ? '' : 'display:none;';
$addon_name = $this->_slug;
$addon_feeds = array();
foreach ( $this->get_feeds( $form_id ) as $feed ) {
$addon_feeds[] = $feed['form_id'];
}
?>
<div style="<?php echo esc_attr( $settings_style ); ?>" id="delay_<?php echo esc_attr__( $addon_name ); ?>_container">
<input type="checkbox" name="paypal_delay_<?php echo esc_attr( $addon_name ); ?>" id="paypal_delay_<?php echo esc_attr( $addon_name ); ?>" value="1" <?php echo rgar( $feed_meta, "delay_$addon_name" ) ? "checked='checked'" : '' ?> class="gaddon-setting gaddon-checkbox" />
<label class="inline" for="paypal_delay_<?php echo esc_attr( $addon_name ); ?>">
<?php
if ( rgar( $this->delayed_payment_integration, 'option_label' ) ) {
echo rgar( $this->delayed_payment_integration, 'option_label' );
} else {
printf( esc_html__( 'Process %s feed only when payment is received.', 'gravityforms' ), $this->get_short_title() );
}
?>
</label>
</div>
<script type="text/javascript">
jQuery(document).ready(function ($) {
jQuery(document).bind('paypalFormSelected', function (event, form) {
var addonFormIds = <?php echo json_encode( $addon_feeds ); ?>;
var isApplicableFeed = false;
if (jQuery.inArray(String(form.id), addonFormIds) != -1)
isApplicableFeed = true;
if (isApplicableFeed) {
jQuery(<?php echo json_encode( '#delay_' . $addon_name . '_container' ); ?>).show();
} else {
jQuery(<?php echo json_encode( '#delay_' . $addon_name . '_container' ); ?>).hide();
}
});
});
</script>
<?php
}
public function save_paypal_settings( $feed ) {
$feed['meta'][ "delay_{$this->_slug}" ] = rgpost( "paypal_delay_{$this->_slug}" );