PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / 3.06.06
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More v3.06.06
6.35 6.34 6.33.1 6.33 6.32.1 6.32 6.31 6.25 6.25.1 6.26 6.26.1 6.27 6.28 6.29 6.3 6.3.1 6.3.2 6.30 6.4 6.4.1 6.4.2 6.5 6.5.1 6.5.2 6.5.3 All 141 releases
← All changes | classes/models/FrmFormAction.php +345 -625 6.273.06.06 View file →
@@ -1,74 +1,19 @@
1 1 <?php
2 -if ( ! defined( 'ABSPATH' ) ) {
3 - die( 'You are not allowed to call this page directly.' );
4 -}
5 2
6 3 class FrmFormAction {
7 4
8 - /**
9 - * Root id for all actions of this type.
10 - *
11 - * @var string
12 - */
13 - public $id_base;
14 -
15 - /**
16 - * Name for this action type.
17 - *
18 - * @var string
19 - */
20 - public $name;
21 -
22 - /**
23 - * Name of the option used to store the settings for this action type.
24 - *
25 - * @var string
26 - */
5 + public $id_base; // Root id for all actions of this type.
6 + public $name; // Name for this action type.
27 7 public $option_name;
8 + public $action_options; // Option array passed to wp_register_sidebar_widget()
9 + public $control_options; // Option array passed to wp_register_widget_control()
28 10
29 - /**
30 - * Option array passed to wp_register_sidebar_widget().
31 - *
32 - * @var array
33 - */
34 - public $action_options;
11 + public $form_id; // The ID of the form to evaluate
12 + public $number = false; // Unique ID number of the current instance.
13 + public $id = ''; // Unique ID string of the current instance (id_base-number)
14 + public $updated = false; // Set true when we update the data after a POST submit - makes sure we don't do it twice.
35 15
36 - /**
37 - * Option array passed to wp_register_widget_control().
38 - *
39 - * @var array
40 - */
41 - public $control_options;
42 -
43 - /**
44 - * The ID of the form to evaluate.
45 - *
46 - * @var int
47 - */
48 - public $form_id;
49 -
50 - /**
51 - * Unique ID number of the current instance.
52 - *
53 - * @var int
54 - */
55 - public $number = false;
56 -
57 - /**
58 - * Unique ID string of the current instance (id_base-number).
59 - *
60 - * @var string
61 - */
62 - public $id = '';
63 -
64 - /**
65 - * Set true when we update the data after a POST submit - makes sure we don't do it twice.
66 - *
67 - * @var bool
68 - */
69 - public $updated = false;
70 -
71 16 // Member functions that you must over-ride.
72 17
73 18 /**
74 19 * This function should check that $new_instance is set correctly.
@@ -74,11 +19,10 @@
74 19 * This function should check that $new_instance is set correctly.
75 20 * The newly calculated value of $instance should be returned.
76 21 * If "false" is returned, the instance won't be saved/updated.
77 22 *
78 - * @param array $new_instance New settings for this instance as input by the user via form().
79 - * @param array $old_instance Old settings for this instance.
80 - *
23 + * @param array $new_instance New settings for this instance as input by the user via form()
24 + * @param array $old_instance Old settings for this instance
81 25 * @return array Settings to save or bool false to cancel saving
82 26 */
83 27 public function update( $new_instance, $old_instance ) {
84 28 return $new_instance;
@@ -84,14 +28,11 @@
84 28 return $new_instance;
85 29 }
86 30
87 31 /**
88 - * Echo the settings update form
32 + * Echo the settings update form
89 33 *
90 - * @param WP_Post $instance Current settings.
91 - * @param array $args
92 - *
93 - * @return string
34 + * @param array $instance Current settings
94 35 */
95 36 public function form( $instance, $args = array() ) {
96 37 echo '<p class="no-options-widget">' . esc_html__( 'There are no options for this action.', 'formidable' ) . '</p>';
97 38 return 'noform';
@@ -100,26 +41,17 @@
100 41 /**
101 42 * @return array of the default options
102 43 */
103 44 public function get_defaults() {
104 - return array();
45 + return array();
105 46 }
106 47
107 - /**
108 - * @return array
109 - */
110 48 public function get_switch_fields() {
111 - return array();
49 + return array();
112 50 }
113 51
114 - /**
115 - * @param object $action
116 - * @param object $form
117 - *
118 - * @return object
119 - */
120 52 public function migrate_values( $action, $form ) {
121 - return $action;
53 + return $action;
122 54 }
123 55
124 56 // Functions you'll need to call.
125 57
@@ -128,14 +60,14 @@
128 60 *
129 61 * @param string $id_base Optional Base ID for the widget, lower case,
130 62 * if left empty a portion of the widget's class name will be used. Has to be unique.
131 63 * @param string $name Name for the widget displayed on the configuration page.
132 - * @param array $action_options Optional Passed to wp_register_sidebar_widget().
133 - * - description: shown on the configuration page.
134 - * - classname.
135 - * @param array $control_options Optional Passed to wp_register_widget_control().
136 - * - width: required if more than 250px.
137 - * - height: currently not used but may be needed in the future.
64 + * @param array $action_options Optional Passed to wp_register_sidebar_widget()
65 + * - description: shown on the configuration page
66 + * - classname
67 + * @param array $control_options Optional Passed to wp_register_widget_control()
68 + * - width: required if more than 250px
69 + * - height: currently not used but may be needed in the future
138 70 */
139 71 public function __construct( $id_base, $name, $action_options = array(), $control_options = array() ) {
140 72 if ( ! defined( 'ABSPATH' ) ) {
141 73 die( 'You are not allowed to call this page directly.' );
@@ -140,61 +72,31 @@
140 72 if ( ! defined( 'ABSPATH' ) ) {
141 73 die( 'You are not allowed to call this page directly.' );
142 74 }
143 75
144 - $this->id_base = strtolower( $id_base );
145 - $this->name = $name;
76 + $this->id_base = strtolower( $id_base );
77 + $this->name = $name;
146 78 $this->option_name = 'frm_' . $this->id_base . '_action';
147 79
148 - $default_options = array(
149 - 'classes' => '',
150 - 'active' => true,
151 - 'event' => array( 'create' ),
152 - 'limit' => 1,
153 - 'force_event' => false,
154 - 'priority' => 20,
155 - 'ajax_load' => true,
156 - 'plugin' => $this->id_base,
157 - 'tooltip' => $name,
158 - 'group' => $id_base,
159 - 'color' => '',
160 - 'keywords' => '',
161 - );
80 + $default_options = array(
81 + 'classes' => '',
82 + 'active' => true,
83 + 'event' => array( 'create' ),
84 + 'limit' => 1,
85 + 'force_event' => false,
86 + 'priority' => 20,
87 + 'ajax_load' => true,
88 + 'plugin' => $this->id_base,
89 + 'tooltip' => $name,
90 + );
162 91
163 - $action_options = apply_filters( 'frm_' . $id_base . '_action_options', $action_options );
164 - $group = $this->get_group( $action_options );
165 - $action_options['group'] = $group['id'];
166 -
167 - if ( ! isset( $action_options['color'] ) ) {
168 - $colors = array( 'green', 'orange', 'purple' );
169 - shuffle( $colors );
170 - $action_options['color'] = 'var(--' . reset( $colors ) . ')';
171 - }
172 -
173 - $upgrade_class = isset( $action_options['classes'] ) && $action_options['classes'] === 'frm_show_upgrade';
174 -
175 - if ( $action_options['group'] === $id_base ) {
176 - $upgrade_class = str_contains( $action_options['classes'], 'frm_show_upgrade' );
177 - $action_options['classes'] = $group['icon'];
178 - } elseif ( empty( $action_options['classes'] ) || $upgrade_class ) {
179 - $action_options['classes'] = $group['icon'];
180 - }
181 -
182 - if ( $upgrade_class ) {
183 - $action_options['classes'] .= ' frm_show_upgrade';
184 - }
185 -
186 - $this->action_options = wp_parse_args( $action_options, $default_options );
92 + $action_options = apply_filters( 'frm_' . $id_base . '_action_options', $action_options );
93 + $this->action_options = wp_parse_args( $action_options, $default_options );
187 94 $this->control_options = wp_parse_args( $control_options, array( 'id_base' => $this->id_base ) );
188 95 }
189 96
190 97 /**
191 98 * @param string $id_base
192 - * @param string $name
193 - * @param array $action_options
194 - * @param array $control_options
195 - *
196 - * @return void
197 99 */
198 100 public function FrmFormAction( $id_base, $name, $action_options = array(), $control_options = array() ) {
199 101 self::__construct( $id_base, $name, $action_options, $control_options );
200 102 }
@@ -199,67 +101,20 @@
199 101 self::__construct( $id_base, $name, $action_options, $control_options );
200 102 }
201 103
202 104 /**
203 - * Help to switch old field id by new field id for duplicate form
204 - *
205 - * @param string $action id of the field that needs to be switched.
206 - *
207 - * @return string
208 - */
209 - public function maybe_switch_field_ids( $action ) {
210 - $updated_action = apply_filters( 'frm_maybe_switch_field_ids', $action );
211 -
212 - if ( $updated_action === $action ) {
213 - $updated_action = FrmFieldsHelper::switch_field_ids( $action );
214 - }
215 -
216 - return $updated_action;
217 - }
218 -
219 - /**
220 - * @since 4.0
221 - *
222 - * @param array $action_options
223 - *
224 - * @return array
225 - */
226 - protected function get_group( $action_options ) {
227 - $groups = FrmFormActionsController::form_action_groups();
228 - $group = 'misc';
229 -
230 - if ( isset( $action_options['group'] ) && isset( $groups[ $action_options['group'] ] ) ) {
231 - $group = $action_options['group'];
232 - } elseif ( isset( $groups[ $this->id_base ] ) ) {
233 - $group = $this->id_base;
234 - } else {
235 - foreach ( $groups as $name => $check_group ) {
236 - if ( isset( $check_group['actions'] ) && in_array( $this->id_base, $check_group['actions'], true ) ) {
237 - $group = $name;
238 - break;
239 - }
240 - }
241 - }
242 -
243 - $groups[ $group ]['id'] = $group;
244 - return $groups[ $group ];
245 - }
246 -
247 - /**
248 105 * Constructs name attributes for use in form() fields
249 106 *
250 107 * This function should be used in form() methods to create name attributes for fields to be saved by update()
251 108 *
252 - * @param string $field_name Field name.
253 - * @param string $post_field
254 - *
109 + * @param string $field_name Field name
255 110 * @return string Name attribute for $field_name
256 111 */
257 112 public function get_field_name( $field_name, $post_field = 'post_content' ) {
258 - $name = $this->option_name . '[' . $this->number . ']';
259 - $name .= empty( $post_field ) ? '' : '[' . $post_field . ']';
260 -
261 - return $name . ( '[' . $field_name . ']' );
113 + $name = $this->option_name . '[' . $this->number . ']';
114 + $name .= ( empty( $post_field ) ? '' : '[' . $post_field . ']' );
115 + $name .= '[' . $field_name . ']';
116 + return $name;
262 117 }
263 118
264 119 /**
265 120 * Constructs id attributes for use in form() fields
@@ -265,10 +120,9 @@
265 120 * Constructs id attributes for use in form() fields
266 121 *
267 122 * This function should be used in form() methods to create id attributes for fields to be saved by update()
268 123 *
269 - * @param string $field_name Field name.
270 - *
124 + * @param string $field_name Field name
271 125 * @return string ID attribute for $field_name
272 126 */
273 127 public function get_field_id( $field_name ) {
274 128 return $field_name . '_' . $this->number;
@@ -273,30 +127,22 @@
273 127 public function get_field_id( $field_name ) {
274 128 return $field_name . '_' . $this->number;
275 129 }
276 130
277 - /**
278 - * @param int|string $number
279 - *
280 - * @return void
281 - */
131 + // Private Function. Don't worry about this.
132 +
282 133 public function _set( $number ) {
283 134 $this->number = $number;
284 - $this->id = $this->id_base . '-' . $number;
135 + $this->id = $this->id_base . '-' . $number;
285 136 }
286 137
287 - /**
288 - * @param false|int|string $form_id
289 - *
290 - * @return object
291 - */
292 138 public function prepare_new( $form_id = false ) {
293 - if ( $form_id ) {
294 - $this->form_id = $form_id;
295 - }
139 + if ( $form_id ) {
140 + $this->form_id = $form_id;
141 + }
296 142
297 - $post_content = array();
298 - $default_values = $this->get_global_defaults();
143 + $post_content = array();
144 + $default_values = $this->get_global_defaults();
299 145
300 146 // fill default values
301 147 $post_content = wp_parse_args( $post_content, $default_values );
302 148
@@ -303,100 +149,79 @@
303 149 if ( ! isset( $post_content['event'] ) && ! $this->action_options['force_event'] ) {
304 150 $post_content['event'] = array( reset( $this->action_options['event'] ) );
305 151 }
306 152
307 - $form_action = array(
308 - 'post_title' => $this->name,
309 - 'post_content' => $post_content,
310 - 'post_excerpt' => $this->id_base,
311 - 'ID' => '',
312 - 'post_status' => 'publish',
313 - 'post_type' => FrmFormActionsController::$action_post_type,
314 - 'post_name' => $this->form_id . '_' . $this->id_base . '_' . $this->number,
315 - 'menu_order' => $this->form_id,
316 - );
153 + $form_action = array(
154 + 'post_title' => $this->name,
155 + 'post_content' => $post_content,
156 + 'post_excerpt' => $this->id_base,
157 + 'ID' => '',
158 + 'post_status' => 'publish',
159 + 'post_type' => FrmFormActionsController::$action_post_type,
160 + 'post_name' => $this->form_id . '_' . $this->id_base . '_' . $this->number,
161 + 'menu_order' => $this->form_id,
162 + );
317 163 unset( $post_content );
318 164
319 - return (object) $form_action;
320 - }
165 + return (object) $form_action;
166 + }
321 167
322 - /**
323 - * @param int|string $form_id
324 - *
325 - * @return int|WP_Error
326 - */
327 168 public function create( $form_id ) {
328 - $this->form_id = $form_id;
169 + $this->form_id = $form_id;
329 170
330 - $action = $this->prepare_new();
171 + $action = $this->prepare_new();
331 172
332 173 return $this->save_settings( $action );
333 - }
174 + }
334 175
335 - /**
336 - * @param int|string $form_id
337 - * @param int|string $old_id
338 - *
339 - * @return void
340 - */
341 176 public function duplicate_form_actions( $form_id, $old_id ) {
342 - // phpcs:ignore Universal.Operators.StrictComparisons
343 - if ( $form_id == $old_id ) {
344 - // don't duplicate the actions if this is a template getting updated
345 - return;
346 - }
177 + if ( $form_id == $old_id ) {
178 + // don't duplicate the actions if this is a template getting updated
179 + return;
180 + }
347 181
348 - $this->form_id = $old_id;
349 - $actions = $this->get_all( $old_id );
182 + $this->form_id = $old_id;
183 + $actions = $this->get_all( $old_id );
350 184
351 - $this->form_id = $form_id;
352 -
353 - foreach ( $actions as $action ) {
185 + $this->form_id = $form_id;
186 + foreach ( $actions as $action ) {
354 187 $this->duplicate_one( $action, $form_id );
355 188 unset( $action );
356 - }
357 - }
189 + }
190 + }
358 191
359 - /**
360 - * Check if imported action should be created or updated.
361 - *
362 - * @since 2.0
363 - *
364 - * @param array $action
365 - * @param array $forms
366 - *
367 - * @return int $post_id
368 - */
369 - public function maybe_create_action( $action, $forms ) {
370 - if ( isset( $action['ID'] ) && is_numeric( $action['ID'] ) && isset( $forms[ $action['menu_order'] ] ) && $forms[ $action['menu_order'] ] === 'updated' ) {
371 - // Update action only
192 + /* Check if imported action should be created or updated
193 + *
194 + * Since 2.0
195 + *
196 + * @param array $action
197 + * @return integer $post_id
198 + */
199 + public function maybe_create_action( $action, $forms ) {
200 + if ( isset( $action['ID'] ) && is_numeric( $action['ID'] ) && isset( $forms[ $action['menu_order'] ] ) && $forms[ $action['menu_order'] ] == 'updated' ) {
201 + // Update action only
202 + $action['post_content'] = FrmAppHelper::maybe_json_decode( $action['post_content'] );
203 + $post_id = $this->save_settings( $action );
204 + } else {
205 + // Create action
372 206 $action['post_content'] = FrmAppHelper::maybe_json_decode( $action['post_content'] );
373 - return $this->save_settings( $action );
374 - }
375 - // Create action
376 - $action['post_content'] = FrmAppHelper::maybe_json_decode( $action['post_content'] );
377 - return $this->duplicate_one( (object) $action, $action['menu_order'] );
378 - }
207 + $post_id = $this->duplicate_one( (object) $action, $action['menu_order'] );
208 + }
209 + return $post_id;
210 + }
379 211
380 - /**
381 - * @param object $action
382 - * @param int|string $form_id
383 - *
384 - * @return int|WP_Error
385 - */
386 212 public function duplicate_one( $action, $form_id ) {
387 - global $frm_duplicate_ids;
213 + global $frm_duplicate_ids;
388 214
389 - $action->menu_order = $form_id;
390 - $switch = $this->get_global_switch_fields();
391 -
392 - foreach ( (array) $action->post_content as $key => $val ) {
215 + $action->menu_order = $form_id;
216 + $switch = $this->get_global_switch_fields();
217 + foreach ( (array) $action->post_content as $key => $val ) {
393 218 if ( is_numeric( $val ) && isset( $frm_duplicate_ids[ $val ] ) ) {
394 219 $action->post_content[ $key ] = $frm_duplicate_ids[ $val ];
395 - } elseif ( ! is_array( $val ) ) {
220 + } else if ( ! is_array( $val ) ) {
396 221 $action->post_content[ $key ] = FrmFieldsHelper::switch_field_ids( $val );
397 - } elseif ( isset( $switch[ $key ] ) && is_array( $switch[ $key ] ) ) {
398 - // loop through each value if empty
222 + } else if ( isset( $switch[ $key ] ) && is_array( $switch[ $key ] ) ) {
223 + // loop through each value if empty
399 224 if ( empty( $switch[ $key ] ) ) {
400 225 $switch[ $key ] = array_keys( $val );
401 226 }
402 227
@@ -401,10 +226,10 @@
401 226 }
402 227
403 228 foreach ( $switch[ $key ] as $subkey ) {
404 229 $action->post_content[ $key ] = $this->duplicate_array_walk( $action->post_content[ $key ], $subkey, $val );
405 - }
406 - }
230 + }
231 + }
407 232
408 233 unset( $key, $val );
409 234 }
410 235 unset( $action->ID );
@@ -409,79 +234,63 @@
409 234 }
410 235 unset( $action->ID );
411 236
412 237 return $this->save_settings( $action );
413 - }
238 + }
414 239
415 - /**
416 - * @param array $action
417 - * @param array|string $subkey
418 - * @param mixed $val
419 - *
420 - * @return array
421 - */
422 240 private function duplicate_array_walk( $action, $subkey, $val ) {
423 - global $frm_duplicate_ids;
241 + global $frm_duplicate_ids;
424 242
425 243 if ( is_array( $subkey ) ) {
426 - foreach ( $subkey as $subkey2 ) {
427 - foreach ( (array) $val as $ck => $cv ) {
244 + foreach ( $subkey as $subkey2 ) {
245 + foreach ( (array) $val as $ck => $cv ) {
428 246 if ( is_array( $cv ) ) {
429 247 $action[ $ck ] = $this->duplicate_array_walk( $action[ $ck ], $subkey2, $cv );
430 - } elseif ( isset( $cv[ $subkey ] ) && is_numeric( $cv[ $subkey ] ) && isset( $frm_duplicate_ids[ $cv[ $subkey ] ] ) ) {
248 + } else if ( isset( $cv[ $subkey ] ) && is_numeric( $cv[ $subkey ] ) && isset( $frm_duplicate_ids[ $cv[ $subkey ] ] ) ) {
431 249 $action[ $ck ][ $subkey ] = $frm_duplicate_ids[ $cv[ $subkey ] ];
432 - }
433 - }
434 - }
435 - } else {
436 - foreach ( (array) $val as $ck => $cv ) {
250 + }
251 + }
252 + }
253 + } else {
254 + foreach ( (array) $val as $ck => $cv ) {
437 255 if ( is_array( $cv ) ) {
438 256 $action[ $ck ] = $this->duplicate_array_walk( $action[ $ck ], $subkey, $cv );
439 - } elseif ( $ck == $subkey && isset( $frm_duplicate_ids[ $cv ] ) ) { // phpcs:ignore Universal.Operators.StrictComparisons
257 + } else if ( $ck == $subkey && isset( $frm_duplicate_ids[ $cv ] ) ) {
440 258 $action[ $ck ] = $frm_duplicate_ids[ $cv ];
441 - } elseif ( $ck == $subkey ) { // phpcs:ignore Universal.Operators.StrictComparisons
442 - $action[ $ck ] = $this->maybe_switch_field_ids( $action[ $ck ] );
443 - }
444 - }
445 - }//end if
259 + }
260 + }
261 + }
446 262
447 - return $action;
448 - }
263 + return $action;
264 + }
449 265
450 266 /**
451 267 * Deal with changed settings.
452 268 *
453 269 * Do NOT over-ride this function
454 - *
455 - * @param int|string $form_id
456 - *
457 - * @return array|null
458 270 */
459 - public function update_callback( $form_id ) {
460 - $this->form_id = $form_id;
271 + public function update_callback( $form_id ) {
272 + $this->form_id = $form_id;
461 273
462 - $all_instances = $this->get_settings();
274 + $all_instances = $this->get_settings();
463 275
464 - // We need to update the data
465 - if ( $this->updated ) {
466 - return null;
467 - }
276 + // We need to update the data
277 + if ( $this->updated ) {
278 + return;
279 + }
468 280
469 - // phpcs:ignore WordPress.Security.NonceVerification.Missing
470 281 if ( isset( $_POST[ $this->option_name ] ) && is_array( $_POST[ $this->option_name ] ) ) {
471 - // Sanitizing removes scripts and <email> type of values.
472 - // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.NonceVerification.Missing
473 - $settings = wp_unslash( $_POST[ $this->option_name ] );
474 - } else {
475 - return null;
476 - }
282 + $settings = $_POST[ $this->option_name ];
283 + } else {
284 + return;
285 + }
477 286
478 - $action_ids = array();
287 + $action_ids = array();
479 288
480 - foreach ( $settings as $number => $new_instance ) {
481 - $this->_set( $number );
289 + foreach ( $settings as $number => $new_instance ) {
290 + $this->_set( $number );
482 291
483 - $old_instance = $all_instances[ $number ] ?? array();
292 + $old_instance = isset( $all_instances[ $number ] ) ? $all_instances[ $number ] : array();
484 293
485 294 if ( ! isset( $new_instance['post_status'] ) ) {
486 295 $new_instance['post_status'] = 'draft';
487 296 }
@@ -486,21 +295,22 @@
486 295 $new_instance['post_status'] = 'draft';
487 296 }
488 297
489 298 // settings were never opened, so don't update
490 - if ( ! isset( $new_instance['post_title'] ) ) {
299 + if ( ! isset( $new_instance['post_title'] ) ) {
491 300 $this->maybe_update_status( $new_instance, $old_instance );
492 - $action_ids[] = $new_instance['ID'];
493 - $this->updated = true;
494 - continue;
495 - }
301 + $action_ids[] = $new_instance['ID'];
302 + $this->updated = true;
303 + continue;
304 + }
496 305
497 306 $new_instance['post_type'] = FrmFormActionsController::$action_post_type;
498 307 $new_instance['post_name'] = $this->form_id . '_' . $this->id_base . '_' . $this->number;
499 308 $new_instance['menu_order'] = $this->form_id;
500 - $new_instance['post_date'] = $old_instance->post_date ?? '';
501 - $instance = $this->update( $new_instance, $old_instance );
309 + $new_instance['post_date'] = isset( $old_instance->post_date ) ? $old_instance->post_date : '';
502 310
311 + $instance = $this->update( $new_instance, $old_instance );
312 +
503 313 /**
504 314 * Filter an action's settings before saving.
505 315 *
506 316 * Returning false will effectively short-circuit the widget's ability
@@ -507,17 +317,17 @@
507 317 * to update settings.
508 318 *
509 319 * @since 2.0
510 320 *
511 - * @param array $instance The current widget instance's settings.
512 - * @param array $new_instance Array of new widget settings.
513 - * @param array $old_instance Array of old widget settings.
514 - * @param FrmFormAction $form_action FrmFormAction instance.
321 + * @param array $instance The current widget instance's settings.
322 + * @param array $new_instance Array of new widget settings.
323 + * @param array $old_instance Array of old widget settings.
324 + * @param WP_Widget $this The current widget instance.
515 325 */
516 326 $instance = apply_filters( 'frm_action_update_callback', $instance, $new_instance, $old_instance, $this );
517 327
518 328 $instance['post_content'] = apply_filters( 'frm_before_save_action', $instance['post_content'], $instance, $new_instance, $old_instance, $this );
519 - $instance['post_content'] = apply_filters( 'frm_before_save_' . $this->id_base . '_action', $instance['post_content'], $instance, $new_instance, $old_instance, $this );
329 + $instance['post_content'] = apply_filters( 'frm_before_save_' . $this->id_base . '_action', $new_instance['post_content'], $instance, $new_instance, $old_instance, $this );
520 330
521 331 if ( false !== $instance ) {
522 332 $all_instances[ $number ] = $instance;
523 333 }
@@ -523,155 +333,100 @@
523 333 }
524 334
525 335 $action_ids[] = $this->save_settings( $instance );
526 336
527 - $this->updated = true;
528 - }//end foreach
337 + $this->updated = true;
338 + }
529 339
530 - return $action_ids;
531 - }
340 + return $action_ids;
341 + }
532 342
533 343 /**
534 344 * If the status of the action has changed, update it
535 345 *
536 346 * @since 3.04
537 - *
538 - * @param array $new_instance
539 - * @param array|stdClass $old_instance
540 - *
541 - * @return void
542 347 */
543 348 protected function maybe_update_status( $new_instance, $old_instance ) {
544 - if ( ! is_object( $old_instance ) || $new_instance['post_status'] === $old_instance->post_status ) {
545 - return;
349 + if ( $new_instance['post_status'] !== $old_instance->post_status ) {
350 + self::clear_cache();
351 + wp_update_post(
352 + array(
353 + 'ID' => $new_instance['ID'],
354 + 'post_status' => $new_instance['post_status'],
355 + )
356 + );
546 357 }
547 -
548 - self::clear_cache();
549 - wp_update_post(
550 - array(
551 - 'ID' => $new_instance['ID'],
552 - 'post_status' => $new_instance['post_status'],
553 - )
554 - );
555 358 }
556 359
557 - /**
558 - * @param array $settings
559 - *
560 - * @return int|WP_Error
561 - */
562 360 public function save_settings( $settings ) {
563 361 self::clear_cache();
564 362 return FrmDb::save_settings( $settings, 'frm_actions' );
565 363 }
566 364
567 - /**
568 - * @param int $id
569 - *
570 - * @return object|null
571 - */
572 365 public function get_single_action( $id ) {
573 366 $action = get_post( $id );
574 -
575 367 if ( $action ) {
576 368 $action = $this->prepare_action( $action );
577 369 $this->_set( $id );
578 370 }
579 -
580 - return $action;
371 + return $action;
581 372 }
582 373
583 - /**
584 - * @param int|string $form_id
585 - *
586 - * @return array
587 - */
588 374 public function get_one( $form_id ) {
589 375 return $this->get_all( $form_id, 1 );
590 376 }
591 377
592 - /**
593 - * @param int|string $form_id
594 - * @param string $type
595 - * @param array $atts
596 - *
597 - * @return array
598 - */
599 - public static function get_action_for_form( $form_id, $type = 'all', $atts = array() ) {
600 - $action_controls = FrmFormActionsController::get_form_actions( $type );
378 + public static function get_action_for_form( $form_id, $type = 'all', $atts = array() ) {
379 + $action_controls = FrmFormActionsController::get_form_actions( $type );
380 + if ( empty( $action_controls ) ) {
381 + // don't continue if there are no available actions
382 + return array();
383 + }
601 384
602 - if ( ! $action_controls ) {
603 - // don't continue if there are no available actions
604 - return array();
605 - }
606 -
607 - if ( 'all' !== $type ) {
608 - if ( is_array( $action_controls ) ) {
609 - return array();
610 - }
611 -
385 + if ( 'all' != $type ) {
612 386 return $action_controls->get_all( $form_id, $atts );
613 387 }
614 388
615 389 self::prepare_get_action( $atts );
616 390
617 - $limit = self::get_action_limit( $form_id, $atts['limit'] );
618 - $args = self::action_args( $form_id, $limit );
391 + $limit = apply_filters( 'frm_form_action_limit', $atts['limit'], compact( 'type', 'form_id' ) );
392 +
393 + $args = self::action_args( $form_id, $limit );
619 394 $args['post_status'] = $atts['post_status'];
620 - $actions = FrmDb::check_cache( json_encode( $args ), 'frm_actions', $args, 'get_posts' );
395 + $actions = FrmDb::check_cache( serialize( $args ), 'frm_actions', $args, 'get_posts' );
621 396
622 - if ( ! $actions ) {
623 - return array();
624 - }
397 + if ( ! $actions ) {
398 + return array();
399 + }
625 400
626 - $settings = array();
627 -
628 - foreach ( $actions as $action ) {
401 + $settings = array();
402 + foreach ( $actions as $action ) {
629 403 // some plugins/themes are formatting the post_excerpt
630 404 $action->post_excerpt = sanitize_title( $action->post_excerpt );
631 405
632 406 if ( ! isset( $action_controls[ $action->post_excerpt ] ) ) {
633 - continue;
634 - }
407 + continue;
408 + }
635 409
636 - $action = $action_controls[ $action->post_excerpt ]->prepare_action( $action );
410 + $action = $action_controls[ $action->post_excerpt ]->prepare_action( $action );
637 411 $settings[ $action->ID ] = $action;
638 412
639 413 if ( count( $settings ) >= $limit ) {
640 414 break;
641 415 }
642 - }
416 + }
643 417
644 - if ( 1 === $limit ) {
418 + if ( 1 === $limit ) {
645 419 $settings = reset( $settings );
646 - }
420 + }
647 421
648 - return $settings;
649 - }
422 + return $settings;
423 + }
650 424
651 425 /**
652 - * Get the limit for the number of actions for a single form. By default, this is 99, but
653 - * it can be modified with a code snippet.
654 - *
655 - * @since 6.17 This logic from moved from FrmFormAction::get_action_for_form.
656 - *
657 - * @param int|string $form_id
658 - * @param int|string $limit The unfiltered limit value.
659 - *
660 - * @return int The filtered limit value.
661 - */
662 - public static function get_action_limit( $form_id, $limit = 99 ) {
663 - $type = 'all';
664 - return (int) apply_filters( 'frm_form_action_limit', (int) $limit, compact( 'type', 'form_id' ) );
665 - }
666 -
667 - /**
668 426 * @since 3.04
669 - *
670 427 * @param array $args
671 428 * @param string $default_status
672 - *
673 - * @return void
674 429 */
675 430 protected static function prepare_get_action( &$args, $default_status = 'publish' ) {
676 431 if ( is_numeric( $args ) ) {
677 432 // for reverse compatibility. $limit was changed to $args
@@ -678,108 +433,80 @@
678 433 $args = array(
679 434 'limit' => $args,
680 435 );
681 436 }
682 -
683 437 $defaults = array(
684 438 'limit' => 99,
685 439 'post_status' => $default_status,
686 440 );
687 - $args = wp_parse_args( $args, $defaults );
441 + $args = wp_parse_args( $args, $defaults );
688 442 }
689 443
690 444 /**
691 - * @param int $action_id
692 - * @param string $type
693 - *
694 - * @return bool|object
445 + * @param int $action_id
695 446 */
696 447 public static function get_single_action_type( $action_id, $type ) {
697 448 if ( ! $type ) {
698 449 return false;
699 450 }
700 -
701 - /**
702 - * @var FrmFormAction
703 - */
704 451 $action_control = FrmFormActionsController::get_form_actions( $type );
705 -
706 452 return $action_control->get_single_action( $action_id );
707 453 }
708 454
709 455 /**
710 - * @param int $form_id
711 - * @param string $type
712 - *
456 + * @param int $form_id
713 457 * @return bool
714 458 */
715 459 public static function form_has_action_type( $form_id, $type ) {
716 - $actions = self::get_action_for_form( $form_id, $type );
717 - return ! empty( $actions );
460 + $payment_actions = self::get_action_for_form( $form_id, $type );
461 + return ! empty( $payment_actions );
718 462 }
719 463
720 - /**
721 - * @param false|int|string $form_id
722 - * @param array $atts
723 - *
724 - * @return array
725 - */
726 464 public function get_all( $form_id = false, $atts = array() ) {
727 - if ( is_array( $atts ) && ! isset( $atts['limit'] ) && $this->action_options['limit'] > 99 ) {
728 - $atts['limit'] = $this->action_options['limit'];
729 - }
730 -
731 465 self::prepare_get_action( $atts, 'any' );
732 -
733 466 $limit = $atts['limit'];
734 467
735 - if ( $form_id ) {
736 - $this->form_id = $form_id;
737 - }
468 + if ( $form_id ) {
469 + $this->form_id = $form_id;
470 + }
738 471
739 - $type = $this->id_base;
472 + $type = $this->id_base;
740 473
741 - global $frm_vars;
742 - $frm_vars['action_type'] = $type;
474 + global $frm_vars;
475 + $frm_vars['action_type'] = $type;
743 476
744 477 add_filter( 'posts_where', 'FrmFormActionsController::limit_by_type' );
745 - $query = self::action_args( $form_id, $limit );
746 - $query['post_status'] = $atts['post_status'];
747 - $query['suppress_filters'] = false;
478 + $query = self::action_args( $form_id, $limit );
479 + $query['post_status'] = $atts['post_status'];
480 + $query['suppress_filters'] = false;
748 481
749 - $actions = FrmDb::check_cache( json_encode( $query ) . '_type_' . $type, 'frm_actions', $query, 'get_posts' );
482 + $actions = FrmDb::check_cache( serialize( $query ) . '_type_' . $type, 'frm_actions', $query, 'get_posts' );
750 483 unset( $query );
751 484
752 485 remove_filter( 'posts_where', 'FrmFormActionsController::limit_by_type' );
753 486
754 - if ( ! $actions ) {
755 - return array();
756 - }
487 + if ( empty( $actions ) ) {
488 + return array();
489 + }
757 490
758 - $settings = array();
491 + $settings = array();
492 + foreach ( $actions as $action ) {
493 + if ( count( $settings ) >= $limit ) {
494 + continue;
495 + }
759 496
760 - foreach ( $actions as $action ) {
761 - if ( count( $settings ) >= $limit ) {
762 - continue;
763 - }
497 + $action = $this->prepare_action( $action );
764 498
765 - $action = $this->prepare_action( $action );
766 499 $settings[ $action->ID ] = $action;
767 - }
500 + }
768 501
769 - if ( 1 === $limit ) {
502 + if ( 1 === $limit ) {
770 503 $settings = reset( $settings );
771 - }
504 + }
772 505
773 - return $settings;
506 + return $settings;
774 507 }
775 508
776 - /**
777 - * @param int $form_id
778 - * @param int $limit
779 - *
780 - * @return array
781 - */
782 509 public static function action_args( $form_id = 0, $limit = 99 ) {
783 510 $args = array(
784 511 'post_type' => FrmFormActionsController::$action_post_type,
785 512 'post_status' => 'publish',
@@ -787,9 +514,9 @@
787 514 'orderby' => 'title',
788 515 'order' => 'ASC',
789 516 );
790 517
791 - if ( $form_id && $form_id !== 'all' ) {
518 + if ( $form_id && $form_id != 'all' ) {
792 519 $args['menu_order'] = $form_id;
793 520 }
794 521
795 522 return $args;
@@ -794,64 +521,51 @@
794 521
795 522 return $args;
796 523 }
797 524
798 - /**
799 - * @param WP_Post $action
800 - *
801 - * @return WP_Post
802 - */
803 525 public function prepare_action( $action ) {
804 526 $action->post_content = (array) FrmAppHelper::maybe_json_decode( $action->post_content );
805 527 $action->post_excerpt = sanitize_title( $action->post_excerpt );
806 528
807 - $default_values = $this->get_global_defaults();
529 + $default_values = $this->get_global_defaults();
808 530
809 - // fill default values
810 - $action->post_content += $default_values;
531 + // fill default values
532 + $action->post_content += $default_values;
811 533
812 - foreach ( $default_values as $k => $vals ) {
813 - if ( is_array( $vals ) && $vals ) {
814 - if ( 'event' === $k && ! $this->action_options['force_event'] && ! empty( $action->post_content[ $k ] ) ) {
815 - continue;
816 - }
534 + foreach ( $default_values as $k => $vals ) {
535 + if ( is_array( $vals ) && ! empty( $vals ) ) {
536 + if ( 'event' == $k && ! $this->action_options['force_event'] && ! empty( $action->post_content[ $k ] ) ) {
537 + continue;
538 + }
817 539 $action->post_content[ $k ] = wp_parse_args( $action->post_content[ $k ], $vals );
818 - }
819 - }
540 + }
541 + }
820 542
821 543 if ( ! is_array( $action->post_content['event'] ) ) {
822 544 $action->post_content['event'] = explode( ',', $action->post_content['event'] );
823 545 }
824 546
825 - return $action;
547 + return $action;
826 548 }
827 549
828 - /**
829 - * @param false|int|string $form_id
830 - * @param string $type
831 - *
832 - * @return void
833 - */
834 550 public function destroy( $form_id = false, $type = 'default' ) {
835 - global $wpdb;
551 + global $wpdb;
836 552
837 - $this->form_id = $form_id;
553 + $this->form_id = $form_id;
838 554
839 - $query = array( 'post_type' => FrmFormActionsController::$action_post_type );
555 + $query = array( 'post_type' => FrmFormActionsController::$action_post_type );
556 + if ( $form_id ) {
557 + $query['menu_order'] = $form_id;
558 + }
559 + if ( 'all' != $type ) {
560 + $query['post_excerpt'] = $this->id_base;
561 + }
840 562
841 - if ( $form_id ) {
842 - $query['menu_order'] = $form_id;
843 - }
563 + $post_ids = FrmDb::get_col( $wpdb->posts, $query, 'ID' );
844 564
845 - if ( 'all' !== $type ) {
846 - $query['post_excerpt'] = $this->id_base;
847 - }
848 -
849 - $post_ids = FrmDb::get_col( $wpdb->posts, $query, 'ID' );
850 -
851 - foreach ( $post_ids as $id ) {
565 + foreach ( $post_ids as $id ) {
852 566 wp_delete_post( $id );
853 - }
567 + }
854 568 self::clear_cache();
855 569 }
856 570
857 571 /**
@@ -857,178 +571,184 @@
857 571 /**
858 572 * Delete the action cache when a form action is created, deleted, or updated
859 573 *
860 574 * @since 2.0.5
861 - *
862 - * @return void
863 575 */
864 576 public static function clear_cache() {
865 577 FrmDb::cache_delete_group( 'frm_actions' );
866 578 }
867 579
868 - /**
869 - * @return array
870 - */
871 580 public function get_settings() {
872 581 return self::get_action_for_form( $this->form_id, $this->id_base );
873 582 }
874 583
875 - /**
876 - * @return array
877 - */
878 584 public function get_global_defaults() {
879 - $defaults = $this->get_defaults();
585 + $defaults = $this->get_defaults();
880 586
881 587 if ( ! isset( $defaults['event'] ) ) {
882 588 $defaults['event'] = array( 'create' );
883 - }
589 + }
884 590
885 591 if ( ! isset( $defaults['conditions'] ) ) {
886 - $defaults['conditions'] = array(
887 - 'send_stop' => '',
888 - 'any_all' => '',
889 - );
890 - }
592 + $defaults['conditions'] = array(
593 + 'send_stop' => '',
594 + 'any_all' => '',
595 + );
596 + }
891 597
892 - return $defaults;
598 + return $defaults;
893 599 }
894 600
895 - /**
896 - * @return array
897 - */
898 601 public function get_global_switch_fields() {
899 - $switch = $this->get_switch_fields();
602 + $switch = $this->get_switch_fields();
900 603 $switch['conditions'] = array( 'hide_field' );
901 -
902 - return apply_filters( 'frm_global_switch_fields', $switch );
604 + return $switch;
903 605 }
904 606
905 607 /**
906 608 * Migrate settings from form->options into new action.
907 - *
908 - * @param object $form
909 - * @param string $update
910 - *
911 - * @return int|WP_Error
912 609 */
913 610 public function migrate_to_2( $form, $update = 'update' ) {
914 611 $action = $this->prepare_new( $form->id );
915 - FrmAppHelper::unserialize_or_decode( $form->options );
612 + $form->options = maybe_unserialize( $form->options );
916 613
917 - // fill with existing options
918 - foreach ( $action->post_content as $name => $val ) {
614 + // fill with existing options
615 + foreach ( $action->post_content as $name => $val ) {
919 616 if ( isset( $form->options[ $name ] ) ) {
920 617 $action->post_content[ $name ] = $form->options[ $name ];
921 618 unset( $form->options[ $name ] );
922 - }
923 - }
619 + }
620 + }
924 621
925 622 $action = $this->migrate_values( $action, $form );
926 623
927 - // check if action already exists
624 + // check if action already exists
928 625 $post_id = get_posts(
929 626 array(
930 - 'name' => $action->post_name,
931 - 'post_type' => FrmFormActionsController::$action_post_type,
932 - 'post_status' => $action->post_status,
933 - 'numberposts' => 1,
627 + 'name' => $action->post_name,
628 + 'post_type' => FrmFormActionsController::$action_post_type,
629 + 'post_status' => $action->post_status,
630 + 'numberposts' => 1,
934 631 )
935 632 );
936 633
937 - if ( ! $post_id ) {
634 + if ( empty( $post_id ) ) {
938 635 // create action now
939 636 $post_id = $this->save_settings( $action );
940 637 }
941 638
942 - if ( $post_id && 'update' === $update ) {
943 - global $wpdb;
639 + if ( $post_id && 'update' == $update ) {
640 + global $wpdb;
944 641 $form->options = maybe_serialize( $form->options );
945 642
946 - // update form options
643 + // update form options
947 644 $wpdb->update( $wpdb->prefix . 'frm_forms', array( 'options' => $form->options ), array( 'id' => $form->id ) );
948 - FrmForm::clear_form_cache();
645 + FrmForm::clear_form_cache();
646 + }
647 +
648 + return $post_id;
649 + }
650 +
651 + public static function action_conditions_met( $action, $entry ) {
652 + $notification = $action->post_content;
653 + $stop = false;
654 + $met = array();
655 +
656 + if ( ! isset( $notification['conditions'] ) || empty( $notification['conditions'] ) ) {
657 + return $stop;
949 658 }
950 659
951 - return $post_id;
660 + foreach ( $notification['conditions'] as $k => $condition ) {
661 + if ( ! is_numeric( $k ) ) {
662 + continue;
663 + }
664 +
665 + if ( $stop && 'any' == $notification['conditions']['any_all'] && 'stop' == $notification['conditions']['send_stop'] ) {
666 + continue;
667 + }
668 +
669 + self::prepare_logic_value( $condition['hide_opt'] );
670 +
671 + $observed_value = self::get_value_from_entry( $entry, $condition['hide_field'] );
672 +
673 + $stop = FrmFieldsHelper::value_meets_condition( $observed_value, $condition['hide_field_cond'], $condition['hide_opt'] );
674 +
675 + if ( $notification['conditions']['send_stop'] == 'send' ) {
676 + $stop = $stop ? false : true;
677 + }
678 +
679 + $met[ $stop ] = $stop;
680 + }
681 +
682 + if ( $notification['conditions']['any_all'] == 'all' && ! empty( $met ) && isset( $met[0] ) && isset( $met[1] ) ) {
683 + $stop = ( $notification['conditions']['send_stop'] == 'send' );
684 + } elseif ( $notification['conditions']['any_all'] == 'any' && $notification['conditions']['send_stop'] == 'send' && isset( $met[0] ) ) {
685 + $stop = false;
686 + }
687 +
688 + return $stop;
952 689 }
953 690
954 691 /**
955 - * @param WP_Post $action
956 - * @param stdClass $entry
692 + * Prepare the logic value for comparison against the entered value
957 693 *
958 - * @return bool
694 + * @since 2.01.02
695 + * @param array|string $logic_value
959 696 */
960 - public static function action_conditions_met( $action, $entry ) {
961 - if ( is_callable( 'FrmProFormActionsController::action_conditions_met' ) ) {
962 - return FrmProFormActionsController::action_conditions_met( $action, $entry );
697 + private static function prepare_logic_value( &$logic_value ) {
698 + if ( is_array( $logic_value ) ) {
699 + $logic_value = reset( $logic_value );
963 700 }
964 - return false;
701 +
702 + if ( $logic_value == 'current_user' ) {
703 + $logic_value = get_current_user_id();
704 + }
965 705 }
966 706
707 +
967 708 /**
968 - * @param string $class
709 + * Get the value from a specific field and entry
969 710 *
970 - * @return array
711 + * @since 2.01.02
712 + * @param object $entry
713 + * @param int $field_id
714 + * @return array|bool|mixed|string
971 715 */
716 + private static function get_value_from_entry( $entry, $field_id ) {
717 + $observed_value = '';
718 +
719 + if ( isset( $entry->metas[ $field_id ] ) ) {
720 + $observed_value = $entry->metas[ $field_id ];
721 + } else if ( $entry->post_id && FrmAppHelper::pro_is_installed() ) {
722 + $field = FrmField::getOne( $field_id );
723 + $observed_value = FrmProEntryMetaHelper::get_post_or_meta_value(
724 + $entry,
725 + $field,
726 + array(
727 + 'links' => false,
728 + 'truncate' => false,
729 + )
730 + );
731 + }
732 +
733 + return $observed_value;
734 + }
735 +
972 736 public static function default_action_opts( $class = '' ) {
973 737 return array(
974 - 'classes' => 'frmfont ' . $class,
975 - 'active' => false,
976 - 'limit' => 0,
738 + 'classes' => 'frm_icon_font ' . $class,
739 + 'active' => false,
740 + 'limit' => 0,
977 741 );
978 742 }
979 743
980 - /**
981 - * @return array
982 - */
983 744 public static function trigger_labels() {
984 745 $triggers = array(
985 - 'draft' => __( 'Draft is saved', 'formidable' ),
986 - 'create' => __( 'Entry is created', 'formidable' ),
987 - 'update' => __( 'Entry is updated', 'formidable' ),
988 - 'delete' => __( 'Entry is deleted', 'formidable' ),
989 - 'import' => __( 'Entry is imported', 'formidable' ),
746 + 'draft' => __( 'Save Draft', 'formidable' ),
747 + 'create' => __( 'Create', 'formidable' ),
748 + 'update' => __( 'Update', 'formidable' ),
749 + 'delete' => __( 'Delete', 'formidable' ),
750 + 'import' => __( 'Import', 'formidable' ),
990 751 );
991 -
992 752 return apply_filters( 'frm_action_triggers', $triggers );
993 - }
994 -
995 - /**
996 - * @return void
997 - */
998 - public function render_conditional_logic_call_to_action() {
999 - ?>
1000 - <h3>
1001 - <a href="javascript:void(0)" class="frm_show_upgrade frm_noallow" data-upgrade="<?php echo esc_attr( $this->get_upgrade_text() ); ?>" data-medium="conditional-<?php echo esc_attr( $this->id_base ); ?>"><?php // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong ?>
1002 - <?php esc_html_e( 'Use Conditional Logic', 'formidable' ); ?>
1003 - </a>
1004 - </h3>
1005 - <?php
1006 - }
1007 -
1008 - /**
1009 - * @return string
1010 - */
1011 - protected function get_upgrade_text() {
1012 - return __( 'Conditional form actions', 'formidable' );
1013 - }
1014 -
1015 - /**
1016 - * Gets form fields for form action settings.
1017 - *
1018 - * @since 6.10
1019 - *
1020 - * @param int $form_id Form ID.
1021 - *
1022 - * @return object[]
1023 - */
1024 - protected function get_form_fields( $form_id ) {
1025 - // Get form fields, include embedded and repeater child fields.
1026 - $form_fields = FrmField::get_all_for_form( $form_id, '', 'include' );
1027 - return array_filter(
1028 - $form_fields,
1029 - function ( $form_field ) {
1030 - return ! FrmField::is_no_save_field( $form_field->type );
1031 - }
1032 - );
1033 753 }
1034 754 }