class-gf-payment-addon.php
123 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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
<?php
/**
* Specialist Add-On class designed for use by Add-Ons that collect payment
*
* @package GFPaymentAddOn
*/
// If Gravity Forms doesn't exist, bail.
if ( ! class_exists( 'GFForms' ) ) {
die();
}
// Require GFFeedAddOn.
require_once( 'class-gf-feed-addon.php' );
/**
* Class GFPaymentAddOn
*
* Used to extend Gravity Forms. Specifically, payment add-ons.
*
* @since Unknown
*
* @uses GFFeedAddOn
*/
abstract class GFPaymentAddOn extends GFFeedAddOn {
/**
* Defines the version of GFPaymentAddOn.
*
* @since Unknown
* @access private
*
* @used-by GFPaymentAddOn::setup()
*
* @var string The version string.
*/
private $_payment_version = '1.3';
/**
* Defines if the credit card field is required by the payment add-on.
*
* If set to true, user will not be able to create feeds for a form until a credit card field has been added.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::before_delete_field()
* @used-by GFPaymentAddOn::feed_list_message()
* @used-by GFPaymentAddOn::init_admin()
*
* @var bool True if the payment add-on requires a credit card field. Otherwise, false.
*/
protected $_requires_credit_card = false;
/**
* Defines if the payment add-on supports callbacks.
*
* If set to true, callbacks/webhooks/IPN will be enabled and the appropriate database table will be created.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::upgrade_payment()
*
* @var bool True if the add-on supports callbacks. Otherwise, false.
*/
protected $_supports_callbacks = false;
/**
* Stores authorization results returned from the payment gateway.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::entry_post_save()
* @used-by GFPaymentAddOn::validation()
*
* @var array
*/
protected $authorization = array();
/**
* Stores the redirect URL that the user should be sent to for payment.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::confirmation()
* @used-by GFPaymentAddOn::entry_post_save()
*
* @var string The URL to redirect to. Defaults to empty string.
*/
protected $redirect_url = '';
/**
* Stores the current feed being processed.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::entry_post_save()
* @used-by GFPaymentAddOn::validation()
*
* @var array|array The current Feed Object. Defaults to false.
*/
protected $current_feed = false;
/**
* Stores the current submission data being processed.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::entry_post_save()
* @used-by GFPaymentAddOn::validation()
*
* @var array|bool The form submission data. Defaults to false.
*/
protected $current_submission_data = false;
/**
* Defines if the payment add-on is a payment gateway add-on.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::entry_post_save()
* @used-by GFPaymentAddOn::is_payment_gateway()
* @used-by GFPaymentAddOn::is_payment_gateway()
*
* @var bool Set to true if it is a payment gateway add-on. Defaults to false.
*/
protected $is_payment_gateway = false;
/**
* Defines if only a single feed should be processed.
*
* @since Unknown
* @access protected
*
* @used-by GFFeedAddOn::maybe_process_feed()
*
* @var bool True if only a single feed should be processed. Otherwise, false.
*/
protected $_single_feed_submission = true;
/**
* Indicates if the payment gateway requires monetary amounts to be formatted as the smallest unit for the currency being used.
*
* For example, $100.00 will be formatted as 10000.
*
* @since Unknown
* @access protected
*
* @used-by GFPaymentAddOn::get_amount_export()
* @used-by GFPaymentAddOn::get_amount_import()
*
* @var bool True if the smallest unit should be used. Otherwise, will include the decimal places.
*/
protected $_requires_smallest_unit = false;
//--------- Initialization ----------
/**
* Runs before the payment add-on is initialized.
*
* @since Unknown
* @access public
*
* @used-by GFAddOn::__construct()
* @uses GFAddOn::pre_init()
* @uses GFPaymentAddOn::payment_method_is_overridden()
* @uses GFPaymentAddOn::setup_cron()
* @uses GFPaymentAddOn::maybe_process_callback()
*
* @return void
*/
public function pre_init() {
parent::pre_init();
// Intercepting callback requests.
add_action( 'parse_request', array( $this, 'maybe_process_callback' ) );
if ( $this->payment_method_is_overridden( 'check_status' ) ) {
$this->setup_cron();
}
}
/**
* Runs when the payment add-on is initialized.
*
* @since Unknown
* @access public
*
* @uses GFFeedAddOn::init()
* @uses GFPaymentAddOn::confirmation()
* @uses GFPaymentAddOn::maybe_validate()
* @uses GFPaymentAddOn::entry_post_save()
*
* @return void
*/
public function init() {
parent::init();
add_filter( 'gform_confirmation', array( $this, 'confirmation' ), 20, 4 );
add_filter( 'gform_validation', array( $this, 'maybe_validate' ), 20 );
add_filter( 'gform_entry_post_save', array( $this, 'entry_post_save' ), 10, 2 );
}
/**
* Runs only when the payment add-on is initialized in the admin.
*
* @since Unknown
* @access public
*
* @uses GFFeedAddOn::init_admin()
* @uses GFPaymentAddOn::$_requires_credit_card
* @uses GFPaymentAddOn::supported_currencies()
* @uses GFPaymentAddOn::entry_deleted()
* @uses GFPaymentAddOn::entry_info()
*
* @return void
*/
public function init_admin() {
parent::init_admin();
if ( $this->_requires_credit_card ) {
// Enable the credit card field.
add_filter( 'gform_enable_credit_card_field', '__return_true' );
}
add_filter( 'gform_currencies', array( $this, 'supported_currencies' ) );
add_filter( 'gform_delete_lead', array( $this, 'entry_deleted' ) );
if ( rgget( 'page' ) == 'gf_entries' ) {
add_action( 'gform_payment_details', array( $this, 'entry_info' ), 10, 2 );
}
}
/**
* Runs only when the payment add-on is initialized on the frontend.
*
* @since Unknown
* @access public
*
* @used-by GFAddOn::init_frontend()
* @uses GFAddOn::init_frontend()
* @uses GFPaymentAddOn::register_creditcard_token_script()
* @uses GFPaymentAddOn::add_creditcard_token_input()
* @uses GFPaymentAddOn::force_ajax_for_creditcard_tokens()
*
* @return void
*/
public function init_frontend() {
parent::init_frontend();
add_filter( 'gform_register_init_scripts', array( $this, 'register_creditcard_token_script' ), 10, 3 );
add_filter( 'gform_field_content', array( $this, 'add_creditcard_token_input' ), 10, 5 );
add_filter( 'gform_form_args', array( $this, 'force_ajax_for_creditcard_tokens' ), 10, 1 );
}
/**
* Runs only when AJAX actions are being performed.
*
* @since Unknown
* @access public
*
* @uses GFFeedAddOn::init_ajax()
* @uses GFPaymentAddOn::ajax_cancel_subscription()
* @uses GFPaymentAddOn::before_delete_field()
*
* @return void
*/
public function init_ajax() {
parent::init_ajax();
add_action( 'wp_ajax_gaddon_cancel_subscription', array( $this, 'ajax_cancel_subscription' ) );
add_action( 'gform_before_delete_field', array( $this, 'before_delete_field' ), 10, 2 );
}
/**
* Runs the setup of the payment add-on.
*
* @since Unknown
* @access public
*
* @uses GFFeedAddOn::setup()
* @uses GFPaymentAddOn::upgrade_payment()
* @uses GFAddOn::$_slug
* @uses GFPaymentAddOn::$_payment_version
*
* @return void
*/
public function setup() {
parent::setup();
$installed_version = get_option( 'gravityformsaddon_payment_version' );
$installed_addons = get_option( 'gravityformsaddon_payment_addons' );
if ( ! is_array( $installed_addons ) ) {
$installed_addons = array();
}
if ( $installed_version != $this->_payment_version ) {
$this->upgrade_payment( $installed_version );
$installed_addons = array( $this->_slug );
update_option( 'gravityformsaddon_payment_addons', $installed_addons );
} elseif ( ! in_array( $this->_slug, $installed_addons ) ) {
$this->upgrade_payment( $installed_version );
$installed_addons[] = $this->_slug;
update_option( 'gravityformsaddon_payment_addons', $installed_addons );
}
update_option( 'gravityformsaddon_payment_version', $this->_payment_version );
}
/**
* Upgrades the payment add-on framework database tables.
*
* Not intended to be used.
*
* @since Unknown
* @access private
*
* @uses GFFormsModel::dbDelta()
* @uses GFPaymentAddOn::$_supports_callbacks
* @uses GFForms::drop_index()
*
* @global $wpdb
* @param null $previous_versions Not used.
*
* @return void
*/
private function upgrade_payment( $previous_versions ) {
global $wpdb;
$charset_collate = GFFormsModel::get_db_charset();
$sql = "CREATE TABLE {$wpdb->prefix}gf_addon_payment_transaction (
id int(10) unsigned not null auto_increment,
lead_id int(10) unsigned not null,
transaction_type varchar(30) not null,
transaction_id varchar(50),
subscription_id varchar(50),
is_recurring tinyint(1) not null default 0,
amount decimal(19,2),
date_created datetime,
PRIMARY KEY (id),
KEY lead_id (lead_id),
KEY transaction_type (transaction_type),
KEY type_lead (lead_id,transaction_type)
) $charset_collate;";
GFFormsModel::dbDelta( $sql );
if ( $this->_supports_callbacks ) {
$sql = "CREATE TABLE {$wpdb->prefix}gf_addon_payment_callback (
id int(10) unsigned not null auto_increment,
lead_id int(10) unsigned not null,
addon_slug varchar(250) not null,
callback_id varchar(250),
date_created datetime,
PRIMARY KEY (id),
KEY addon_slug_callback_id (addon_slug(50),callback_id(100))
) $charset_collate;";
GFFormsModel::dbDelta( $sql );
// Dropping legacy index.
GFForms::drop_index( "{$wpdb->prefix}gf_addon_payment_callback", 'slug_callback_id' );
}
}
//--------- Submission Process ------
/**
* Handles post-submission confirmations.
*
* @since Unknown
* @access public
*
* @uses GFPaymentAddOn::$redirect_url
*
* @param array $confirmation The confirmation details.
* @param array $form The Form Object that the confirmation is being run for.
* @param array $entry The Entry Object associated with the submission.
* @param bool $ajax If the submission was done using AJAX.
*
* @return array The confirmation details.
*/
public function confirmation( $confirmation, $form, $entry, $ajax ) {
if ( empty( $this->redirect_url ) ) {
return $confirmation;
}
$confirmation = array( 'redirect' => $this->redirect_url );
return $confirmation;
}
/**
* Override this function to specify a URL to the third party payment processor.
*
* Useful when developing a payment gateway that processes the payment outside of the website (i.e. PayPal Standard).
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::entry_post_save()
*
* @param array $feed Active payment feed containing all the configuration data.
* @param array $submission_data Contains form field data submitted by the user as well as payment information (i.e. payment amount, setup fee, line items, etc...).
* @param array $form Current form array containing all form settings.
* @param array $entry Current entry array containing entry information (i.e data submitted by users).
*
* @return void|string Return a full URL (including http:// or https://) to the payment processor.
*/
public function redirect_url( $feed, $submission_data, $form, $entry ) {
}
/**
* Check if the rest of the form has passed validation, is the last page, and that the honeypot field has not been completed.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::init()
* @uses GFFormDisplay::is_last_page()
* @uses GFFormDisplay::get_max_field_id()
* @uses GFPaymentAddOn::validation()
*
* @param array $validation_result Contains the validation result, the Form Object, and the failed validation page number.
*
* @return array $validation_result
*/
public function maybe_validate( $validation_result ) {
$form = $validation_result['form'];
$is_last_page = GFFormDisplay::is_last_page( $form );
$failed_honeypot = false;
if ( $is_last_page && rgar( $form, 'enableHoneypot' ) ) {
$honeypot_id = GFFormDisplay::get_max_field_id( $form ) + 1;
$failed_honeypot = ! rgempty( "input_{$honeypot_id}" );
}
// Validation called by partial entries feature via the heartbeat API.
$is_heartbeat = rgpost('action') == 'heartbeat';
if ( ! $validation_result['is_valid'] || ! $is_last_page || $failed_honeypot || $is_heartbeat) {
return $validation_result;
}
return $this->validation( $validation_result );
}
/**
* Handles the validation and processing of payments.
*
* @since Unknown
* @access public
*
* @uses GFPaymentAddOn::get_payment_feed
* @uses GFPaymentAddOn::get_submission_data
* @uses GFPaymentAddOn::$is_payment_gateway
* @uses GFPaymentAddOn::$current_feed
* @uses GFPaymentAddOn::$current_submission_data
* @uses GFPaymentAddOn::payment_method_is_overridden
* @uses GFPaymentAddOn::authorize
* @uses GFPaymentAddOn::subscribe
* @uses GFPaymentAddOn::get_validation_result
* @uses GFPaymentAddOn::$authorization
* @uses GFFeedAddOn::$_single_submission_feed
* @uses GFFormsModel::create_lead
* @uses GFAddOn::log_debug
* @uses GFFormDisplay::set_current_page
*
* @param array $validation_result The validation details to use.
*
* @return array The validation details after completion.
*/
public function validation( $validation_result ) {
if ( ! $validation_result['is_valid'] ) {
return $validation_result;
}
$form = $validation_result['form'];
$entry = GFFormsModel::create_lead( $form );
$feed = $this->get_payment_feed( $entry, $form );
if ( ! $feed ) {
return $validation_result;
}
$submission_data = $this->get_submission_data( $feed, $form, $entry );
//Do not process payment if payment amount is 0
if ( floatval( $submission_data['payment_amount'] ) <= 0 ) {
$this->log_debug( __METHOD__ . '(): Payment amount is zero or less. Not sending to payment gateway.' );
return $validation_result;
}
$this->is_payment_gateway = true;
$this->current_feed = $this->_single_submission_feed = $feed;
$this->current_submission_data = $submission_data;
$performed_authorization = false;
$is_subscription = $feed['meta']['transactionType'] == 'subscription';
if ( $this->payment_method_is_overridden( 'authorize' ) && ! $is_subscription ) {
//Running an authorization only transaction if function is implemented and this is a single payment
$this->authorization = $this->authorize( $feed, $submission_data, $form, $entry );
$performed_authorization = true;
} elseif ( $this->payment_method_is_overridden( 'subscribe' ) && $is_subscription ) {
$subscription = $this->subscribe( $feed, $submission_data, $form, $entry );
$this->authorization['is_authorized'] = rgar($subscription,'is_success');
$this->authorization['error_message'] = rgar( $subscription, 'error_message' );
$this->authorization['subscription'] = $subscription;
$performed_authorization = true;
}
if ( $performed_authorization ) {
$this->log_debug( __METHOD__ . "(): Authorization result for form #{$form['id']} submission => " . print_r( $this->authorization, 1 ) );
}
if ( $performed_authorization && ! rgar( $this->authorization, 'is_authorized' ) ) {
$validation_result = $this->get_validation_result( $validation_result, $this->authorization );
//Setting up current page to point to the credit card page since that will be the highlighted field
GFFormDisplay::set_current_page( $validation_result['form']['id'], $validation_result['credit_card_page'] );
}
return $validation_result;
}
/**
* Override this method to add integration code to the payment processor in order to authorize a credit card with or
* without capturing payment.
*
* This method is executed during the form validation process and allows the form submission process to fail with a
* validation error if there is anything wrong with the payment/authorization. This method is only supported by
* single payments. For subscriptions or recurring payments, use the GFPaymentAddOn::subscribe() method.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::validation()
*
* @param array $feed Current configured payment feed.
* @param array $submission_data Contains form field data submitted by the user as well as payment information
* (i.e. payment amount, setup fee, line items, etc...).
* @param array $form The Form Object.
* @param array $entry The Entry Object. NOTE: the entry hasn't been saved to the database at this point,
* so this $entry object does not have the 'ID' property and is only a memory
* representation of the entry.
*
* @return array {
* Return an $authorization array.
*
* @type bool $is_authorized True if the payment is authorized. Otherwise, false.
* @type string $error_message The error message, if present.
* @type string $transaction_id The transaction ID.
* @type array $captured_payment {
* If payment is captured, an additional array is created.
*
* @type bool $is_success If the payment capture is successful.
* @type string $error_message The error message, if any.
* @type string $transaction_id The transaction ID of the captured payment.
* @type int $amount The amount of the captured payment, if successful.
* }
* }
*/
public function authorize( $feed, $submission_data, $form, $entry ) {
}
/**
* Override this method to capture a single payment that has been authorized via the authorize() method.
*
* Use only with single payments. For subscriptions, use subscribe() instead.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::entry_post_save()
*
* @param array $authorization Contains the result of the authorize() function.
* @param array $feed Current configured payment feed.
* @param array $submission_data Contains form field data submitted by the user as well as payment information.
* (i.e. payment amount, setup fee, line items, etc...).
* @param array $form Current form array containing all form settings.
* @param array $entry Current entry array containing entry information (i.e data submitted by users).
*
* @return array {
* Return an array with the information about the captured payment in the following format:
*
* @type bool $is_success If the payment capture is successful.
* @type string $error_message The error message, if any.
* @type string $transaction_id The transaction ID of the captured payment.
* @type int $amount The amount of the captured payment, if successful.
* @type string $payment_method The card issuer.
* }
*/
public function capture( $authorization, $feed, $submission_data, $form, $entry ) {
}
/**
* Override this method to add integration code to the payment processor in order to create a subscription.
*
* This method is executed during the form validation process and allows the form submission process to fail with a
* validation error if there is anything wrong when creating the subscription.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::validation()
*
* @param array $feed Current configured payment feed.
* @param array $submission_data Contains form field data submitted by the user as well as payment information
* (i.e. payment amount, setup fee, line items, etc...).
* @param array $form Current form array containing all form settings.
* @param array $entry Current entry array containing entry information (i.e data submitted by users).
* NOTE: the entry hasn't been saved to the database at this point, so this $entry
* object does not have the 'ID' property and is only a memory representation of the entry.
*
* @return array {
* Return an $subscription array in the following format:
*
* @type bool $is_success If the subscription is successful.
* @type string $error_message The error message, if applicable.
* @type string $subscription_id The subscription ID.
* @type int $amount The subscription amount.
* @type array $captured_payment {
* If payment is captured, an additional array is created.
*
* @type bool $is_success If the payment capture is successful.
* @type string $error_message The error message, if any.
* @type string $transaction_id The transaction ID of the captured payment.
* @type int $amount The amount of the captured payment, if successful.
* }
*
* To implement an initial/setup fee for gateways that don't support setup fees as part of subscriptions, manually
* capture the funds for the setup fee as a separate transaction and send that payment information in the
* following 'captured_payment' array:
*
* 'captured_payment' => [
* 'name' => 'Setup Fee',
* 'is_success' => true|false,
* 'error_message' => 'error message',
* 'transaction_id' => 'xxx',
* 'amount' => 20
* ]
*/
public function subscribe( $feed, $submission_data, $form, $entry ) {
}
/**
* Override this method to add integration code to the payment processor in order to cancel a subscription.
*
* This method is executed when a subscription is canceled from the Payment Gateway (i.e. Stripe or PayPal).
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::ajax_cancel_subscription()
*
* @param array $entry Current entry array containing entry information (i.e data submitted by users).
* @param array $feed Current configured payment feed.
*
* @return bool Returns true if the subscription was cancelled successfully and false otherwise.
*
*/
public function cancel( $entry, $feed ) {
return false;
}
/**
* Gets the payment validation result.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::validation()
*
* @param array $validation_result Contains the form validation results.
* @param array $authorization_result Contains the form authorization results.
*
* @return array The validation result for the credit card field.
*/
public function get_validation_result( $validation_result, $authorization_result ) {
$credit_card_page = 0;
foreach ( $validation_result['form']['fields'] as &$field ) {
if ( $field->type == 'creditcard' ) {
$field->failed_validation = true;
$field->validation_message = $authorization_result['error_message'];
$credit_card_page = $field->pageNumber;
break;
}
}
$validation_result['credit_card_page'] = $credit_card_page;
$validation_result['is_valid'] = false;
return $validation_result;
}
/**
* Handles additional processing after an entry is saved.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::init()
* @uses GFPaymentAddOn::$is_payment_gateway
* @uses GFPaymentAddOn::$current_feed
* @uses GFPaymentAddOn::$authorization
* @uses GFPaymentAddOn::process_subscription()
* @uses GFPaymentAddOn::payment_method_is_overridden()
* @uses GFPaymentAddOn::process_capture()
* @uses GFPaymentAddOn::redirect_url()
*
* @param array $entry The Entry Object.
* @param array $form The Form Object.
*
* @return array The Entry Object.
*/
public function entry_post_save( $entry, $form ) {
if ( ! $this->is_payment_gateway ) {
return $entry;
}
$feed = $this->current_feed;
if ( ! empty( $this->authorization ) ) {
// If an authorization was done, capture it.
if ( $feed['meta']['transactionType'] == 'subscription' ) {
$entry = $this->process_subscription( $this->authorization, $feed, $this->current_submission_data, $form, $entry );
} else {
if ( $this->payment_method_is_overridden( 'capture' ) && rgempty( 'captured_payment', $this->authorization ) ) {
$this->authorization['captured_payment'] = $this->capture( $this->authorization, $feed, $this->current_submission_data, $form, $entry );
}
$entry = $this->process_capture( $this->authorization, $feed, $this->current_submission_data, $form, $entry );
}
} elseif ( $this->payment_method_is_overridden( 'redirect_url' ) ) {
// If the url_redirect() function is overridden, call it.
// Getting URL to redirect to ( saved to be used by the confirmation() function ).
$this->redirect_url = $this->redirect_url( $feed, $this->current_submission_data, $form, $entry );
// Setting transaction_type to subscription or one time payment.
$entry['transaction_type'] = rgars( $feed, 'meta/transactionType' ) == 'subscription' ? 2 : 1;
$entry['payment_status'] = 'Processing';
}
// Saving which gateway was used to process this entry.
gform_update_meta( $entry['id'], 'payment_gateway', $this->_slug );
return $entry;
}
/**
* Processed the capturing of payments.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::entry_post_save()
* @uses GFPaymentAddOn::complete_authorization()
* @uses GFPaymentAddOn::complete_payment()
* @uses GFPaymentAddOn::fail_payment()
*
* @param array $authorization The payment authorization details.
* @param array $feed The Feed Object.
* @param array $submission_data The form submission data.
* @param array $form The Form Object.
* @param array $entry The Entry Object.
*
* @return array The Entry Object.
*/
public function process_capture( $authorization, $feed, $submission_data, $form, $entry ) {
$payment = rgar( $authorization, 'captured_payment' );
if ( empty( $payment ) && rgar( $authorization, 'is_authorized' ) ) {
if ( ! rgar( $authorization, 'amount' ) ) {
$authorization['amount'] = rgar( $submission_data, 'payment_amount' );
}
$this->complete_authorization( $entry, $authorization );
return $entry;
}
$this->log_debug( __METHOD__ . "(): Updating entry #{$entry['id']} with result => " . print_r( $payment, 1 ) );
if ( $payment['is_success'] ) {
$entry['is_fulfilled'] = '1';
$payment['payment_status'] = 'Paid';
$payment['payment_date'] = gmdate( 'Y-m-d H:i:s' );
$payment['type'] = 'complete_payment';
$this->complete_payment( $entry, $payment );
} else {
$entry['payment_status'] = 'Failed';
$payment['type'] = 'fail_payment';
$payment['note'] = sprintf( esc_html__( 'Payment failed to be captured. Reason: %s', 'gravityforms' ), $payment['error_message'] );
$this->fail_payment( $entry, $payment );
}
return $entry;
}
/**
* Processes payment subscriptions.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::entry_post_save()
* @uses GFPaymentAddOn::insert_transaction()
* @uses GFCommon::to_money()
* @uses GFAddOn::add_note()
* @uses GFPaymentAddOn::start_subscription()
* @uses GFAPI::update_entry()
* @uses GFPaymentAddOn::post_payment_action()
*
* @param array $authorization The payment authorization details.
* @param array $feed The Feed Object.
* @param array $submission_data The form submission data.
* @param array $form The Form Object.
* @param array $entry The Entry Object.
*
* @return array The Entry Object.
*/
public function process_subscription( $authorization, $feed, $submission_data, $form, $entry ) {
$subscription = rgar( $authorization, 'subscription' );
if ( empty( $subscription ) ) {
return $entry;
}
$this->log_debug( __METHOD__ . "(): Updating entry #{$entry['id']} with result => " . print_r( $subscription, 1 ) );
// If setup fee / trial is captured as part of a separate transaction.
$payment = rgar( $subscription, 'captured_payment' );
$payment_name = rgempty( 'name', $payment ) ? esc_html__( 'Initial payment', 'gravityforms' ) : $payment['name'];
if ( $payment && $payment['is_success'] ) {
$this->insert_transaction( $entry['id'], 'payment', $payment['transaction_id'], $payment['amount'], false, rgar( $subscription, 'subscription_id' ) );
$amount_formatted = GFCommon::to_money( $payment['amount'], $entry['currency'] );
$note = sprintf( esc_html__( '%s has been captured successfully. Amount: %s. Transaction Id: %s', 'gravityforms' ), $payment_name, $amount_formatted, $payment['transaction_id'] );
$this->add_note( $entry['id'], $note, 'success' );
} elseif ( $payment && ! $payment['is_success'] ) {
$this->add_note( $entry['id'], sprintf( esc_html__( 'Failed to capture %s. Reason: %s.', 'gravityforms' ), $payment['error_message'], $payment_name ), 'error' );
}
// Updating subscription information.
if ( $subscription['is_success'] ) {
$entry = $this->start_subscription( $entry, $subscription );
} else {
$entry['payment_status'] = 'Failed';
GFAPI::update_entry( $entry );
$this->add_note( $entry['id'], sprintf( esc_html__( 'Subscription failed to be created. Reason: %s', 'gravityforms' ), $subscription['error_message'] ), 'error' );
$subscription['type'] = 'fail_create_subscription';
$this->post_payment_action( $entry, $subscription );
}
return $entry;
}
/**
* Inserts a new transaction item.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::add_subscription_payment()
* @used-by GFPaymentAddOn::complete_authorization()
* @used-by GFPaymentAddOn::process_subscription()
* @used-by GFPaymentAddOn::refund_payment()
* @uses wpdb::get_var()
* @uses wpdb::prepare()
* @uses wpdb::query()
* @uses wpdb::$insert_id
*
* @global wpdb $wpdb The wpdb object.
* @param int $entry_id The entry ID that contains the transaction.
* @param string $transaction_type The transaction type.
* @param string $transaction_id The ID of the transaction to be inserted.
* @param float $amount The transaction amount.
* @param int|null $is_recurring If the transaction is recurring. Defaults to null.
* @param string|null $subscription_id The subscription ID tied to the transaction, if related to a subscription.
* Defaults to null.
*
* @return int|WP_Error The row ID from the database entry. WP_Error if error.
*/
public function insert_transaction( $entry_id, $transaction_type, $transaction_id, $amount, $is_recurring = null, $subscription_id = null ) {
global $wpdb;
// @todo: make sure stats does not show setup fee as a recurring payment
$payment_count = $wpdb->get_var( $wpdb->prepare( "SELECT count(id) FROM {$wpdb->prefix}gf_addon_payment_transaction WHERE lead_id=%d", $entry_id ) );
$is_recurring = $payment_count > 0 && $transaction_type == 'payment' ? 1 : 0;
$subscription_id = empty( $subscription_id ) ? '' : $subscription_id;
$sql = $wpdb->prepare(
" INSERT INTO {$wpdb->prefix}gf_addon_payment_transaction (lead_id, transaction_type, transaction_id, amount, is_recurring, date_created, subscription_id)
values(%d, %s, %s, %f, %d, utc_timestamp(), %s)", $entry_id, $transaction_type, $transaction_id, $amount, $is_recurring, $subscription_id
);
$wpdb->query( $sql );
$txn_id = $wpdb->insert_id;
/**
* Fires after a payment transaction is created in Gravity Forms.
*
* @since Unknown
*
* @param int $txn_id The overall Transaction ID.
* @param int $entry_id The new Entry ID.
* @param string $transaction_type The Type of transaction that was made.
* @param int $transaction_id The transaction ID.
* @param string $amount The amount payed in the transaction.
* @param bool $is_recurring True or false if this is an ongoing payment.
*/
do_action( 'gform_post_payment_transaction', $txn_id, $entry_id, $transaction_type, $transaction_id, $amount, $is_recurring, $subscription_id );
if ( has_filter( 'gform_post_payment_transaction' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_payment_transaction.' );
}
return $txn_id;
}
/**
* Gets the payment submission feed.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::ajax_cancel_subscription()
* @used-by GFPaymentAddOn::process_callback_action()
* @used-by GFPaymentAddOn::validation()
* @uses GFFeedAddOn::get_feeds_by_entry()
* @uses GFFeedAddOn::get_feed()
* @uses GFFeedAddOn::get_feeds()
* @uses GFFeedAddOn::pre_process_feeds()
* @uses GFFeedAddOn::is_feed_condition_met()
*
* @param array $entry The Entry Object.
* @param bool|array $form The Form Object. Defaults to false.
*
* @return array The submission feed.
*/
public function get_payment_feed( $entry, $form = false ) {
$submission_feed = false;
// Only occurs if entry has already been processed and feed has been stored in entry meta.
if ( $entry['id'] ) {
$feeds = $this->get_feeds_by_entry( $entry['id'] );
$submission_feed = empty( $feeds ) ? false : $this->get_feed( $feeds[0] );
} elseif ( $form ) {
// Getting all feeds.
$feeds = $this->get_feeds( $form['id'] );
$feeds = $this->pre_process_feeds( $feeds, $entry, $form );
foreach ( $feeds as $feed ) {
if ( $feed['is_active'] && $this->is_feed_condition_met( $feed, $form, $entry ) ) {
$submission_feed = $feed;
break;
}
}
}
return $submission_feed;
}
/**
* Determines if this is a payment gateway add-on.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::entry_info()
* @uses GFPaymentAddOn::$is_payment_gateway()
* @uses GFAddOn::$_slug
*
* @param int $entry_id The entry ID.
*
* @return bool True if it is a payment gateway. False otherwise.
*/
public function is_payment_gateway( $entry_id ) {
if ( $this->is_payment_gateway ) {
return true;
}
$gateway = gform_get_meta( $entry_id, 'payment_gateway' );
return $gateway == $this->_slug;
}
/**
* Gets the payment submission data.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::validation()
* @uses GFPaymentAddOn::billing_info_fields()
* @uses GFPaymentAddOn::get_credit_card_field()
* @uses GFAddOn::get_field_value()
* @uses GFPaymentAddOn::remove_spaces_from_card_number()
* @uses GFPaymentAddOn::get_order_data()
*
* @param array $feed The Feed Object.
* @param array $form The Form Object.
* @param array $entry The Entry Object.
*
* @return array The payment submission data.
*/
public function get_submission_data( $feed, $form, $entry ) {
$submission_data = array();
$submission_data['form_title'] = $form['title'];
// Getting mapped field data.
$billing_fields = $this->billing_info_fields();
foreach ( $billing_fields as $billing_field ) {
$field_name = $billing_field['name'];
$input_id = rgar( $feed['meta'], "billingInformation_{$field_name}" );
$submission_data[ $field_name ] = $this->get_field_value( $form, $entry, $input_id );
}
// Getting credit card field data.
$card_field = $this->get_credit_card_field( $form );
if ( $card_field ) {
$submission_data['card_number'] = $this->remove_spaces_from_card_number( rgpost( "input_{$card_field->id}_1" ) );
$submission_data['card_expiration_date'] = rgpost( "input_{$card_field->id}_2" );
$submission_data['card_security_code'] = rgpost( "input_{$card_field->id}_3" );
$submission_data['card_name'] = rgpost( "input_{$card_field->id}_5" );
}
// Getting product field data.
$order_info = $this->get_order_data( $feed, $form, $entry );
$submission_data = array_merge( $submission_data, $order_info );
/**
* Enables the Submission Data to be modified before it is used during feed processing by the payment add-on.
*
* @since 1.9.12.8
*
* @param array $submission_data The customer and transaction data.
* @param array $feed The Feed Object.
* @param array $form The Form Object.
* @param array $entry The Entry Object.
*
* @return array $submission_data
*/
return gf_apply_filters( array( 'gform_submission_data_pre_process_payment', $form['id'] ), $submission_data, $feed, $form, $entry );
}
/**
* Gets the credit card field object.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::before_delete_field()
* @used-by GFPaymentAddOn::get_submission_data()
* @used-by GFPaymentAddOn::has_credit_card_field()
* @uses GFAPI::get_fields_by_type()
*
* @param array $form The Form Object.
*
* @return bool|GF_Field_CreditCard The credit card field object, if found. Otherwise, false.
*/
public function get_credit_card_field( $form ) {
$fields = GFAPI::get_fields_by_type( $form, array( 'creditcard' ) );
return empty( $fields ) ? false : $fields[0];
}
/**
* Checks if a form has a credit card field.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::feed_list_message()
* @uses GFPaymentAddOn::get_credit_card_field()
*
* @param array $form The Form Object.
*
* @return bool True if the form has a credit card field. False otherwise.
*/
public function has_credit_card_field( $form ) {
return $this->get_credit_card_field( $form ) !== false;
}
/**
* Gets payment order data.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::get_submission_data()
* @uses GFCommon::get_product_fields()
* @uses GFCommon::to_number()
*
* @param array $feed The Feed Object.
* @param array $form The Form Object.
* @param array $entry The Entry Object.
*
* @return array {
* The order data.
*
* @type float $payment_amount The payment amount of the order.
* @type float $setup_fee The setup fee, if any.
* @type float $trial The trial fee, if any.
* @type float $discounts Discounts applied, if any.
* }
*/
public function get_order_data( $feed, $form, $entry ) {
$products = GFCommon::get_product_fields( $form, $entry );
$payment_field = $feed['meta']['transactionType'] == 'product' ? rgars( $feed, 'meta/paymentAmount' ) : rgars( $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'], $entry['currency'] );
$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;
$description = '';
if ( ! empty( $options ) ) {
$description = esc_html__( 'options: ', 'gravityforms' ) . ' ' . implode( ', ', $options );
}
if ( $product_price >= 0 ) {
$line_items[] = array(
'id' => $field_id,
'name' => $product['name'],
'description' => $description,
'quantity' => $quantity,
'unit_price' => GFCommon::to_number( $product_price, $entry['currency'] ),
'options' => rgar( $product, 'options' )
);
} else {
$discounts[] = array(
'id' => $field_id,
'name' => $product['name'],
'description' => $description,
'quantity' => $quantity,
'unit_price' => GFCommon::to_number( $product_price, $entry['currency'] ),
'options' => rgar( $product, 'options' )
);
}
}
if ( $trial_field == 'enter_amount' ) {
$trial_amount = rgar( $feed['meta'], 'trial_amount' ) ? GFCommon::to_number( rgar( $feed['meta'], 'trial_amount' ), $entry['currency'] ) : 0;
}
if ( ! empty( $products['shipping']['name'] ) && ! is_numeric( $payment_field ) ) {
$line_items[] = array(
'id' => $products['shipping']['id'],
'name' => $products['shipping']['name'],
'description' => '',
'quantity' => 1,
'unit_price' => GFCommon::to_number( $products['shipping']['price'], $entry['currency'] ),
'is_shipping' => 1
);
$amount += $products['shipping']['price'];
}
return array(
'payment_amount' => $amount,
'setup_fee' => $fee_amount,
'trial' => $trial_amount,
'line_items' => $line_items,
'discounts' => $discounts
);
}
/**
* Checks if the callback should be processed by this payment add-on.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::maybe_process_callback()
* @uses GFAddOn::$_slug
*
* @return bool True if valid. False otherwise.
*/
public function is_callback_valid() {
if ( rgget( 'callback' ) != $this->_slug ) {
return false;
}
return true;
}
//--------- Callback (aka Webhook)----------------
/**
* Conditionally initiates processing of the callback.
*
* Checks to see if the callback is valid, processes callback actions, then returns the appropriate response.
*
* @since Unknown
* @access public
*
* @used-by GFPaymentAddOn::pre_init()
* @uses GFPaymentAddOn::is_callback_valid()
* @uses GFAddOn::$_slug
* @uses GFPaymentAddOn::callback()
* @uses GFPaymentAddOn::display_callback_error()
* @uses GFPaymentAddOn::process_callback_action()
* @uses GFPaymentAddOn::post_callback()
*
* @return void
*/
public function maybe_process_callback() {
// Ignoring requests that are not this addon's callbacks.
if ( ! $this->is_callback_valid() ) {
return;
}
// Returns either false or an array of data about the callback request which payment add-on will then use
// to generically process the callback data
$this->log_debug( __METHOD__ . '(): Initializing callback processing for: ' . $this->_slug );
$callback_action = $this->callback();
$this->log_debug( __METHOD__ . '(): Result from gateway callback => ' . print_r( $callback_action, true ) );
$result = false;
if ( is_wp_error( $callback_action ) ) {
$this->display_callback_error( $callback_action );
} elseif ( $callback_action && is_array( $callback_action ) && rgar( $callback_action, 'type' ) && ! rgar( $callback_action, 'abort_callback' ) ) {
$result = $this->process_callback_action( $callback_action );
$this->log_debug( __METHOD__ . '(): Result of callback action => ' . print_r( $result, true ) );
if ( is_wp_error( $result ) ) {
$this->display_callback_error( $result );
} elseif ( ! $result ) {
status_header( 200 );
echo 'Callback could not be processed.';
} else {
status_header( 200 );
echo 'Callback processed successfully.';
}
} else {
status_header( 200 );
echo 'Callback bypassed';
}
$this->post_callback( $callback_action, $result );
die();
}
/**
* Displays a callback error, if needed.
*
* @since Unknown
* @access public
*
* @uses WP_Error::get_error_data()
* @uses WP_Error::get_error_message()
*
* @param WP_Error $error The error.
*
* @return void
*/
private function display_callback_error( $error ) {
$data = $error->get_error_data();
$status = ! rgempty( 'status_header', $data ) ? $data['status_header'] : 200;
status_header( $status );
echo $error->get_error_message();
}
/**
* Processes callback based on provided data.
*
* @since Unknown
* @access private
*
* @uses GFPaymentAddOn::is_duplicate_callback()
* @uses GFAPI::get_entry()
* @uses GFPaymentAddOn::complete_payment()
* @uses GFPaymentAddOn::refund_payment()
* @uses GFPaymentAddOn::fail_payment()
* @uses GFPaymentAddOn::add_pending_payment()
* @uses GFPaymentAddOn::void_authorization()
* @uses GFPaymentAddOn::start_subscription()
* @uses GFPaymentAddOn::get_payment_feed()
* @uses GFPaymentAddOn::cancel_subscription()
* @uses GFPaymentAddOn::expire_subscription()
* @uses GFPaymentAddOn::add_subscription_payment()
* @uses GFPaymentAddOn::fail_subscription_payment()
* @uses GFPaymentAddOn::register_callback()
*
* @param array $action {
* The action to perform.
*
* @type string $type The callback action type. Required.
* @type string $transaction_id The transaction ID to perform the action on. Required if the action is a payment.
* @type string $subscription_id The subscription ID. Required if this is related to a subscription.
* @type string $amount The transaction amount. Typically required.
* @type int $entry_id The ID of the entry associated with the action. Typically required.
* @type string $transaction_type The transaction type to process this action as. Optional.
* @type string $payment_status The payment status to set the payment to. Optional.
* @type string $note The note to associate with this payment action. Optional.
* }
*
* @return bool|mixed True, unless a custom transaction type defines otherwise.
*/
private function process_callback_action( $action ) {
$this->log_debug( __METHOD__ . '(): Processing callback action.' );
$action = wp_parse_args(
$action, array(
'type' => false,
'amount' => false,
'transaction_type' => false,
'transaction_id' => false,
'subscription_id' => false,
'entry_id' => false,
'payment_status' => false,
'note' => false,
)
);
$result = false;
if ( rgar( $action, 'id' ) && $this->is_duplicate_callback( $action['id'] ) ) {
return new WP_Error( 'duplicate', sprintf( esc_html__( 'This webhook has already been processed (Event Id: %s)', 'gravityforms' ), $action['id'] ) );
}
$entry = GFAPI::get_entry( $action['entry_id'] );
if ( ! $entry || is_wp_error( $entry ) ) {
return $result;
}
/**
* Performs actions before the the payment action callback is processed.
*
* @since Unknown
*
* @param array $action The action array.
* @param array $entry The Entry Object.
*/
do_action( 'gform_action_pre_payment_callback', $action, $entry );
if ( has_filter( 'gform_action_pre_payment_callback' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_action_pre_payment_callback.' );
}
switch ( $action['type'] ) {
case 'complete_payment':
$result = $this->complete_payment( $entry, $action );
break;
case 'refund_payment':
$result = $this->refund_payment( $entry, $action );
break;
case 'fail_payment':
$result = $this->fail_payment( $entry, $action );
break;
case 'add_pending_payment':
$result = $this->add_pending_payment( $entry, $action );
break;
case 'void_authorization':
$result = $this->void_authorization( $entry, $action );
break;
case 'create_subscription':
$result = $this->start_subscription( $entry, $action );
$result = rgar( $result, 'payment_status' ) == 'Active' && rgar( $result, 'transaction_id' ) == rgar( $action, 'subscription_id' );
break;
case 'cancel_subscription':
$feed = $this->get_payment_feed( $entry );
$result = $this->cancel_subscription( $entry, $feed, $action['note'] );
break;
case 'expire_subscription':
$result = $this->expire_subscription( $entry, $action );
break;
case 'add_subscription_payment':
$result = $this->add_subscription_payment( $entry, $action );
break;
case 'fail_subscription_payment':
$result = $this->fail_subscription_payment( $entry, $action );
break;
default:
// Handle custom events.
if ( is_callable( array( $this, rgar( $action, 'callback' ) ) ) ) {
$result = call_user_func_array( array( $this, $action['callback'] ), array( $entry, $action ) );
}
break;
}
if ( rgar( $action, 'id' ) && $result ) {
$this->register_callback( $action['id'], $action['entry_id'] );
}
/**
* Fires right after the payment callback.
*
* @since Unknown
*
* @param array $entry The Entry Object
* @param array $action {
* The action performed.
*
* @type string $type The callback action type. Required.
* @type string $transaction_id The transaction ID to perform the action on. Required if the action is a payment.
* @type string $subscription_id The subscription ID. Required if this is related to a subscription.
* @type string $amount The transaction amount. Typically required.
* @type int $entry_id The ID of the entry associated with the action. Typically required.
* @type string $transaction_type The transaction type to process this action as. Optional.
* @type string $payment_status The payment status to set the payment to. Optional.
* @type string $note The note to associate with this payment action. Optional.
* }
* @param mixed $result The Result Object.
*/
do_action( 'gform_post_payment_callback', $entry, $action, $result );
if ( has_filter( 'gform_post_payment_callback' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_payment_callback.' );
}
return $result;
}
/**
* Registers a callback action.
*
* @since Unknown
* @access public
*
* @uses wpdb::insert()
* @uses GFAddOn::$_slug
*
* @global wpdb $wpdb
* @param string $callback_id The callback ID for the action.
* @param int $entry_id The entry ID associated with the callback.
*
* @return void
*/
public function register_callback( $callback_id, $entry_id ) {
global $wpdb;
$wpdb->insert( "{$wpdb->prefix}gf_addon_payment_callback", array(
'addon_slug' => $this->_slug,
'callback_id' => $callback_id,
'lead_id' => $entry_id,
'date_created' => gmdate( 'Y-m-d H:i:s' )
) );
}
/**
* Checks if a callback is duplicate.
*
* @since Unknown
* @access public
*
* @uses wpdb::$prefix
* @uses wpdb::prepare()
* @uses wpdb::get_var()
*
* @global wpdb $wpdb
* @param string $callback_id The callback ID to chack.
*
* @return bool If the callback is a duplicate, true. Otherwise, false.
*/
public function is_duplicate_callback( $callback_id ) {
global $wpdb;
$sql = $wpdb->prepare( "SELECT id FROM {$wpdb->prefix}gf_addon_payment_callback WHERE addon_slug=%s AND callback_id=%s", $this->_slug, $callback_id );
if ( $wpdb->get_var( $sql ) ) {
return true;
}
return false;
}
public function callback() {
}
public function post_callback( $callback_action, $result ) {
}
// # PAYMENT INTERACTION FUNCTIONS
public function add_pending_payment( $entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( empty( $action['payment_status'] ) ) {
$action['payment_status'] = 'Pending';
}
if ( empty( $action['note'] ) ) {
$amount_formatted = GFCommon::to_money( $action['amount'], $entry['currency'] );
$action['note'] = sprintf( esc_html__( 'Payment is pending. Amount: %s. Transaction Id: %s.', 'gravityforms' ), $amount_formatted, $action['transaction_id'] );
}
GFAPI::update_entry_property( $entry['id'], 'payment_status', $action['payment_status'] );
$this->add_note( $entry['id'], $action['note'] );
$this->post_payment_action( $entry, $action );
return true;
}
public function complete_authorization( &$entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( ! rgar( $action, 'payment_status' ) ) {
$action['payment_status'] = 'Authorized';
}
if ( ! rgar( $action, 'transaction_type' ) ) {
$action['transaction_type'] = 'authorization';
}
if ( ! rgar( $action, 'payment_date' ) ) {
$action['payment_date'] = gmdate( 'y-m-d H:i:s' );
}
$entry['transaction_id'] = rgar( $action, 'transaction_id' );
$entry['transaction_type'] = '1';
$entry['payment_status'] = $action['payment_status'];
if ( ! rgar( $action, 'note' ) ) {
$amount_formatted = GFCommon::to_money( $action['amount'], $entry['currency'] );
$action['note'] = sprintf( esc_html__( 'Payment has been authorized. Amount: %s. Transaction Id: %s.', 'gravityforms' ), $amount_formatted, $action['transaction_id'] );
}
GFAPI::update_entry( $entry );
$this->add_note( $entry['id'], $action['note'], 'success' );
$this->post_payment_action( $entry, $action );
return true;
}
public function complete_payment( &$entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( ! rgar( $action, 'payment_status' ) ) {
$action['payment_status'] = 'Paid';
}
if ( ! rgar( $action, 'transaction_type' ) ) {
$action['transaction_type'] = 'payment';
}
if ( ! rgar( $action, 'payment_date' ) ) {
$action['payment_date'] = gmdate( 'y-m-d H:i:s' );
}
$entry['is_fulfilled'] = '1';
$entry['transaction_id'] = rgar( $action, 'transaction_id' );
$entry['transaction_type'] = '1';
$entry['payment_status'] = $action['payment_status'];
$entry['payment_amount'] = rgar( $action, 'amount' );
$entry['payment_date'] = $action['payment_date'];
$entry['payment_method'] = rgar( $action, 'payment_method' );
if ( ! rgar( $action, 'note' ) ) {
$amount_formatted = GFCommon::to_money( $action['amount'], $entry['currency'] );
$action['note'] = sprintf( esc_html__( 'Payment has been completed. Amount: %s. Transaction Id: %s.', 'gravityforms' ), $amount_formatted, $action['transaction_id'] );
}
GFAPI::update_entry( $entry );
$this->insert_transaction( $entry['id'], $action['transaction_type'], $action['transaction_id'], $action['amount'] );
$this->add_note( $entry['id'], $action['note'], 'success' );
/**
* Fires after a payment is completed through a form
*
* @param array $entry The Entry object
* @param array $action The Action Object
* $action = array(
* 'type' => 'cancel_subscription', // See Below
* 'transaction_id' => '', // What is the ID of the transaction made?
* 'subscription_id' => '', // What is the ID of the Subscription made?
* 'amount' => '0.00', // Amount to charge?
* 'entry_id' => 1, // What entry to check?
* 'transaction_type' => '',
* 'payment_status' => '',
* 'note' => ''
* );
*
* 'type' can be:
*
* - complete_payment
* - refund_payment
* - fail_payment
* - add_pending_payment
* - void_authorization
* - create_subscription
* - cancel_subscription
* - expire_subscription
* - add_subscription_payment
* - fail_subscription_payment
*/
do_action( 'gform_post_payment_completed', $entry, $action );
if ( has_filter( 'gform_post_payment_completed' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_payment_completed.' );
}
$this->post_payment_action( $entry, $action );
return true;
}
public function refund_payment( $entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( empty( $action['payment_status'] ) ) {
$action['payment_status'] = 'Refunded';
}
if ( empty( $action['transaction_type'] ) ) {
$action['transaction_type'] = 'refund';
}
if ( empty( $action['note'] ) ) {
$amount_formatted = GFCommon::to_money( $action['amount'], $entry['currency'] );
$action['note'] = sprintf( esc_html__( 'Payment has been refunded. Amount: %s. Transaction Id: %s.', 'gravityforms' ), $amount_formatted, $action['transaction_id'] );
}
GFAPI::update_entry_property( $entry['id'], 'payment_status', $action['payment_status'] );
$this->insert_transaction( $entry['id'], $action['transaction_type'], $action['transaction_id'], $action['amount'] );
$this->add_note( $entry['id'], $action['note'] );
/**
* Fires after a payment is refunded
*
* @param array $entry The Entry object
* @param array $action The Action Object
* $action = array(
* 'type' => 'cancel_subscription', // See Below
* 'transaction_id' => '', // What is the ID of the transaction made?
* 'subscription_id' => '', // What is the ID of the Subscription made?
* 'amount' => '0.00', // Amount to charge?
* 'entry_id' => 1, // What entry to check?
* 'transaction_type' => '',
* 'payment_status' => '',
* 'note' => ''
* );
*
* 'type' can be:
*
* - complete_payment
* - refund_payment
* - fail_payment
* - add_pending_payment
* - void_authorization
* - create_subscription
* - cancel_subscription
* - expire_subscription
* - add_subscription_payment
* - fail_subscription_payment
*/
do_action( 'gform_post_payment_refunded', $entry, $action );
if ( has_filter( 'gform_post_payment_refunded' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_payment_refunded.' );
}
$this->post_payment_action( $entry, $action );
return true;
}
public function fail_payment( $entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( empty( $action['payment_status'] ) ) {
$action['payment_status'] = 'Failed';
}
if ( empty( $action['note'] ) ) {
$amount_formatted = GFCommon::to_money( $action['amount'], $entry['currency'] );
$action['note'] = sprintf( esc_html__( 'Payment has failed. Amount: %s.', 'gravityforms' ), $amount_formatted );
}
GFAPI::update_entry_property( $entry['id'], 'payment_status', $action['payment_status'] );
$this->add_note( $entry['id'], $action['note'] );
$this->post_payment_action( $entry, $action );
return true;
}
public function void_authorization( $entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( empty( $action['payment_status'] ) ) {
$action['payment_status'] = 'Voided';
}
if ( empty( $action['note'] ) ) {
$action['note'] = sprintf( esc_html__( 'Authorization has been voided. Transaction Id: %s', 'gravityforms' ), $action['transaction_id'] );
}
GFAPI::update_entry_property( $entry['id'], 'payment_status', $action['payment_status'] );
$this->add_note( $entry['id'], $action['note'] );
$this->post_payment_action( $entry, $action );
return true;
}
/**
* Used to start a new subscription. Updates the associcated entry with the payment and transaction details and adds an entry note.
*
* @param [array] $entry Entry object
* @param [string] $subscription_id ID of the subscription
* @param [float] $amount Numeric amount of the initial subscription payment
*
* @return [array] $entry Entry Object
*/
public function start_subscription( $entry, $subscription ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( ! $this->has_subscription( $entry ) ) {
$entry['payment_status'] = 'Active';
$entry['payment_amount'] = $subscription['amount'];
$entry['payment_date'] = ! rgempty( 'subscription_start_date', $subscription ) ? $subscription['subscription_start_date'] : gmdate( 'Y-m-d H:i:s' );
$entry['transaction_id'] = $subscription['subscription_id'];
$entry['transaction_type'] = '2'; // subscription
$entry['is_fulfilled'] = '1';
$result = GFAPI::update_entry( $entry );
$this->add_note( $entry['id'], sprintf( esc_html__( 'Subscription has been created. Subscription Id: %s.', 'gravityforms' ), $subscription['subscription_id'] ), 'success' );
/**
* Fires when someone starts a subscription
*
* @param array $entry Entry Object
* @param array $subscription The new Subscription object
*/
do_action( 'gform_post_subscription_started', $entry, $subscription );
if ( has_filter( 'gform_post_subscription_started' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_subscription_started.' );
}
$subscription['type'] = 'create_subscription';
$this->post_payment_action( $entry, $subscription );
}
return $entry;
}
/**
* A payment on an existing subscription.
*
* @param [array] $data Transaction data including 'amount' and 'subscriber_id'
* @param [array] $entry Entry object
*
* @return true
*/
public function add_subscription_payment( $entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( empty( $action['transaction_type'] ) ) {
$action['transaction_type'] = 'payment';
}
// Set payment status back to active if a previous payment attempt failed.
if ( strtolower( $entry['payment_status'] ) != 'active' ) {
$entry['payment_status'] = 'Active';
GFAPI::update_entry_property( $entry['id'], 'payment_status', 'Active' );
}
if ( empty( $action['note'] ) ) {
$amount_formatted = GFCommon::to_money( $action['amount'], $entry['currency'] );
$action['note'] = sprintf( esc_html__( 'Subscription has been paid. Amount: %s. Subscription Id: %s', 'gravityforms' ), $amount_formatted, $action['subscription_id'] );
}
$transaction_id = ! empty( $action['transaction_id'] ) ? $action['transaction_id'] : $action['subscription_id'];
$this->insert_transaction( $entry['id'], $action['transaction_type'], $transaction_id, $action['amount'], null, rgar( $action, 'subscription_id') );
$this->add_note( $entry['id'], $action['note'], 'success' );
/**
* Fires after a payment is made on an existing subscription.
*
* @param array $entry The Entry Object
* @param array $action The Action Object
* $action = array(
* 'type' => 'cancel_subscription', // See Below
* 'transaction_id' => '', // What is the ID of the transaction made?
* 'subscription_id' => '', // What is the ID of the Subscription made?
* 'amount' => '0.00', // Amount to charge?
* 'entry_id' => 1, // What entry to check?
* 'transaction_type' => '',
* 'payment_status' => '',
* 'note' => ''
* );
*
* 'type' can be:
*
* - complete_payment
* - refund_payment
* - fail_payment
* - add_pending_payment
* - void_authorization
* - create_subscription
* - cancel_subscription
* - expire_subscription
* - add_subscription_payment
* - fail_subscription_payment
*/
do_action( 'gform_post_add_subscription_payment', $entry, $action );
if ( has_filter( 'gform_post_add_subscription_payment' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_add_subscription_payment.' );
}
$this->post_payment_action( $entry, $action );
return true;
}
public function fail_subscription_payment( $entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( empty( $action['note'] ) ) {
$amount_formatted = GFCommon::to_money( $action['amount'], $entry['currency'] );
$action['note'] = sprintf( esc_html__( 'Subscription payment has failed. Amount: %s. Subscription Id: %s.', 'gravityforms' ), $amount_formatted, $action['subscription_id'] );
}
GFAPI::update_entry_property( $entry['id'], 'payment_status', 'Failed' );
$this->add_note( $entry['id'], $action['note'], 'error' );
// keep 'gform_subscription_payment_failed' for backward compatability
/**
* @deprecated Use gform_post_fail_subscription_payment now
*/
do_action( 'gform_subscription_payment_failed', $entry, $action['subscription_id'] );
if ( has_filter( 'gform_subscription_payment_failed' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_subscription_payment_failed.' );
}
/**
* Fires after a subscription payment has failed
*
* @param array $entry The Entry Object
* @param array $action The Action Object
* $action = array(
* 'type' => 'cancel_subscription', // See Below
* 'transaction_id' => '', // What is the ID of the transaction made?
* 'subscription_id' => '', // What is the ID of the Subscription made?
* 'amount' => '0.00', // Amount to charge?
* 'entry_id' => 1, // What entry to check?
* 'transaction_type' => '',
* 'payment_status' => '',
* 'note' => ''
* );
*
* 'type' can be:
*
* - complete_payment
* - refund_payment
* - fail_payment
* - add_pending_payment
* - void_authorization
* - create_subscription
* - cancel_subscription
* - expire_subscription
* - add_subscription_payment
* - fail_subscription_payment
*/
do_action( 'gform_post_fail_subscription_payment', $entry, $action );
if ( has_filter( 'gform_post_fail_subscription_payment' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_fail_subscription_payment.' );
}
$this->post_payment_action( $entry, $action );
return true;
}
public function cancel_subscription( $entry, $feed, $note = null ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( ! $note ) {
$note = sprintf( esc_html__( 'Subscription has been cancelled. Subscription Id: %s.', 'gravityforms' ), $entry['transaction_id'] );
}
if ( strtolower( $entry['payment_status'] ) == 'cancelled' ) {
$this->log_debug( __METHOD__ . '(): Subscription is already canceled.' );
return false;
}
GFAPI::update_entry_property( $entry['id'], 'payment_status', 'Cancelled' );
$this->add_note( $entry['id'], $note );
// Include $subscriber_id as 3rd parameter for backwards compatibility
do_action( 'gform_subscription_canceled', $entry, $feed, $entry['transaction_id'] );
// Include alternative spelling of "cancelled".
do_action( 'gform_subscription_cancelled', $entry, $feed, $entry['transaction_id'] );
if ( has_filter( 'gform_subscription_canceled' ) || has_filter( 'gform_subscription_cancelled' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_subscription_canceled.' );
}
$action = array(
'type' => 'cancel_subscription',
'subscription_id' => $entry['transaction_id'],
'entry_id' => $entry['id'],
'payment_status' => 'Cancelled',
'note' => $note,
);
$this->post_payment_action( $entry, $action );
return true;
}
public function expire_subscription( $entry, $action ) {
$this->log_debug( __METHOD__ . '(): Processing request.' );
if ( empty( $action['note'] ) ) {
$action['note'] = sprintf( esc_html__( 'Subscription has expired. Subscriber Id: %s', 'gravityforms' ), $action['subscription_id'] );
}
GFAPI::update_entry_property( $entry['id'], 'payment_status', 'Expired' );
$this->add_note( $entry['id'], $action['note'] );
$this->post_payment_action( $entry, $action );
return true;
}
public function has_subscription( $entry ) {
if ( rgar( $entry, 'transaction_type' ) == 2 && ! rgempty( 'transaction_id', $entry ) ) {
return true;
} else {
return false;
}
}
public function get_entry_by_transaction_id( $transaction_id ) {
global $wpdb;
$sql = $wpdb->prepare( "SELECT id FROM {$wpdb->prefix}rg_lead WHERE transaction_id = %s", $transaction_id );
$entry_id = $wpdb->get_var( $sql );
// //Try transaction table
// if( empty($entry_id) ){
// $sql = $wpdb->prepare( "SELECT lead_id FROM {$wpdb->prefix}gf_addon_payment_transaction WHERE transaction_id = %s", $transaction_id );
// $entry_id = $wpdb->get_var( $sql );
// }
return $entry_id ? $entry_id : false;
}
/**
* Helper for making the gform_post_payment_action hook available to the various payment interaction methods. Also handles sending notifications for payment events.
*
* @param array $entry
* @param array $action
*/
public function post_payment_action( $entry, $action ) {
do_action( 'gform_post_payment_action', $entry, $action );
if ( has_filter( 'gform_post_payment_action' ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_post_payment_action.' );
}
$form = GFAPI::get_form( $entry['form_id'] );
$supported_events = $this->supported_notification_events( $form );
if ( ! empty( $supported_events ) ) {
GFAPI::send_notifications( $form, $entry, rgar( $action, 'type' ) );
}
}
// -------- Cron --------------------
public function setup_cron() {
// Setting up cron
$cron_name = "{$this->_slug}_cron";
add_action( $cron_name, array( $this, 'check_status' ) );
if ( ! wp_next_scheduled( $cron_name ) ) {
wp_schedule_event( time(), 'hourly', $cron_name );
}
}
public function check_status() {
}
//--------- List Columns ------------
public function feed_list_columns() {
return array(
'feedName' => esc_html__( 'Name', 'gravityforms' ),
'transactionType' => esc_html__( 'Transaction Type', 'gravityforms' ),
'amount' => esc_html__( 'Amount', 'gravityforms' )
);
}
public function get_column_value_transactionType( $feed ) {
switch ( rgar( $feed['meta'], 'transactionType' ) ) {
case 'subscription' :
return esc_html__( 'Subscription', 'gravityforms' );
break;
case 'product' :
return esc_html__( 'Products and Services', 'gravityforms' );
break;
case 'donation' :
return esc_html__( 'Donations', 'gravityforms' );
break;
}
return esc_html__( 'Unsupported transaction type', 'gravityforms' );
}
public function get_column_value_amount( $feed ) {
$form = $this->get_current_form();
$field_id = $feed['meta']['transactionType'] == 'subscription' ? rgars( $feed, 'meta/recurringAmount' ) : rgars( $feed, 'meta/paymentAmount' );
if ( $field_id == 'form_total' ) {
$label = esc_html__( 'Form Total', 'gravityforms' );
} else {
$field = GFFormsModel::get_field( $form, $field_id );
$label = GFCommon::get_label( $field );
}
return $label;
}
//--------- Feed Settings ----------------
public function feed_list_message() {
if ( $this->_requires_credit_card && ! $this->has_credit_card_field( $this->get_current_form() ) ) {
return $this->requires_credit_card_message();
}
return parent::feed_list_message();
}
public function requires_credit_card_message() {
$url = add_query_arg( array( 'view' => null, 'subview' => null ) );
return sprintf( esc_html__( "You must add a Credit Card field to your form before creating a feed. Let's go %sadd one%s!", 'gravityforms' ), "<a href='" . esc_url( $url ) . "'>", '</a>' );
}
public function feed_settings_fields() {
return array(
array(
'description' => '',
'fields' => array(
array(
'name' => 'feedName',
'label' => esc_html__( 'Name', 'gravityforms' ),
'type' => 'text',
'class' => 'medium',
'required' => true,
'tooltip' => '<h6>' . esc_html__( 'Name', 'gravityforms' ) . '</h6>' . esc_html__( 'Enter a feed name to uniquely identify this setup.', 'gravityforms' )
),
array(
'name' => 'transactionType',
'label' => esc_html__( 'Transaction Type', 'gravityforms' ),
'type' => 'select',
'onchange' => "jQuery(this).parents('form').submit();",
'choices' => array(
array(
'label' => esc_html__( 'Select a transaction type', 'gravityforms' ),
'value' => ''
),
array(
'label' => esc_html__( 'Products and Services', 'gravityforms' ),
'value' => 'product'
),
array( 'label' => esc_html__( 'Subscription', 'gravityforms' ), 'value' => 'subscription' ),
),
'tooltip' => '<h6>' . esc_html__( 'Transaction Type', 'gravityforms' ) . '</h6>' . esc_html__( 'Select a transaction type.', 'gravityforms' )
),
)
),
array(
'title' => esc_html__( 'Subscription Settings', 'gravityforms' ),
'dependency' => array(
'field' => 'transactionType',
'values' => array( 'subscription' )
),
'fields' => array(
array(
'name' => 'recurringAmount',
'label' => esc_html__( 'Recurring Amount', 'gravityforms' ),
'type' => 'select',
'choices' => $this->recurring_amount_choices(),
'required' => true,
'tooltip' => '<h6>' . esc_html__( 'Recurring Amount', 'gravityforms' ) . '</h6>' . esc_html__( "Select which field determines the recurring payment amount, or select 'Form Total' to use the total of all pricing fields as the recurring amount.", 'gravityforms' )
),
array(
'name' => 'billingCycle',
'label' => esc_html__( 'Billing Cycle', 'gravityforms' ),
'type' => 'billing_cycle',
'tooltip' => '<h6>' . esc_html__( 'Billing Cycle', 'gravityforms' ) . '</h6>' . esc_html__( 'Select your billing cycle. This determines how often the recurring payment should occur.', 'gravityforms' )
),
array(
'name' => 'recurringTimes',
'label' => esc_html__( 'Recurring Times', 'gravityforms' ),
'type' => 'select',
'choices' => array(
array(
'label' => esc_html__( 'infinite', 'gravityforms' ),
'value' => '0'
)
) + $this->get_numeric_choices( 1, 100 ),
'tooltip' => '<h6>' . esc_html__( 'Recurring Times', 'gravityforms' ) . '</h6>' . esc_html__( 'Select how many times the recurring payment should be made. The default is to bill the customer until the subscription is canceled.', 'gravityforms' )
),
array(
'name' => 'setupFee',
'label' => esc_html__( 'Setup Fee', 'gravityforms' ),
'type' => 'setup_fee',
),
array(
'name' => 'trial',
'label' => esc_html__( 'Trial', 'gravityforms' ),
'type' => 'trial',
'hidden' => $this->get_setting( 'setupFee_enabled' ),
'tooltip' => '<h6>' . esc_html__( 'Trial Period', 'gravityforms' ) . '</h6>' . esc_html__( 'Enable a trial period. The user\'s recurring payment will not begin until after this trial period.', 'gravityforms' )
),
)
),
array(
'title' => esc_html__( 'Products & Services Settings', 'gravityforms' ),
'dependency' => array(
'field' => 'transactionType',
'values' => array( 'product', 'donation' )
),
'fields' => array(
array(
'name' => 'paymentAmount',
'label' => esc_html__( 'Payment Amount', 'gravityforms' ),
'type' => 'select',
'choices' => $this->product_amount_choices(),
'required' => true,
'default_value' => 'form_total',
'tooltip' => '<h6>' . esc_html__( 'Payment Amount', 'gravityforms' ) . '</h6>' . esc_html__( "Select which field determines the payment amount, or select 'Form Total' to use the total of all pricing fields as the payment amount.", 'gravityforms' )
),
)
),
array(
'title' => esc_html__( 'Other Settings', 'gravityforms' ),
'dependency' => array(
'field' => 'transactionType',
'values' => array( 'subscription', 'product', 'donation' )
),
'fields' => $this->other_settings_fields()
),
);
}
public function other_settings_fields() {
$other_settings = array(
array(
'name' => 'billingInformation',
'label' => esc_html__( 'Billing Information', 'gravityforms' ),
'type' => 'field_map',
'field_map' => $this->billing_info_fields(),
'tooltip' => '<h6>' . esc_html__( 'Billing Information', 'gravityforms' ) . '</h6>' . esc_html__( 'Map your Form Fields to the available listed fields.', 'gravityforms' )
),
);
$option_choices = $this->option_choices();
if ( ! empty( $option_choices ) ) {
$other_settings[] = array(
'name' => 'options',
'label' => esc_html__( 'Options', 'gravityforms' ),
'type' => 'checkbox',
'choices' => $option_choices,
);
}
$other_settings[] = array(
'name' => 'conditionalLogic',
'label' => esc_html__( 'Conditional Logic', 'gravityforms' ),
'type' => 'feed_condition',
'tooltip' => '<h6>' . esc_html__( 'Conditional Logic', 'gravityforms' ) . '</h6>' . esc_html__( 'When conditions are enabled, form submissions will only be sent to the payment gateway when the conditions are met. When disabled, all form submissions will be sent to the payment gateway.', 'gravityforms' )
);
return $other_settings;
}
public function settings_billing_cycle( $field, $echo = true ) {
$intervals = $this->supported_billing_intervals();
//get unit so the length drop down is populated with the appropriate numbers for initial load
$unit = $this->get_setting( $field['name'] . '_unit' );
//Length drop down
$interval_keys = array_keys( $intervals );
if ( ! $unit ) {
$first_interval = $intervals[ $interval_keys[0] ];
} else {
$first_interval = $intervals[ $unit ];
}
$length_field = array(
'name' => $field['name'] . '_length',
'type' => 'select',
'choices' => $this->get_numeric_choices( $first_interval['min'], $first_interval['max'] )
);
$html = $this->settings_select( $length_field, false );
//Unit drop down
$choices = array();
foreach ( $intervals as $unit => $interval ) {
if ( ! empty( $interval ) ) {
$choices[] = array( 'value' => $unit, 'label' => $interval['label'] );
}
}
$unit_field = array(
'name' => $field['name'] . '_unit',
'type' => 'select',
'onchange' => "loadBillingLength('" . esc_attr( $field['name'] ) . "')",
'choices' => $choices,
);
$html .= ' ' . $this->settings_select( $unit_field, false );
$html .= "<script type='text/javascript'>var " . $field['name'] . '_intervals = ' . json_encode( $intervals ) . ';</script>';
if ( $echo ) {
echo $html;
}
return $html;
}
public function settings_setup_fee( $field, $echo = true ) {
$enabled_field = array(
'name' => $field['name'] . '_checkbox',
'type' => 'checkbox',
'horizontal' => true,
'choices' => array(
array(
'label' => esc_html__( 'Enabled', 'gravityforms' ),
'name' => $field['name'] . '_enabled',
'value' => '1',
'onchange' => "if(jQuery(this).prop('checked')){jQuery('#{$field['name']}_product').show('slow'); jQuery('#gaddon-setting-row-trial').hide('slow');} else {jQuery('#{$field['name']}_product').hide('slow'); jQuery('#gaddon-setting-row-trial').show('slow');}",
),
)
);
$html = $this->settings_checkbox( $enabled_field, false );
$form = $this->get_current_form();
$is_enabled = $this->get_setting( "{$field['name']}_enabled" );
$product_field = array(
'name' => $field['name'] . '_product',
'type' => 'select',
'class' => $is_enabled ? '' : 'hidden',
'choices' => $this->get_payment_choices( $form )
);
$html .= ' ' . $this->settings_select( $product_field, false );
if ( $echo ) {
echo $html;
}
return $html;
}
public function set_trial_onchange( $field ) {
return "if(jQuery(this).prop('checked')){jQuery('#{$field['name']}_product').show('slow');if (jQuery('#{$field['name']}_product').val() == 'enter_amount'){jQuery('#{$field['name']}_amount').show();}} else {jQuery('#{$field['name']}_product').hide('slow');jQuery('#{$field['name']}_amount').hide();}";
}
public function settings_trial( $field, $echo = true ) {
//--- Enabled field ---
$enabled_field = array(
'name' => $field['name'] . '_checkbox',
'type' => 'checkbox',
'horizontal' => true,
'choices' => array(
array(
'label' => esc_html__( 'Enabled', 'gravityforms' ),
'name' => $field['name'] . '_enabled',
'value' => '1',
'onchange' => $this->set_trial_onchange( $field )
),
)
);
$html = $this->settings_checkbox( $enabled_field, false );
//--- Select Product field ---
$form = $this->get_current_form();
$payment_choices = array_merge( $this->get_payment_choices( $form ), array(
array(
'label' => esc_html__( 'Enter an amount', 'gravityforms' ),
'value' => 'enter_amount'
)
) );
$product_field = array(
'name' => $field['name'] . '_product',
'type' => 'select',
'class' => $this->get_setting( "{$field['name']}_enabled" ) ? '' : 'hidden',
'onchange' => "if(jQuery(this).val() == 'enter_amount'){ jQuery('#{$field['name']}_amount').show();} else { jQuery('#{$field['name']}_amount').hide(); }",
'choices' => $payment_choices,
);
$html .= ' ' . $this->settings_select( $product_field, false );
//--- Trial Amount field ----
$amount_field = array(
'type' => 'text',
'name' => "{$field['name']}_amount",
'class' => $this->get_setting( "{$field['name']}_enabled" ) && $this->get_setting( "{$field['name']}_product" ) == 'enter_amount' ? 'gform_currency' : 'hidden gform_currency',
);
$html .= ' ' . $this->settings_text( $amount_field, false );
if ( $echo ) {
echo $html;
}
return $html;
}
public function recurring_amount_choices() {
$form = $this->get_current_form();
$recurring_choices = $this->get_payment_choices( $form );
$recurring_choices[] = array( 'label' => esc_html__( 'Form Total', 'gravityforms' ), 'value' => 'form_total' );
return $recurring_choices;
}
public function product_amount_choices() {
$form = $this->get_current_form();
$product_choices = $this->get_payment_choices( $form );
$product_choices[] = array( 'label' => esc_html__( 'Form Total', 'gravityforms' ), 'value' => 'form_total' );
return $product_choices;
}
public function option_choices() {
$option_choices = array(
array(
'label' => esc_html__( 'Sample Option', 'gravityforms' ),
'name' => 'sample_option',
'value' => 'sample_option'
),
);
return $option_choices;
}
public function billing_info_fields() {
$fields = array(
array( 'name' => 'email', 'label' => esc_html__( 'Email', 'gravityforms' ), 'required' => false ),
array( 'name' => 'address', 'label' => esc_html__( 'Address', 'gravityforms' ), 'required' => false ),
array( 'name' => 'address2', 'label' => esc_html__( 'Address 2', 'gravityforms' ), 'required' => false ),
array( 'name' => 'city', 'label' => esc_html__( 'City', 'gravityforms' ), 'required' => false ),
array( 'name' => 'state', 'label' => esc_html__( 'State', 'gravityforms' ), 'required' => false ),
array( 'name' => 'zip', 'label' => esc_html__( 'Zip', 'gravityforms' ), 'required' => false ),
array( 'name' => 'country', 'label' => esc_html__( 'Country', 'gravityforms' ), 'required' => false ),
);
return $fields;
}
public function get_numeric_choices( $min, $max ) {
$choices = array();
for ( $i = $min; $i <= $max; $i ++ ) {
$choices[] = array( 'label' => $i, 'value' => $i );
}
return $choices;
}
public function supported_billing_intervals() {
$billing_cycles = array(
'day' => array( 'label' => esc_html__( 'day(s)', 'gravityforms' ), 'min' => 1, 'max' => 365 ),
'week' => array( 'label' => esc_html__( 'week(s)', 'gravityforms' ), 'min' => 1, 'max' => 52 ),
'month' => array( 'label' => esc_html__( 'month(s)', 'gravityforms' ), 'min' => 1, 'max' => 12 ),
'year' => array( 'label' => esc_html__( 'year(s)', 'gravityforms' ), 'min' => 1, 'max' => 10 )
);
return $billing_cycles;
}
public function get_payment_choices( $form ) {
$fields = GFAPI::get_fields_by_type( $form, array( 'product' ) );
$choices = array(
array( 'label' => esc_html__( 'Select a product field', 'gravityforms' ), 'value' => '' ),
);
foreach ( $fields as $field ) {
$field_id = $field->id;
$field_label = RGFormsModel::get_label( $field );
$choices[] = array( 'value' => $field_id, 'label' => $field_label );
}
return $choices;
}
//--------- Stats Page -------------------
public function get_results_page_config() {
return array(
'title' => _x( 'Sales', 'toolbar label', 'gravityforms' ),
'search_title' => _x( 'Filter', 'metabox title', 'gravityforms' ),
'capabilities' => array( 'gravityforms_view_entries' ),
'callbacks' => array(
'fields' => array( $this, 'results_fields' ),
'data' => array( $this, 'results_data' ),
'markup' => array( $this, 'results_markup' ),
'filter_ui' => array( $this, 'results_filter_ui' )
)
);
}
public function results_fields( $form ) {
if ( $this->has_feed( $form['id'] ) ) {
return $form['fields'];
} else {
return false;
}
}
public function results_markup( $html, $data, $form, $fields ) {
$html = "<table width='100%' id='gaddon-results-summary'>
<tr>
<td class='gaddon-results-summary-label'>" . esc_html__( 'Today', 'gravityforms' ) . "</td>
<td class='gaddon-results-summary-label'>" . esc_html__( 'Yesterday', 'gravityforms' ) . "</td>
<td class='gaddon-results-summary-label'>" . esc_html__( 'Last 30 Days', 'gravityforms' ) . "</td>
<td class='gaddon-results-summary-label'>" . esc_html__( 'Total', 'gravityforms' ) . "</td>
</tr>
<tr>
<td class='gaddon-results-summary-data'>
<div class='gaddon-results-summary-data-box'>
<div class='gaddon-results-summary-primary'>{$data['summary']['today']['revenue']}</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['today']['subscriptions']} " . esc_html__( 'subscriptions', 'gravityforms' ) . "</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['today']['orders']} " . esc_html__( 'orders', 'gravityforms' ) . "</div>
</div>
</td>
<td class='gaddon-results-summary-data'>
<div class='gaddon-results-summary-data-box'>
<div class='gaddon-results-summary-primary'>{$data['summary']['yesterday']['revenue']}</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['yesterday']['subscriptions']} " . esc_html__( 'subscriptions', 'gravityforms' ) . "</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['yesterday']['orders']} " . esc_html__( 'orders', 'gravityforms' ) . "</div>
</div>
</td>
<td class='gaddon-results-summary-data'>
<div class='gaddon-results-summary-data-box'>
<div class='gaddon-results-summary-primary'>{$data['summary']['last30']['revenue']}</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['last30']['subscriptions']} " . esc_html__( 'subscriptions', 'gravityforms' ) . "</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['last30']['orders']} " . esc_html__( 'orders', 'gravityforms' ) . "</div>
</div>
</td>
<td class='gaddon-results-summary-data'>
<div class='gaddon-results-summary-data-box'>
<div class='gaddon-results-summary-primary'>{$data['summary']['total']['revenue']}</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['total']['subscriptions']} " . esc_html__( 'subscriptions', 'gravityforms' ) . "</div>
<div class='gaddon-results-summary-secondary'>{$data['summary']['total']['orders']} " . esc_html__( 'orders', 'gravityforms' ) . '</div>
</div>
</td>
</tr>
</table>';
if ( $data['row_count'] == '0' ) {
$html .= "<div class='updated' style='padding:20px; margin-top:40px;'>" . esc_html__( "There aren't any transactions that match your criteria.", 'gravityforms' ) . '</div>';
} else {
$chart_data = $this->get_chart_data( $data );
$html .= $this->get_sales_chart( $chart_data );
//Getting sales table markup
$sales_table = new GFPaymentStatsTable( $data['table']['header'], $data['data'], $data['row_count'], $data['page_size'] );
$sales_table->prepare_items();
ob_start();
$sales_table->display();
$html .= ob_get_clean();
}
$html .= '</form>';
return $html;
}
public function get_chart_data( $data ) {
$hAxis_column = $data['chart']['hAxis']['column'];
$vAxis_column = $data['chart']['vAxis']['column'];
$chart_data = array();
foreach ( $data['data'] as $row ) {
$hAxis_value = $row[ $hAxis_column ];
$chart_data[ $hAxis_value ] = $row[ $vAxis_column ];
}
return array(
'hAxis_title' => $data['chart']['hAxis']['label'],
'vAxis_title' => $data['chart']['vAxis']['label'],
'data' => $chart_data
);
}
public static function get_sales_chart( $sales_data ) {
$markup = '';
$data_table = array();
$data_table[] = array( $sales_data['hAxis_title'], $sales_data['vAxis_title'] );
foreach ( $sales_data['data'] as $key => $value ) {
$data_table[] = array( (string) $key, $value );
}
$chart_options = array(
'series' => array(
'0' => array(
'color' => '#66CCFF',
'visibleInLegend' => 'false',
),
),
'hAxis' => array(
'title' => $sales_data['hAxis_title'],
),
'vAxis' => array(
'title' => $sales_data['vAxis_title'],
)
);
$data_table_json = json_encode( $data_table );
$options_json = json_encode( $chart_options );
$div_id = 'gquiz-results-chart-field-score-frequencies';
$markup .= "<div class='gresults-chart-wrapper' style='width:100%;height:250px' id='{$div_id}'></div>";
$markup .= "<script>
jQuery('#{$div_id}')
.data('datatable',{$data_table_json})
.data('options', {$options_json})
.data('charttype', 'column');
</script>";
return $markup;
}
public function results_data( $form, $fields, $search_criteria, $state_array ) {
$summary = $this->get_sales_summary( $form['id'] );
$data = $this->get_sales_data( $form['id'], $search_criteria, $state_array );
return array(
'entry_count' => $data['row_count'],
'row_count' => $data['row_count'],
'page_size' => $data['page_size'],
'status' => 'complete',
'summary' => $summary,
'data' => $data['rows'],
'chart' => $data['chart'],
'table' => $data['table'],
);
}
private function get_mysql_tz_offset() {
$tz_offset = get_option( 'gmt_offset' );
//add + if offset starts with a number
if ( is_numeric( substr( $tz_offset, 0, 1 ) ) ) {
$tz_offset = '+' . $tz_offset;
}
return $tz_offset . ':00';
}
public function get_sales_data( $form_id, $search, $state ) {
global $wpdb;
$data = array(
'chart' => array(
'hAxis' => array(),
'vAxis' => array(
'column' => 'revenue',
'label' => esc_html__( 'Revenue', 'gravityforms' )
)
),
'table' => array(
'header' => array(
'orders' => esc_html__( 'Orders', 'gravityforms' ),
'subscriptions' => esc_html__( 'Subscriptions', 'gravityforms' ),
'recurring_payments' => esc_html__( 'Recurring Payments', 'gravityforms' ),
'refunds' => esc_html__( 'Refunds', 'gravityforms' ),
'revenue' => esc_html__( 'Revenue', 'gravityforms' )
)
),
'rows' => array()
);
$tz_offset = $this->get_mysql_tz_offset();
$page_size = 10;
$group = strtolower( rgpost( 'group' ) );
switch ( $group ) {
case 'weekly' :
$select = "concat(left(transaction.week,4), ' - ', right(transaction.week,2)) as week";
$select_inner1 = "yearweek(CONVERT_TZ(payment_date, '+00:00', '" . $tz_offset . "')) week";
$select_inner2 = "yearweek(CONVERT_TZ(t.date_created, '+00:00', '" . $tz_offset . "')) week";
$group_by = 'week';
$order_by = 'week desc';
$join = 'lead.week = transaction.week';
$data['chart']['hAxis']['column'] = 'week';
$data['chart']['hAxis']['label'] = esc_html__( 'Week', 'gravityforms' );
$data['table']['header'] = array_merge( array( 'week' => esc_html__( 'Week', 'gravityforms' ) ), $data['table']['header'] );
$current_period_format = 'o - W';
$decrement_period = 'week';
$result_period = 'week';
break;
case 'monthly' :
$select = "date_format(transaction.inner_month, '%%Y') as year, date_format(transaction.inner_month, '%%c') as month, '' as month_abbrev, '' as month_year";
$select_inner1 = "date_format(CONVERT_TZ(payment_date, '+00:00', '" . $tz_offset . "'), '%%Y-%%m-01') inner_month";
$select_inner2 = "date_format(CONVERT_TZ(t.date_created, '+00:00', '" . $tz_offset . "'), '%%Y-%%m-01') inner_month";
$group_by = 'inner_month';
$order_by = 'year desc, (month+0) desc';
$join = 'lead.inner_month = transaction.inner_month';
$data['chart']['hAxis']['column'] = 'month_year';
$data['chart']['hAxis']['label'] = esc_html__( 'Month', 'gravityforms' );
$data['table']['header'] = array_merge( array( 'month_year' => esc_html__( 'Month', 'gravityforms' ) ), $data['table']['header'] );
$current_period_format = 'n'; // Numeric representation of a month, without leading zeros
$decrement_period = 'month';
$result_period = 'month';
break;
default : //daily
$select = "transaction.date, date_format(transaction.date, '%%c') as month, day(transaction.date) as day, dayname(transaction.date) as day_of_week, '' as month_day";
$select_inner1 = "date(CONVERT_TZ(payment_date, '+00:00', '" . $tz_offset . "')) as date";
$select_inner2 = "date(CONVERT_TZ(t.date_created, '+00:00', '" . $tz_offset . "')) as date";
$group_by = 'date';
$order_by = 'date desc';
$join = 'lead.date = transaction.date';
$data['chart']['hAxis']['column'] = 'month_day';
$data['chart']['hAxis']['label'] = esc_html__( 'Day', 'gravityforms' );
$data['table']['header'] = array_merge( array(
'date' => esc_html__( 'Date', 'gravityforms' ),
'day_of_week' => esc_html__( 'Day', 'gravityforms' )
), $data['table']['header'] );
$current_period_format = 'Y-m-d';
$decrement_period = 'day';
$result_period = 'date';
break;
}
$lead_date_filter = '';
$transaction_date_filter = '';
if ( isset( $search['start_date'] ) ) {
$lead_date_filter = $wpdb->prepare( " AND timestampdiff(SECOND, %s, CONVERT_TZ(l.payment_date, '+00:00', '" . $tz_offset . "')) >= 0", $search['start_date'] );
$transaction_date_filter = $wpdb->prepare( " AND timestampdiff(SECOND, %s, CONVERT_TZ(t.date_created, '+00:00', '" . $tz_offset . "')) >= 0", $search['start_date'] );
}
if ( isset( $search['end_date'] ) ) {
$lead_date_filter .= $wpdb->prepare( " AND timestampdiff(SECOND, %s, CONVERT_TZ(l.payment_date, '+00:00', '" . $tz_offset . "')) <= 0", $search['end_date'] );
$transaction_date_filter .= $wpdb->prepare( " AND timestampdiff(SECOND, %s, CONVERT_TZ(t.date_created, '+00:00', '" . $tz_offset . "')) <= 0", $search['end_date'] );
}
$payment_method = rgpost( 'payment_method' );
$payment_method_filter = '';
if ( ! empty( $payment_method ) ) {
$payment_method_filter = $wpdb->prepare( ' AND l.payment_method=%s', $payment_method );
}
$current_page = rgempty( 'paged' ) ? 1 : absint( rgpost( 'paged' ) );
$offset = $page_size * ( $current_page - 1 );
$sql = $wpdb->prepare(
" SELECT SQL_CALC_FOUND_ROWS {$select}, lead.orders, lead.subscriptions, transaction.refunds, transaction.recurring_payments, transaction.revenue
FROM (
SELECT {$select_inner1},
sum( if(transaction_type = 1,1,0) ) as orders,
sum( if(transaction_type = 2,1,0) ) as subscriptions
FROM {$wpdb->prefix}rg_lead l
WHERE l.status='active' AND form_id=%d {$lead_date_filter} {$payment_method_filter}
GROUP BY {$group_by}
) AS lead
RIGHT OUTER JOIN(
SELECT {$select_inner2},
sum( if(t.transaction_type = 'refund', abs(t.amount) * -1, t.amount) ) as revenue,
sum( if(t.transaction_type = 'refund', 1, 0) ) as refunds,
sum( if(t.transaction_type = 'payment' AND t.is_recurring = 1, 1, 0) ) as recurring_payments
FROM {$wpdb->prefix}gf_addon_payment_transaction t
INNER JOIN {$wpdb->prefix}rg_lead l ON l.id = t.lead_id
WHERE l.status='active' AND l.form_id=%d {$lead_date_filter} {$transaction_date_filter} {$payment_method_filter}
GROUP BY {$group_by}
) AS transaction on {$join}
ORDER BY {$order_by}
LIMIT $page_size OFFSET $offset
", $form_id, $form_id
);
GFCommon::log_debug( "sales sql: {$sql}" );
$results = $wpdb->get_results( $sql, ARRAY_A );
$display_results = array();
$current_period = date( $current_period_format );
if ( isset( $search['start_date'] ) || isset( $search['end_date'] ) ) {
foreach ( $results as &$result ) {
$result['orders'] = intval( $result['orders'] );
$result['subscriptions'] = intval( $result['subscriptions'] );
$result['refunds'] = intval( $result['refunds'] );
$result['recurring_payments'] = intval( $result['recurring_payments'] );
$result['revenue'] = floatval( $result['revenue'] );
$result = $this->format_chart_h_axis( $result );
}
$data['row_count'] = $wpdb->get_var( 'SELECT FOUND_ROWS()' );
$data['page_size'] = $page_size;
$data['rows'] = $results;
} else {
$current_date = date( 'Y-m-d' );
$current_period_timestamp = strtotime( $current_date );
for ( $i = 1; $i <= 10 ; $i++ ) {
$result_for_date = false;
foreach ( $results as $result ) {
if ( $result[ $result_period ] == $current_period ) {
$display_result = $result;
$result_for_date = true;
break;
}
}
if ( ! $result_for_date ) {
$display_result = array(
$result_period => $current_period,
'month' => date( 'm', $current_period_timestamp ),
'day' => date( 'd', $current_period_timestamp ),
'day_of_week' => date( 'l', $current_period_timestamp ),
'month_day' => '',
'year' => date( 'Y', $current_period_timestamp ),
'month_abbrev' => '',
'orders' => '0',
'subscriptions' => '0',
'refunds' => '0',
'recurring_payments' => '0',
'revenue' => '0.00',
);
}
$display_result['orders'] = intval( $display_result['orders'] );
$display_result['subscriptions'] = intval( $display_result['subscriptions'] );
$display_result['refunds'] = intval( $display_result['refunds'] );
$display_result['recurring_payments'] = intval( $display_result['recurring_payments'] );
$display_result['revenue'] = floatval( $display_result['revenue'] );
$display_result = $this->format_chart_h_axis( $display_result );
$display_results[] = $display_result;
$decremented_date = $current_date . ' ' . ( $i * -1 ) . ' ' . $decrement_period;
$current_period_timestamp = strtotime( $decremented_date );
$current_period = date( $current_period_format, $current_period_timestamp );
}
$data['row_count'] = $page_size;
$data['page_size'] = $page_size;
$data['rows'] = $display_results;
}
return $data;
}
public function format_chart_h_axis( $result ) {
$months = array(
esc_html__( 'Jan', 'gravityforms' ),
esc_html__( 'Feb', 'gravityforms' ),
esc_html__( 'Mar', 'gravityforms' ),
esc_html__( 'Apr', 'gravityforms' ),
esc_html__( 'May', 'gravityforms' ),
esc_html__( 'Jun', 'gravityforms' ),
esc_html__( 'Jul', 'gravityforms' ),
esc_html__( 'Aug', 'gravityforms' ),
esc_html__( 'Sep', 'gravityforms' ),
esc_html__( 'Oct', 'gravityforms' ),
esc_html__( 'Nov', 'gravityforms' ),
esc_html__( 'Dec', 'gravityforms' ),
);
if ( isset( $result['month_abbrev'] ) ) {
$result['month_abbrev'] = $months[ intval( $result['month'] ) - 1 ];
$result['month_year'] = $months[ intval( $result['month'] ) - 1 ] . ', ' . $result['year'];
return $result;
} elseif ( isset( $result['month_day'] ) ) {
$result['month_day'] = $months[ intval( $result['month'] ) - 1 ] . ' ' . $result['day'];
return $result;
}
return $result;
}
public function get_sales_summary( $form_id ) {
global $wpdb;
$tz_offset = $this->get_mysql_tz_offset();
$summary = $wpdb->get_results(
$wpdb->prepare(
"
SELECT transaction.date, lead.orders, lead.subscriptions, transaction.revenue
FROM (
SELECT date( CONVERT_TZ(payment_date, '+00:00', '" . $tz_offset . "') ) as date,
sum( if(transaction_type = 1,1,0) ) as orders,
sum( if(transaction_type = 2,1,0) ) as subscriptions
FROM {$wpdb->prefix}rg_lead
WHERE status='active' AND form_id = %d AND datediff(now(), CONVERT_TZ(payment_date, '+00:00', '" . $tz_offset . "') ) <= 30
GROUP BY date
) AS lead
RIGHT OUTER JOIN(
SELECT date( CONVERT_TZ(t.date_created, '+00:00', '" . $tz_offset . "') ) as date,
sum( if(t.transaction_type = 'refund', abs(t.amount) * -1, t.amount) ) as revenue
FROM {$wpdb->prefix}gf_addon_payment_transaction t
INNER JOIN {$wpdb->prefix}rg_lead l ON l.id = t.lead_id
WHERE l.form_id=%d AND l.status='active'
GROUP BY date
) AS transaction on lead.date = transaction.date
ORDER BY date desc", $form_id, $form_id
), ARRAY_A
);
$total_summary = $wpdb->get_results(
$wpdb->prepare(
"
SELECT sum( if(transaction_type = 1,1,0) ) as orders,
sum( if(transaction_type = 2,1,0) ) as subscriptions
FROM {$wpdb->prefix}rg_lead
WHERE form_id=%d AND status='active'", $form_id
), ARRAY_A
);
$total_revenue = $wpdb->get_var(
$wpdb->prepare(
"
SELECT sum( if(t.transaction_type = 'refund', abs(t.amount) * -1, t.amount) ) as revenue
FROM {$wpdb->prefix}gf_addon_payment_transaction t
INNER JOIN {$wpdb->prefix}rg_lead l ON l.id = t.lead_id
WHERE l.form_id=%d AND status='active'", $form_id
)
);
$result = array(
'today' => array( 'revenue' => GFCommon::to_money( 0 ), 'orders' => 0, 'subscriptions' => 0 ),
'yesterday' => array( 'revenue' => GFCommon::to_money( 0 ), 'orders' => 0, 'subscriptions' => 0 ),
'last30' => array( 'revenue' => 0, 'orders' => 0, 'subscriptions' => 0 ),
'total' => array(
'revenue' => GFCommon::to_money( $total_revenue ),
'orders' => $total_summary[0]['orders'],
'subscriptions' => $total_summary[0]['subscriptions']
)
);
$local_time = GFCommon::get_local_timestamp();
$today = gmdate( 'Y-m-d', $local_time );
$yesterday = gmdate( 'Y-m-d', strtotime( '-1 day', $local_time ) );
foreach ( $summary as $day ) {
if ( $day['date'] == $today ) {
$result['today']['revenue'] = GFCommon::to_money( $day['revenue'] );
$result['today']['orders'] = $day['orders'];
$result['today']['subscriptions'] = $day['subscriptions'];
} elseif ( $day['date'] == $yesterday ) {
$result['yesterday']['revenue'] = GFCommon::to_money( $day['revenue'] );
$result['yesterday']['orders'] = $day['orders'];
$result['yesterday']['subscriptions'] = $day['subscriptions'];
}
$is_within_30_days = strtotime( $day['date'] ) >= strtotime( '-30 days', $local_time );
if ( $is_within_30_days ) {
$result['last30']['revenue'] += floatval( $day['revenue'] );
$result['last30']['orders'] += floatval( $day['orders'] );
$result['last30']['subscriptions'] += floatval( $day['subscriptions'] );
}
}
$result['last30']['revenue'] = GFCommon::to_money( $result['last30']['revenue'] );
return $result;
}
public function results_filter_ui( $filter_ui, $form_id, $page_title, $gf_page, $gf_view ) {
if ( $gf_view == "gf_results_{$this->_slug}" ) {
unset( $filter_ui['fields'] );
}
$view_markup = "<div>
<select id='gaddon-sales-group' name='group'>
<option value='daily' " . selected( 'daily', rgget( 'group' ), false ) . '>' . esc_html__( 'Daily', 'gravityforms' ) . "</option>
<option value='weekly' " . selected( 'weekly', rgget( 'group' ), false ) . '>' . esc_html__( 'Weekly', 'gravityforms' ) . "</option>
<option value='monthly' " . selected( 'monthly', rgget( 'group' ), false ) . '>' . esc_html__( 'Monthly', 'gravityforms' ) . '</option>
</select>
</div>';
$view_filter = array(
'view' => array(
'label' => esc_html__( 'View', 'gravityforms' ),
'tooltip' => '<h6>' . esc_html__( 'View', 'gravityforms' ) . '</h6>' . esc_html__( 'Select how you would like the sales data to be displayed.', 'gravityforms' ),
'markup' => $view_markup
)
);
$payment_methods = $this->get_payment_methods( $form_id );
$payment_method_markup = "
<div>
<select id='gaddon-sales-group' name='payment_method'>
<option value=''>" . esc_html__( _x( 'Any', 'regarding a payment method', 'gravityforms' ) ) . '</option>';
foreach ( $payment_methods as $payment_method ) {
$payment_method_markup .= "<option value='" . esc_attr( $payment_method ) . "' " . selected( $payment_method, rgget( 'payment_method' ), false ) . '>' . $payment_method . '</option>';
}
$payment_method_markup .= '
</select>
</div>';
$payment_method_filter = array(
'payment_method' => array(
'label' => esc_html__( 'Payment Method', 'gravityforms' ),
'tooltip' => '',
'markup' => $payment_method_markup
)
);
$filter_ui = array_merge( $view_filter, $payment_method_filter, $filter_ui );
return $filter_ui;
}
public function get_payment_methods( $form_id ) {
global $wpdb;
$payment_methods = $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT payment_method FROM {$wpdb->prefix}rg_lead WHERE form_id=%d", $form_id ) );
return array_filter( $payment_methods, array( $this, 'array_filter_non_blank' ) );
}
public function array_filter_non_blank( $value ) {
if ( empty( $value ) || $value == 'null' ) {
return false;
}
return true;
}
//-------- Uninstall ---------------------
public function uninstall() {
global $wpdb;
// deleting transactions
$sql = $wpdb->prepare(
"DELETE FROM {$wpdb->prefix}gf_addon_payment_transaction
WHERE lead_id IN
(SELECT lead_id FROM {$wpdb->prefix}rg_lead_meta WHERE meta_key='payment_gateway' AND meta_value=%s)", $this->_slug
);
$wpdb->query( $sql );
// deleting callback log
$sql = $wpdb->prepare( "DELETE FROM {$wpdb->prefix}gf_addon_payment_callback WHERE addon_slug=%s", $this->_slug );
$wpdb->query( $sql );
//clear cron
wp_clear_scheduled_hook( $this->_slug . '_cron' );
parent::uninstall();
}
//-------- Scripts -----------------------
public function scripts() {
$min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG || isset( $_GET['gform_debug'] ) ? '' : '.min';
$scripts = array(
array(
'handle' => 'gaddon_payment',
'src' => $this->get_gfaddon_base_url() . "/js/gaddon_payment{$min}.js",
'version' => GFCommon::$version,
'strings' => array(
'subscriptionCancelWarning' => __( "Warning! This subscription will be canceled. This cannot be undone. 'OK' to cancel subscription, 'Cancel' to stop", 'gravityforms' ),
'subscriptionCancelNonce' => wp_create_nonce( 'gaddon_cancel_subscription' ),
'subscriptionCanceled' => __( 'Canceled', 'gravityforms' ),
'subscriptionError' => __( 'The subscription could not be canceled. Please try again later.', 'gravityforms' )
),
'enqueue' => array(
array( 'admin_page' => array( 'form_settings' ), 'tab' => $this->_slug ),
array( 'admin_page' => array( 'entry_view' ) ),
)
),
array(
'handle' => 'gaddon_token',
'src' => $this->get_gfaddon_base_url() . "/js/gaddon_token{$min}.js",
'version' => GFCommon::$version,
'deps' => array( 'jquery' ),
'in_footer' => false,
'enqueue' => array(
array( $this, 'enqueue_creditcard_token_script' )
)
),
array(
'handle' => 'gform_form_admin',
'enqueue' => array(
array( 'admin_page' => array( 'entry_edit' ) ),
),
),
);
return array_merge( parent::scripts(), $scripts );
}
//----- Javascript Credit Card Tokens ----
/**
* Override to support creating credit card tokens via Javascript.
*
* @access public
*
* @param mixed $form
*
* @return array
*/
public function creditcard_token_info( $form ) {
return array();
}
/**
* Add input field for credit card token response.
*
* @access public
*
* @param string $content
* @param array $field
* @param string $value
* @param string $entry_id
* @param string $form_id
*
* @return string
*/
public function add_creditcard_token_input( $content, $field, $value, $entry_id, $form_id ) {
if ( ! $this->has_feed( $form_id ) || GFFormsModel::get_input_type( $field ) != 'creditcard' ) {
return $content;
}
$form = GFAPI::get_form( $form_id );
if ( ! $this->creditcard_token_info( $form ) ) {
return $content;
}
$slug = str_replace( 'gravityforms', '', $this->_slug );
$content .= '<input type=\'hidden\' name=\'' . $slug . '_response\' id=\'gf_' . $slug . '_response\' value=\'' . rgpost( $slug . '_response' ) . '\' />';
return $content;
}
/**
* Enables AJAX for forms that create credit card tokens via Javascript.
*
* @access public
*
* @param array $args
*
* @return array
*/
public function force_ajax_for_creditcard_tokens( $args ) {
$form = GFAPI::get_form( rgar( $args, 'form_id' ) );
$args['ajax'] = $this->enqueue_creditcard_token_script( $form ) ? true : $args['ajax'];
return $args;
}
/**
* Determines if GFToken script should be enqueued.
*
* @access public
*
* @param array $form
*
* @return bool
*/
public function enqueue_creditcard_token_script( $form ) {
return $form && $this->has_feed( $form['id'] ) && $this->creditcard_token_info( $form );
}
/**
* Prepare Javascript for creating credit card tokens.
*
* @access public
*
* @param array $form
* @param array $field_values
* @param bool $is_ajax
*
* @return void
*/
public function register_creditcard_token_script( $form, $field_values, $is_ajax ) {
if ( ! $this->enqueue_creditcard_token_script( $form ) ) {
return;
}
/* Prepare GFToken object. */
$gftoken = array(
'callback' => 'GF_' . str_replace( ' ', '', $this->_short_title ),
'feeds' => $this->creditcard_token_info( $form ),
'formId' => rgar( $form, 'id' ),
'hasPages' => GFCommon::has_pages( $form ),
'pageCount' => GFFormDisplay::get_max_page_number( $form ),
'responseField' => '#gf_' . str_replace( 'gravityforms', '', $this->_slug ) . '_response'
);
/* Get needed fields. */
$gftoken['fields'] = $this->get_creditcard_token_entry_fields( $gftoken['feeds'] );
$script = 'new GFToken( ' . json_encode( $gftoken ) . ' );';
GFFormDisplay::add_init_script( $form['id'], 'GFToken', GFFormDisplay::ON_PAGE_RENDER, $script );
}
/**
* Get needed fields for creating credit card tokens.
*
* @access public
*
* @param array $feeds
*
* @return array $fields
*/
public function get_creditcard_token_entry_fields( $feeds ) {
$fields = array();
foreach ( $feeds as $feed ) {
foreach ( $feed['billing_fields'] as $billing_field ) {
$fields[] = $billing_field;
}
}
return array_unique( $fields );
}
//-------- Currency ----------------------
/**
* Override this function to add or remove currencies from the list of supported currencies
*
* @param $currencies - Currently supported currencies
*
* @return mixed - A filtered list of supported currencies
*/
public function supported_currencies( $currencies ) {
return $currencies;
}
/**
* Retrieve the currency object for the specified currency code.
*
* @param string $currency_code
*
* @return RGCurrency
*/
public function get_currency( $currency_code = '' ) {
if ( ! class_exists( 'RGCurrency' ) ) {
require_once( GFCommon::get_base_path() . '/currency.php' );
}
if ( empty( $currency_code ) ) {
$currency_code = GFCommon::get_currency();
}
return new RGCurrency( $currency_code );
}
/**
* Format the amount for export to the payment gateway.
*
* Removes currency symbol and if required converts the amount to the smallest unit required by the gateway (e.g. dollars to cents).
*
* @param int|float $amount The value to be formatted.
* @param string $currency_code The currency code.
*
* @return int|float
*/
public function get_amount_export( $amount, $currency_code = '' ) {
$currency = $this->get_currency( $currency_code );
$amount = $currency->to_number( $amount );
if ( $this->_requires_smallest_unit && ! $currency->is_zero_decimal() ) {
return $amount * 100;
}
return $amount;
}
/**
* If necessary convert the amount back from the smallest unit required by the gateway (e.g cents to dollars).
*
* @param int|float $amount The value to be formatted.
* @param string $currency_code The currency code.
*
* @return int|float
*/
public function get_amount_import( $amount, $currency_code = '' ) {
$currency = $this->get_currency( $currency_code );
if ( $this->_requires_smallest_unit && ! $currency->is_zero_decimal() ) {
return $amount / 100;
}
return $amount;
}
//-------- Cancel Subscription -----------
public function entry_info( $form_id, $entry ) {
//abort if subscription cancellation isn't supported by the addon or if it has already been canceled
if ( ! $this->payment_method_is_overridden( 'cancel' ) ) {
return;
}
// adding cancel subscription button and script to entry info section
$cancelsub_button = '';
if ( $entry['transaction_type'] == '2' && $entry['payment_status'] <> 'Cancelled' && $this->is_payment_gateway( $entry['id'] ) ) {
?>
<input id="cancelsub" type="button" name="cancelsub"
value="<?php esc_html_e( 'Cancel Subscription', 'gravityforms' ) ?>" class="button"
onclick="cancel_subscription(<?php echo absint( $entry['id'] ); ?>);"
onkeypress="cancel_subscription(<?php echo absint( $entry['id'] ); ?>);"/>
<img src="<?php echo GFCommon::get_base_url() ?>/images/spinner.gif" id="subscription_cancel_spinner"
style="display: none;"/>
<script type="text/javascript">
</script>
<?php
}
}
/**
* Target of gform_delete_lead hook. Deletes all transactions and callbacks when an entry is deleted.
*
* @param $entry_id . ID of entry that is being deleted
*/
public function entry_deleted( $entry_id ) {
global $wpdb;
//deleting from transaction table
$wpdb->delete( "{$wpdb->prefix}gf_addon_payment_transaction", array( 'lead_id' => $entry_id ), array( '%d' ) );
//deleting from callback table
$wpdb->delete( "{$wpdb->prefix}gf_addon_payment_callback", array( 'lead_id' => $entry_id ), array( '%d' ) );
}
public function ajax_cancel_subscription() {
check_ajax_referer( 'gaddon_cancel_subscription', 'gaddon_cancel_subscription' );
$entry_id = $_POST['entry_id'];
$this->log_debug( __METHOD__ . '(): Processing request for entry #' . $entry_id );
$entry = GFAPI::get_entry( $entry_id );
$form = GFAPI::get_form( $entry['form_id'] );
$feed = $this->get_payment_feed( $entry, $form );
//This addon does not have a payment feed. Abort.
if ( empty ( $feed ) ) {
$this->log_debug( __METHOD__ . '(): Aborting. Entry does not have a feed.' );
return;
}
if ( $this->cancel( $entry, $feed ) ) {
$this->cancel_subscription( $entry, $feed );
die( '1' );
} else {
$this->log_debug( __METHOD__ . '(): Aborting. Unable to cancel subscription.' );
die( '0' );
}
}
/**
* Target of gform_before_delete_field hook. Sets relevant payment feeds to inactive when the credit card field is deleted.
*
* @param $form_id . ID of the form being edited.
* @param $field_id . ID of the field being deleted.
*/
public function before_delete_field( $form_id, $field_id ) {
if ( $this->_requires_credit_card ) {
$form = GFAPI::get_form( $form_id );
$field = $this->get_credit_card_field( $form );
if ( is_object( $field ) && $field->id == $field_id ) {
$feeds = $this->get_feeds( $form_id );
foreach ( $feeds as $feed ) {
if ( $feed['is_active'] ) {
$this->update_feed_active( $feed['id'], 0 );
}
}
}
}
}
// # HELPERS
private function payment_method_is_overridden( $method_name, $base_class = 'GFPaymentAddOn' ) {
return parent::method_is_overridden( $method_name, $base_class );
}
public function authorization_error( $error_message ) {
return array( 'error_message' => $error_message, 'is_success' => false, 'is_authorized' => false );
}
public function remove_spaces_from_card_number( $card_number ) {
$card_number = str_replace( array( "\t", "\n", "\r", ' ' ), '', $card_number );
return $card_number;
}
}
if ( ! class_exists( 'WP_List_Table' ) ) {
require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
}
class GFPaymentStatsTable extends WP_List_Table {
private $_rows = array();
private $_page_size = 10;
private $_total_items = 0;
function __construct( $columns, $rows, $total_count, $page_size ) {
$this->_rows = $rows;
$this->_total_items = $total_count;
$this->_page_size = $page_size;
$this->_column_headers = array(
$columns,
array(),
array(),
rgar( array_values( $columns ), 2 ),
);
parent::__construct(
array(
'singular' => esc_html__( 'sale', 'gravityforms' ),
'plural' => esc_html__( 'sales', 'gravityforms' ),
'ajax' => false,
'screen' => 'gaddon_sales',
)
);
}
function prepare_items() {
$this->items = $this->_rows;
$this->set_pagination_args( array( 'total_items' => $this->_total_items, 'per_page' => $this->_page_size ) );
}
function no_items() {
esc_html_e( "There hasn't been any sales in the specified date range.", 'gravityforms' );
}
function get_columns() {
return $this->_column_headers[0];
}
function column_default( $item, $column ) {
return rgar( $item, $column );
}
function column_revenue( $item ) {
return GFCommon::to_money( $item['revenue'] );
}
function pagination( $which ) {
if ( empty( $this->_pagination_args ) ) {
return;
}
$total_items = $this->get_pagination_arg( 'total_items' );
$total_pages = $this->get_pagination_arg( 'total_pages' );
$output = '<span class="displaying-num">' . sprintf( _n( '1 item', '%s items', $total_items, 'gravityforms' ), number_format_i18n( $total_items ) ) . '</span>';
$current = $this->get_pagenum();
$page_links = array();
$disable_first = $disable_last = '';
if ( $current == 1 ) {
$disable_first = ' disabled';
}
if ( $current == $total_pages ) {
$disable_last = ' disabled';
}
$page_links[] = sprintf(
"<a class='%s' title='%s' style='cursor:pointer;' onclick='gresults.setCustomFilter(\"paged\", \"1\"); gresults.getResults();' onkeypress='gresults.setCustomFilter(\"paged\", \"1\"); gresults.getResults();'>%s</a>",
'first-page' . $disable_first,
esc_attr__( 'Go to the first page', 'gravityforms' ),
'«'
);
$page_links[] = sprintf(
"<a class='%s' title='%s' style='cursor:pointer;' onclick='gresults.setCustomFilter(\"paged\", \"%s\"); gresults.getResults(); gresults.setCustomFilter(\"paged\", \"1\");' onkeypress='gresults.setCustomFilter(\"paged\", \"%s\"); gresults.getResults(); gresults.setCustomFilter(\"paged\", \"1\");'>%s</a>",
'prev-page' . $disable_first,
esc_attr__( 'Go to the previous page', 'gravityforms' ),
max( 1, $current - 1 ),
max( 1, $current - 1 ),
'‹'
);
$html_current_page = $current;
$html_total_pages = sprintf( "<span class='total-pages'>%s</span>", number_format_i18n( $total_pages ) );
$page_links[] = '<span class="paging-input">' . sprintf( esc_html_x( '%1$s of %2$s', 'paging', 'gravityforms' ), $html_current_page, $html_total_pages ) . '</span>';
$page_links[] = sprintf(
"<a class='%s' title='%s' style='cursor:pointer;' onclick='gresults.setCustomFilter(\"paged\", \"%s\"); gresults.getResults(); gresults.setCustomFilter(\"paged\", \"1\");' onkeypress='gresults.setCustomFilter(\"paged\", \"%s\"); gresults.getResults(); gresults.setCustomFilter(\"paged\", \"1\");'>%s</a>",
'next-page' . $disable_last,
esc_attr__( 'Go to the next page', 'gravityforms' ),
min( $total_pages, $current + 1 ),
min( $total_pages, $current + 1 ),
'›'
);
$page_links[] = sprintf(
"<a class='%s' title='%s' style='cursor:pointer;' onclick='gresults.setCustomFilter(\"paged\", \"%s\"); gresults.getResults(); gresults.setCustomFilter(\"paged\", \"1\");'>%s</a>",
'last-page' . $disable_last,
esc_attr__( 'Go to the last page', 'gravityforms' ),
$total_pages,
'»'
);
$pagination_links_class = 'pagination-links';
if ( ! empty( $infinite_scroll ) ) {
$pagination_links_class = ' hide-if-js';
}
$output .= "\n<span class='$pagination_links_class'>" . join( "\n", $page_links ) . '</span>';
if ( $total_pages ) {
$page_class = $total_pages < 2 ? ' one-page' : '';
} else {
$page_class = ' no-pages';
}
$this->_pagination = "<div class='tablenav-pages{$page_class}'>$output</div>";
echo $this->_pagination;
}
}