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