forked from wp-premium/gravityforms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.php
More file actions
1501 lines (1304 loc) · 51.9 KB
/
Copy pathapi.php
File metadata and controls
1501 lines (1304 loc) · 51.9 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();
}
/**
* API for standard Gravity Forms functionality.
*
* Supports:
* - Forms
* - Entries
*
* @package Gravity Forms
* @subpackage GFAPI
* @since 1.8
* @access public
*/
class GFAPI {
// FORMS ----------------------------------------------------
/**
* Returns the form object for a given Form ID.
*
* @since 1.8
* @access public
*
* @uses GFFormsModel::get_form_meta()
* @uses GFFormsModel::get_form()
*
* @param int $form_id The ID of the Form.
*
* @return mixed The form meta array or false.
*/
public static function get_form( $form_id ) {
$form_id = absint( $form_id );
$form = GFFormsModel::get_form_meta( $form_id );
if ( ! $form ) {
return false;
}
// Loading form columns into meta.
$form_info = GFFormsModel::get_form( $form_id, true );
$form['is_active'] = $form_info->is_active;
$form['date_created'] = $form_info->date_created;
$form['is_trash'] = $form_info->is_trash;
return $form;
}
/**
* Returns all the form objects.
*
* @since 1.8.11.5
* @access public
*
* @uses GFFormsModel::get_form_ids()
* @uses GFAPI::get_form()
*
* @param bool $active True if active forms are returned. False to get inactive forms. Defaults to true.
* @param bool $trash True if trashed forms are returned. False to exclude trash. Defaults to false.
*
* @return array The array of Form Objects.
*/
public static function get_forms( $active = true, $trash = false ) {
$form_ids = GFFormsModel::get_form_ids( $active, $trash );
if ( empty( $form_ids ) ) {
return array();
}
$forms = array();
foreach ( $form_ids as $form_id ) {
$forms[] = GFAPI::get_form( $form_id );
}
return $forms;
}
/**
* Deletes the forms with the given Form IDs.
*
* @since 1.8
* @access public
*
* @uses GFFormsModel::delete_forms()
*
* @param array $form_ids An array of form IDs to delete.
*
* @return void
*/
public static function delete_forms( $form_ids ) {
GFFormsModel::delete_forms( $form_ids );
}
/**
* Deletes the form with the given Form ID.
*
* @since 1.8
* @access public
*
* @uses GFAPI::get_form()
* @uses GFAPI::delete_forms()
*
* @param int $form_id The ID of the Form to delete.
*
* @return mixed True for success, or a WP_Error instance.
*/
public static function delete_form( $form_id ) {
$form = self::get_form( $form_id );
if ( empty( $form ) ) {
return new WP_Error( 'not_found', sprintf( __( 'Form with id: %s not found', 'gravityforms' ), $form_id ), $form_id );
}
self::delete_forms( array( $form_id ) );
return true;
}
/**
* Duplicates the form with the given Form ID.
*
* @since 2.2
* @access public
*
* @uses GFFormsModel::duplicate_form()
*
* @param int $form_id The ID of the Form to delete.
*
* @return mixed True for success, or a WP_Error instance
*/
public static function duplicate_form( $form_id ) {
return GFFormsModel::duplicate_form( $form_id );
}
/**
* Updates the forms with an array of form objects.
*
* @since 1.8
* @access public
*
* @uses GFAPI::update_form()
*
* @param array $forms Array of form objects.
*
* @return mixed True for success, or a WP_Error instance.
*/
public static function update_forms( $forms ) {
foreach ( $forms as $form ) {
$result = self::update_form( $form );
if ( is_wp_error( $result ) ) {
return $result;
}
}
return true;
}
/**
* Updates the form with a given form object.
*
* @since 1.8
* @access public
* @global $wpdb
*
* @uses \GFFormsModel::get_meta_table_name()
* @uses \GFFormsModel::update_form_meta()
*
* @param array $form The Form object
* @param int $form_id Optional. If specified, then the ID in the Form Object will be ignored.
*
* @return bool|WP_Error True for success, or a WP_Error instance.
*/
public static function update_form( $form, $form_id = null ) {
global $wpdb;
if ( ! $form ) {
return new WP_Error( 'invalid', __( 'Invalid form object', 'gravityforms' ) );
}
$form_table_name = $wpdb->prefix . 'rg_form';
if ( empty( $form_id ) ) {
$form_id = $form['id'];
} else {
// Make sure the form object has the right form id.
$form['id'] = $form_id;
if ( isset( $form['fields'] ) ) {
foreach ( $form['fields'] as &$field ) {
if ( $field instanceof GF_Field ) {
$field->formId = $form_id;
} else {
$field['formId'] = $form_id;
}
}
}
}
if ( empty( $form_id ) ) {
return new WP_Error( 'missing_form_id', __( 'Missing form id', 'gravityforms' ) );
}
$meta_table_name = GFFormsModel::get_meta_table_name();
if ( intval( $wpdb->get_var( $wpdb->prepare( "SELECT count(0) FROM {$meta_table_name} WHERE form_id=%d", $form_id ) ) ) == 0 ) {
return new WP_Error( 'not_found', __( 'Form not found', 'gravityforms' ) );
}
// Strip confirmations and notifications.
$form_display_meta = $form;
unset( $form_display_meta['confirmations'] );
unset( $form_display_meta['notifications'] );
$result = GFFormsModel::update_form_meta( $form_id, $form_display_meta );
if ( false === $result ) {
return new WP_Error( 'error_updating_form', __( 'Error updating form', 'gravityforms' ), $wpdb->last_error );
}
if ( isset( $form['confirmations'] ) && is_array( $form['confirmations'] ) ) {
$result = GFFormsModel::update_form_meta( $form_id, $form['confirmations'], 'confirmations' );
if ( false === $result ) {
return new WP_Error( 'error_updating_confirmations', __( 'Error updating form confirmations', 'gravityforms' ), $wpdb->last_error );
}
}
if ( isset( $form['notifications'] ) && is_array( $form['notifications'] ) ) {
$result = GFFormsModel::update_form_meta( $form_id, $form['notifications'], 'notifications' );
if ( false === $result ) {
return new WP_Error( 'error_updating_notifications', __( 'Error updating form notifications', 'gravityforms' ), $wpdb->last_error );
}
}
// Updating form title and is_active flag.
$is_active = rgar( $form, 'is_active' ) ? '1' : '0';
$result = $wpdb->query( $wpdb->prepare( "UPDATE {$form_table_name} SET title=%s, is_active=%s WHERE id=%d", $form['title'], $is_active, $form['id'] ) );
if ( false === $result ) {
return new WP_Error( 'error_updating_title', __( 'Error updating title', 'gravityforms' ), $wpdb->last_error );
}
return true;
}
/**
* Updates a form property - a column in the main forms table. e.g. is_trash, is_active, title
*
* @since 1.8.3.15
* @access public
*
* @uses GFFormsModel::get_form_table_name()
* @uses GFFormsModel::get_form_db_columns()
*
* @param array $form_ids The IDs of the forms to update.
* @param array $property_key The name of the column in the database e.g. is_trash, is_active, title.
* @param array $value The new value.
*
* @return mixed Either a WP_Error instance or the result of the query
*/
public static function update_forms_property( $form_ids, $property_key, $value ) {
global $wpdb;
$table = GFFormsModel::get_form_table_name();
$db_columns = GFFormsModel::get_form_db_columns();
if ( ! in_array( strtolower( $property_key ), $db_columns ) ) {
return new WP_Error( 'property_key_incorrect', __( 'Property key incorrect', 'gravityforms' ) );
}
$value = esc_sql( $value );
if ( ! is_numeric( $value ) ) {
$value = sprintf( "'%s'", $value );
}
$in_str_arr = array_fill( 0, count( $form_ids ), '%d' );
$in_str = join( $in_str_arr, ',' );
$result = $wpdb->query(
$wpdb->prepare(
"
UPDATE $table
SET {$property_key} = {$value}
WHERE id IN ($in_str)
", $form_ids
)
);
return $result;
}
/**
* Updates the property of one form - columns in the main forms table. e.g. is_trash, is_active, title.
*
* @since 1.8.3.15
* @access public
*
* @uses GFAPI::update_forms_property()
*
* @param array|int $form_id The ID of the forms to update.
* @param string $property_key The name of the column in the database e.g. is_trash, is_active, title.
* @param string $value The new value.
*
* @return mixed Either a WP_Error instance or the result of the query
*/
public static function update_form_property( $form_id, $property_key, $value ) {
return self::update_forms_property( array( $form_id ), $property_key, $value );
}
/**
* Adds multiple form objects.
*
* @since 1.8
* @access public
*
* @uses GFAPI::add_form()
*
* @param array $forms The Form Objects.
*
* @return array|WP_Error Either an array of new form IDs or a WP_Error instance.
*/
public static function add_forms( $forms ) {
if ( ! $forms || ! is_array( $forms ) ) {
return new WP_Error( 'invalid', __( 'Invalid form objects', 'gravityforms' ) );
}
$form_ids = array();
foreach ( $forms as $form ) {
$result = self::add_form( $form );
if ( is_wp_error( $result ) ) {
return $result;
}
$form_ids[] = $result;
}
return $form_ids;
}
/**
* Adds a new form using the given Form object. Warning, little checking is done to make sure it's a valid Form object.
*
* @since 1.8
* @access public
* @global $wpdb
*
* @uses GFFormsModel::is_unique_title()
* @uses GFFormsModel::insert_form()
* @uses GFAPI::set_property_as_key()
* @uses GFFormsModel::update_form_meta()
*
* @param array $form_meta The Form object.
*
* @return int|WP_Error Either the new Form ID or a WP_Error instance.
*/
public static function add_form( $form_meta ) {
global $wpdb;
if ( ! $form_meta || ! is_array( $form_meta ) ) {
return new WP_Error( 'invalid', __( 'Invalid form object', 'gravityforms' ) );
}
if ( rgar( $form_meta, 'title' ) == '' ) {
return new WP_Error( 'missing_title', __( 'The form title is missing', 'gravityforms' ) );
}
// Making sure title is not duplicate.
$title = $form_meta['title'];
$count = 2;
while ( ! RGFormsModel::is_unique_title( $title ) ) {
$title = $form_meta['title'] . "($count)";
$count ++;
}
// Inserting form.
$form_id = RGFormsModel::insert_form( $title );
// Updating form meta.
$form_meta['title'] = $title;
// Updating object's id property.
$form_meta['id'] = $form_id;
// Add default confirmation if form has no confirmations.
if ( ! isset( $form_meta['confirmations'] ) || empty( $form_meta['confirmations'] ) ) {
// Generate confirmation ID.
$confirmation_id = uniqid();
// Add default confirmation to form.
$form_meta['confirmations'][ $confirmation_id ] = array(
'id' => $confirmation_id,
'name' => __( 'Default Confirmation', 'gravityforms' ),
'isDefault' => true,
'type' => 'message',
'message' => __( 'Thanks for contacting us! We will get in touch with you shortly.', 'gravityforms' ),
'url' => '',
'pageId' => '',
'queryString' => '',
);
}
if ( isset( $form_meta['confirmations'] ) ) {
$form_meta['confirmations'] = self::set_property_as_key( $form_meta['confirmations'], 'id' );
GFFormsModel::update_form_meta( $form_id, $form_meta['confirmations'], 'confirmations' );
unset( $form_meta['confirmations'] );
}
if ( isset( $form_meta['notifications'] ) ) {
$form_meta['notifications'] = self::set_property_as_key( $form_meta['notifications'], 'id' );
GFFormsModel::update_form_meta( $form_id, $form_meta['notifications'], 'notifications' );
unset( $form_meta['notifications'] );
}
// Updating form meta.
$result = GFFormsModel::update_form_meta( $form_id, $form_meta );
if ( false === $result ) {
return new WP_Error( 'insert_form_error', __( 'There was a problem while inserting the form', 'gravityforms' ), $wpdb->last_error );
}
return $form_id;
}
/**
* Private.
*
* @since 1.8
* @access private
* @ignore
*/
private static function set_property_as_key( $array, $property ) {
$new_array = array();
foreach ( $array as $item ) {
$new_array[ $item[ $property ] ] = $item;
}
return $new_array;
}
// ENTRIES ----------------------------------------------------
/**
* Returns an array of Entry objects for the given search criteria. The search criteria array is constructed as follows:
*
* Filter by status
* $search_criteria['status'] = 'active';
*
* Filter by date range
* $search_criteria['start_date'] = $start_date; // Using the time zone in the general settings.
* $search_criteria['end_date'] = $end_date; // Using the time zone in the general settings.
*
* Filter by any column in the main table
* $search_criteria['field_filters'][] = array("key" => 'currency', value => 'USD');
* $search_criteria['field_filters'][] = array("key" => 'is_read', value => true);
*
* Filter by Field Values
* $search_criteria['field_filters'][] = array('key' => '1', 'value' => 'gquiz159982170');
*
* Filter Operators
* Supported operators for scalar values: is/=, isnot/<>, contains
* $search_criteria['field_filters'][] = array('key' => '1', 'operator' => 'contains', value' => 'Steve');
* Supported operators for array values: in/=, not in/<>/!=
* $search_criteria['field_filters'][] = array('key' => '1', 'operator' => 'not in', value' => array( 'Alex', 'David', 'Dana' );
*
* Filter by a checkbox value - input ID search keys
* $search_criteria['field_filters'][] = array('key' => '2.2', 'value' => 'gquiz246fec995');
* NOTES:
* - Using input IDs as search keys will work for checkboxes but it won't work if the checkboxes have been re-ordered since the first submission.
* - the 'not in' operator is not currently supported for checkbox values.
*
* Filter by a checkbox value - field ID keys
* Using the field ID as the search key is recommended for checkboxes.
* $search_criteria['field_filters'][] = array('key' => '2', 'value' => 'gquiz246fec995');
* $search_criteria['field_filters'][] = array('key' => '2', 'operator' => 'in', 'value' => array( 'First Choice', 'Third Choice' );
* NOTE: Neither 'not in' nor '<>' operators are not currently supported for checkboxes using field IDs as search keys.
*
* Filter by a global search of values of any form field
* $search_criteria['field_filters'][] = array('value' => $search_value);
* OR
* $search_criteria['field_filters'][] = array('key' => 0, 'value' => $search_value);
*
* Filter entries by Entry meta (added using the gform_entry_meta hook)
* $search_criteria['field_filters'][] = array('key' => 'gquiz_score', 'value' => '1');
* $search_criteria['field_filters'][] = array('key' => 'gquiz_is_pass', 'value' => '1');
*
* Filter by ALL / ANY of the field filters
* $search_criteria['field_filters']['mode'] = 'all'; // default
* $search_criteria['field_filters']['mode'] = 'any';
*
* Sorting: column, field or entry meta
* $sorting = array('key' => $sort_field, 'direction' => 'ASC' );
*
* Paging
* $paging = array('offset' => 0, 'page_size' => 20 );
*
* @since 1.8
* @access public
*
* @uses GFFormsModel::search_leads()
* @uses GFAPI::count_entries()
*
* @param int|array $form_ids The ID of the form or an array IDs of the Forms. Zero for all forms.
* @param array $search_criteria Optional. An array containing the search criteria. Defaults to empty array.
* @param array $sorting Optional. An array containing the sorting criteria. Defaults to null.
* @param array $paging Optional. An array containing the paging criteria. Defaults to null.
* @param int $total_count Optional. An output parameter containing the total number of entries. Pass a non-null value to get the total count. Defaults to null.
*
* @return array|WP_Error Either an array of the Entry objects or a WP_Error instance.
*/
public static function get_entries( $form_ids, $search_criteria = array(), $sorting = null, $paging = null, &$total_count = null ) {
if ( empty( $sorting ) ) {
$sorting = array( 'key' => 'id', 'direction' => 'DESC', 'is_numeric' => true );
}
$entries = GFFormsModel::search_leads( $form_ids, $search_criteria, $sorting, $paging );
if ( ! is_null( $total_count ) ) {
$total_count = self::count_entries( $form_ids, $search_criteria );
}
return $entries;
}
/**
* Returns the total number of entries for the given search criteria. See get_entries() for examples of the search criteria.
*
* @since 1.8
* @access public
*
* @uses GFFormsModel::count_search_leads()
*
* @param int|array $form_ids The ID of the Form or an array of Form IDs.
* @param array $search_criteria Optional. An array containing the search criteria. Defaults to empty array.
*
* @return int The total count.
*/
public static function count_entries( $form_ids, $search_criteria = array() ) {
return GFFormsModel::count_search_leads( $form_ids, $search_criteria );
}
/**
* Returns the Entry object for a given Entry ID.
*
* @since 1.8
* @access public
*
* @uses GFAPI::get_entries()
*
* @param int $entry_id The ID of the Entry.
*
* @return array|WP_Error The Entry object or a WP_Error instance.
*/
public static function get_entry( $entry_id ) {
$search_criteria['field_filters'][] = array( 'key' => 'id', 'value' => $entry_id );
$paging = array( 'offset' => 0, 'page_size' => 1 );
$entries = self::get_entries( 0, $search_criteria, null, $paging );
if ( empty( $entries ) ) {
return new WP_Error( 'not_found', sprintf( __( 'Entry with id %s not found', 'gravityforms' ), $entry_id ), $entry_id );
}
return $entries[0];
}
/**
* Adds multiple Entry objects.
*
* @since 1.8
* @access public
*
* @uses GFAPI::add_entry()
*
* @param array $entries The Entry objects
* @param int $form_id Optional. If specified, the form_id in the Entry objects will be ignored. Defaults to null.
*
* @return array|WP_Error Either an array of new Entry IDs or a WP_Error instance
*/
public static function add_entries( $entries, $form_id = null ) {
$entry_ids = array();
foreach ( $entries as $entry ) {
if ( $form_id ) {
$entry['form_id'] = $form_id;
}
$result = self::add_entry( $entry );
if ( is_wp_error( $result ) ) {
return $result;
}
$entry_ids[] = $result;
}
return $entry_ids;
}
/**
* Updates multiple Entry objects.
*
* @since 1.8
* @access public
*
* @uses GFCommon::log_debug()
* @uses GFAPI::update_entry()
*
* @param array $entries The Entry objects
*
* @return bool|WP_Error Either true for success, or a WP_Error instance
*/
public static function update_entries( $entries ) {
foreach ( $entries as $entry ) {
$entry_id = rgar( $entry, 'id' );
GFCommon::log_debug( 'Updating entry ' . $entry_id );
$result = self::update_entry( $entry, $entry_id );
if ( is_wp_error( $result ) ) {
return $result;
}
}
return true;
}
/**
* Updates an entire single Entry object.
*
* If the date_created value is not set then the current time UTC will be used.
* The date_created value, if set, is expected to be in 'Y-m-d H:i:s' format (UTC).
*
* @since 1.8
* @access public
* @global $wpdb
* @global $current_user
*
* @uses \GFAPI::get_entry
* @uses \GFAPI::form_id_exists
* @uses \GFFormsModel::get_ip
* @uses \GFFormsModel::get_current_page_url
* @uses \GFCommon::get_currency
* @uses \GFFormsModel::get_lead_table_name
* @uses \GFFormsModel::get_lead_details_table_name
* @uses \GFFormsModel::get_form_meta
* @uses \GFFormsModel::get_input_type
* @uses \GF_Field::get_entry_inputs
* @uses \GFFormsModel::get_lead_detail_id
* @uses \GFFormsModel::update_lead_field_value
* @uses \GFFormsModel::get_entry_meta
* @uses \GFFormsModel::get_field
*
* @param array $entry The Entry Object.
* @param int $entry_id Optional. If specified, the ID in the Entry Object will be ignored. Defaults to null.
*
* @return true|WP_Error Either True or a WP_Error instance
*/
public static function update_entry( $entry, $entry_id = null ) {
global $wpdb;
if ( empty( $entry_id ) ) {
if ( rgar( $entry, 'id' ) ) {
$entry_id = absint( $entry['id'] );
}
} else {
$entry['id'] = absint( $entry_id );
}
if ( empty( $entry_id ) ) {
return new WP_Error( 'missing_entry_id', __( 'Missing entry id', 'gravityforms' ) );
}
$current_entry = $original_entry = self::get_entry( $entry_id );
if ( ! $current_entry ) {
return new WP_Error( 'not_found', __( 'Entry not found', 'gravityforms' ), $entry_id );
}
if ( is_wp_error( $current_entry ) ) {
return $current_entry;
}
// Make sure the form id exists
$form_id = rgar( $entry, 'form_id' );
if ( empty( $form_id ) ) {
$form_id = rgar( $current_entry, 'form_id' );
}
if ( false === self::form_id_exists( $form_id ) ) {
return new WP_Error( 'invalid_form_id', __( 'The form for this entry does not exist', 'gravityforms' ) );
}
/**
* Filters the entry before it is updated.
*
* @since Unknown
*
* @param array $entry The Entry Object.
* @param array $original_entry Te original Entry Object, before changes.
*/
$entry = apply_filters( 'gform_entry_pre_update', $entry, $original_entry );
// Use values in the entry object if present
$post_id = isset( $entry['post_id'] ) ? intval( $entry['post_id'] ) : 'NULL';
$date_created = isset( $entry['date_created'] ) ? sprintf( "'%s'", esc_sql( $entry['date_created'] ) ) : 'utc_timestamp()';
$is_starred = isset( $entry['is_starred'] ) ? $entry['is_starred'] : 0;
$is_read = isset( $entry['is_read'] ) ? $entry['is_read'] : 0;
$ip = isset( $entry['ip'] ) ? $entry['ip'] : GFFormsModel::get_ip();
$source_url = isset( $entry['source_url'] ) ? $entry['source_url'] : GFFormsModel::get_current_page_url();
$user_agent = isset( $entry['user_agent'] ) ? $entry['user_agent'] : 'API';
$currency = isset( $entry['currency'] ) ? $entry['currency'] : GFCommon::get_currency();
$payment_status = isset( $entry['payment_status'] ) ? sprintf( "'%s'", esc_sql( $entry['payment_status'] ) ) : 'NULL';
$payment_date = strtotime( rgar( $entry, 'payment_date' ) ) ? "'" . gmdate( 'Y-m-d H:i:s', strtotime( "{$entry['payment_date']}" ) ) . "'" : 'NULL';
$payment_amount = isset( $entry['payment_amount'] ) ? (float) $entry['payment_amount'] : 'NULL';
$payment_method = isset( $entry['payment_method'] ) ? $entry['payment_method'] : '';
$transaction_id = isset( $entry['transaction_id'] ) ? sprintf( "'%s'", esc_sql( $entry['transaction_id'] ) ) : 'NULL';
$is_fulfilled = isset( $entry['is_fulfilled'] ) ? intval( $entry['is_fulfilled'] ) : 'NULL';
$status = isset( $entry['status'] ) ? $entry['status'] : 'active';
global $current_user;
$user_id = isset( $entry['created_by'] ) ? absint( $entry['created_by'] ) : '';
if ( empty( $user_id ) ) {
$user_id = $current_user && $current_user->ID ? absint( $current_user->ID ) : 'NULL';
}
$transaction_type = isset( $entry['transaction_type'] ) ? intval( $entry['transaction_type'] ) : 'NULL';
$lead_table = GFFormsModel::get_lead_table_name();
$sql = $wpdb->prepare(
"
UPDATE $lead_table
SET
form_id = %d,
post_id = {$post_id},
date_created = {$date_created},
is_starred = %d,
is_read = %d,
ip = %s,
source_url = %s,
user_agent = %s,
currency = %s,
payment_status = {$payment_status},
payment_date = {$payment_date},
payment_amount = {$payment_amount},
transaction_id = {$transaction_id},
is_fulfilled = {$is_fulfilled},
created_by = {$user_id},
transaction_type = {$transaction_type},
status = %s,
payment_method = %s
WHERE
id = %d
", $form_id, $is_starred, $is_read, $ip, $source_url, $user_agent, $currency, $status, $payment_method, $entry_id
);
$result = $wpdb->query( $sql );
if ( false === $result ) {
return new WP_Error( 'update_entry_properties_failed', __( 'There was a problem while updating the entry properties', 'gravityforms' ), $wpdb->last_error );
}
// Only save field values for fields that currently exist in the form. The rest in $entry will be ignored. The rest in $current_entry will get deleted.
$lead_detail_table = GFFormsModel::get_lead_details_table_name();
$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT id, field_number FROM $lead_detail_table WHERE lead_id=%d", $entry_id ) );
$form = GFFormsModel::get_form_meta( $form_id );
$form = gf_apply_filters( array( 'gform_form_pre_update_entry', $form_id ), $form, $entry, $entry_id );
foreach ( $form['fields'] as $field ) {
/* @var GF_Field $field */
$type = GFFormsModel::get_input_type( $field );
if ( in_array( $type, array( 'html', 'page', 'section' ) ) ) {
continue;
}
$inputs = $field->get_entry_inputs();
if ( is_array( $inputs ) ) {
foreach ( $field->inputs as $input ) {
$input_id = (string) $input['id'];
if ( isset( $entry[ $input_id ] ) ) {
if ( $entry[ $input_id ] != $current_entry[ $input_id ] ) {
$lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
$result = GFFormsModel::update_lead_field_value( $form, $entry, $field, $lead_detail_id, $input_id, $entry[ $input_id ] );
if ( false === $result ) {
return new WP_Error( 'update_input_value_failed', __( 'There was a problem while updating one of the input values for the entry', 'gravityforms' ), $wpdb->last_error );
}
}
unset( $current_entry[ $input_id ] );
}
}
} else {
$field_id = $field->id;
$field_value = isset( $entry[ (string) $field_id ] ) ? $entry[ (string) $field_id ] : '';
if ( $field_value != $current_entry[ $field_id ] ) {
$lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $field_id );
$result = GFFormsModel::update_lead_field_value( $form, $entry, $field, $lead_detail_id, $field_id, $field_value );
if ( false === $result ) {
return new WP_Error( 'update_field_values_failed', __( 'There was a problem while updating the field values', 'gravityforms' ), $wpdb->last_error );
}
}
unset( $current_entry[ $field_id ] );
}
}
// Save the entry meta values - only for the entry meta currently available for the form, ignore the rest.
$entry_meta = GFFormsModel::get_entry_meta( $form_id );
if ( is_array( $entry_meta ) ) {
foreach ( array_keys( $entry_meta ) as $key ) {
if ( isset( $entry[ $key ] ) ) {
if ( $entry[ $key ] != $current_entry[ $key ] ) {
gform_update_meta( $entry_id, $key, $entry[ $key ] );
}
unset( $current_entry[ $key ] );
}
}
}
// Now delete remaining values from the old entry.
if ( is_array( $entry_meta ) ) {
foreach ( array_keys( $entry_meta ) as $meta_key ) {
if ( isset( $current_entry[ $meta_key ] ) ) {
gform_delete_meta( $entry_id, $meta_key );
unset( $current_entry[ $meta_key ] );
}
}
}
foreach ( $current_entry as $k => $v ) {
$lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $k );
$field = GFFormsModel::get_field( $form, $k );
$result = GFFormsModel::update_lead_field_value( $form, $entry, $field, $lead_detail_id, $k, '' );
if ( false === $result ) {
return new WP_Error( 'update_field_values_failed', __( 'There was a problem while updating the field values', 'gravityforms' ), $wpdb->last_error );
}
}
/**
* Fires after the Entry is updated.
*
* @since Unknown.
*
* @param array $lead The entry object after being updated.
* @param array $original_entry The entry object before being updated.
*/
gf_do_action( array( 'gform_post_update_entry', $form_id ), $entry, $original_entry );
return true;
}
/**
* Adds a single Entry object.
*
* Intended to be used for importing an entry object. The usual hooks that are triggered while saving entries are not fired here.
* Checks that the form id, field ids and entry meta exist and ignores legacy values (i.e. values for fields that no longer exist).
*
* @since 1.8
* @access public
* @global $wpdb
* @global $current_user
*
* @uses GFAPI::form_id_exists()
* @uses GFFormsModel::get_ip()
* @uses GFFormsModel::get_current_page_url()
* @uses GFCommon::get_currency()
* @uses GFFormsModel::get_lead_table_name()
* @uses GF_Field::get_entry_inputs()
* @uses GFFormsModel::update_lead_field_value()
* @uses GFFormsModel::get_entry_meta()
* @uses GFAPI::get_entry()
*
* @param array $entry The Entry Object.
*
* @return int|WP_Error Either the new Entry ID or a WP_Error instance.
*/
public static function add_entry( $entry ) {
global $wpdb;
if ( ! is_array( $entry ) ) {
return new WP_Error( 'invalid_entry_object', __( 'The entry object must be an array', 'gravityforms' ) );
}
// Make sure the form id exists.
$form_id = rgar( $entry, 'form_id' );
if ( empty( $form_id ) ) {
return new WP_Error( 'empty_form_id', __( 'The form id must be specified', 'gravityforms' ) );
}
if ( false === self::form_id_exists( $form_id ) ) {
return new WP_Error( 'invalid_form_id', __( 'The form for this entry does not exist', 'gravityforms' ) );
}
// Use values in the entry object if present
$post_id = isset( $entry['post_id'] ) ? intval( $entry['post_id'] ) : 'NULL';
$date_created = isset( $entry['date_created'] ) && $entry['date_created'] != '' ? sprintf( "'%s'", esc_sql( $entry['date_created'] ) ) : 'utc_timestamp()';
$is_starred = isset( $entry['is_starred'] ) ? $entry['is_starred'] : 0;
$is_read = isset( $entry['is_read'] ) ? $entry['is_read'] : 0;
$ip = isset( $entry['ip'] ) ? $entry['ip'] : GFFormsModel::get_ip();
$source_url = isset( $entry['source_url'] ) ? $entry['source_url'] : esc_url_raw( GFFormsModel::get_current_page_url() );
$user_agent = isset( $entry['user_agent'] ) ? $entry['user_agent'] : 'API';
$currency = isset( $entry['currency'] ) ? $entry['currency'] : GFCommon::get_currency();
$payment_status = isset( $entry['payment_status'] ) ? sprintf( "'%s'", esc_sql( $entry['payment_status'] ) ) : 'NULL';
$payment_date = strtotime( rgar( $entry, 'payment_date' ) ) ? sprintf( "'%s'", gmdate( 'Y-m-d H:i:s', strtotime( "{$entry['payment_date']}" ) ) ) : 'NULL';
$payment_amount = isset( $entry['payment_amount'] ) ? (float) $entry['payment_amount'] : 'NULL';
$payment_method = isset( $entry['payment_method'] ) ? $entry['payment_method'] : '';
$transaction_id = isset( $entry['transaction_id'] ) ? sprintf( "'%s'", esc_sql( $entry['transaction_id'] ) ) : 'NULL';
$is_fulfilled = isset( $entry['is_fulfilled'] ) ? intval( $entry['is_fulfilled'] ) : 'NULL';
$status = isset( $entry['status'] ) ? $entry['status'] : 'active';
global $current_user;
$user_id = isset( $entry['created_by'] ) ? absint( $entry['created_by'] ) : '';
if ( empty( $user_id ) ) {
$user_id = $current_user && $current_user->ID ? absint( $current_user->ID ) : 'NULL';
}
$transaction_type = isset( $entry['transaction_type'] ) ? intval( $entry['transaction_type'] ) : 'NULL';
$lead_table = GFFormsModel::get_lead_table_name();
$result = $wpdb->query(
$wpdb->prepare(
"
INSERT INTO $lead_table
(form_id, post_id, date_created, is_starred, is_read, ip, source_url, user_agent, currency, payment_status, payment_date, payment_amount, transaction_id, is_fulfilled, created_by, transaction_type, status, payment_method)
VALUES
(%d, {$post_id}, {$date_created}, %d, %d, %s, %s, %s, %s, {$payment_status}, {$payment_date}, {$payment_amount}, {$transaction_id}, {$is_fulfilled}, {$user_id}, {$transaction_type}, %s, %s)
", $form_id, $is_starred, $is_read, $ip, $source_url, $user_agent, $currency, $status, $payment_method
)
);
if ( false === $result ) {
return new WP_Error( 'insert_entry_properties_failed', __( 'There was a problem while inserting the entry properties', 'gravityforms' ), $wpdb->last_error );
}
// Reading newly created lead id.
$entry_id = $wpdb->insert_id;
$entry['id'] = $entry_id;
// Only save field values for fields that currently exist in the form.
$form = GFFormsModel::get_form_meta( $form_id );
foreach ( $form['fields'] as $field ) {
/* @var GF_Field $field */
if ( in_array( $field->type, array( 'html', 'page', 'section' ) ) ) {
continue;
}
$inputs = $field->get_entry_inputs();
if ( is_array( $inputs ) ) {
foreach ( $inputs as $input ) {
$input_id = (string) $input['id'];
if ( isset( $entry[ $input_id ] ) ) {
$result = GFFormsModel::update_lead_field_value( $form, $entry, $field, 0, $input_id, $entry[ $input_id ] );
if ( false === $result ) {
return new WP_Error( 'insert_input_value_failed', __( 'There was a problem while inserting one of the input values for the entry', 'gravityforms' ), $wpdb->last_error );
}
}
}
} else {
$field_id = $field->id;
$field_value = isset( $entry[ (string) $field_id ] ) ? $entry[ (string) $field_id ] : '';
$result = GFFormsModel::update_lead_field_value( $form, $entry, $field, 0, $field_id, $field_value );
if ( false === $result ) {
return new WP_Error( 'insert_field_values_failed', __( 'There was a problem while inserting the field values', 'gravityforms' ), $wpdb->last_error );
}
}
}
// Add save the entry meta values - only for the entry meta currently available for the form, ignore the rest.
$entry_meta = GFFormsModel::get_entry_meta( $form_id );
if ( is_array( $entry_meta ) ) {
foreach ( array_keys( $entry_meta ) as $key ) {
if ( isset( $entry[ $key ] ) ) {
gform_update_meta( $entry_id, $key, $entry[ $key ], $form['id'] );
}
}
}
// Refresh the entry
$entry = GFAPI::get_entry( $entry['id'] );
/**
* Fires after the Entry is added using the API.
*
* @since 1.9.14.26
*
* @param array $entry The Entry Object added.
* @param array $form The Form Object added.
*/
do_action( 'gform_post_add_entry', $entry, $form );
return $entry_id;
}
/**
* Deletes a single Entry.
*
* @since 1.8
* @access public
*
* @uses GFFormsModel::get_lead()
* @uses GFFormsModel::delete_lead()
*
* @param int $entry_id The ID of the Entry object.