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