PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / 6.17
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More v6.17
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 +146 -52 6.46.17 View file →
@@ -4,19 +4,71 @@
4 4 }
5 5
6 6 class FrmFormAction {
7 7
8 - public $id_base; // Root id for all actions of this type.
9 - public $name; // Name for this action type.
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 + */
10 27 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()
13 28
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.
29 + /**
30 + * Option array passed to wp_register_sidebar_widget().
31 + *
32 + * @var array
33 + */
34 + public $action_options;
18 35
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 +
19 71 // Member functions that you must over-ride.
20 72
21 73 /**
22 74 * This function should check that $new_instance is set correctly.
@@ -22,10 +74,10 @@
22 74 * This function should check that $new_instance is set correctly.
23 75 * The newly calculated value of $instance should be returned.
24 76 * If "false" is returned, the instance won't be saved/updated.
25 77 *
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
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.
28 80 *
29 81 * @return array Settings to save or bool false to cancel saving
30 82 */
31 83 public function update( $new_instance, $old_instance ) {
@@ -34,9 +86,10 @@
34 86
35 87 /**
36 88 * Echo the settings update form
37 89 *
38 - * @param array $instance Current settings
90 + * @param WP_Post $instance Current settings.
91 + * @param array $args
39 92 */
40 93 public function form( $instance, $args = array() ) {
41 94 echo '<p class="no-options-widget">' . esc_html__( 'There are no options for this action.', 'formidable' ) . '</p>';
42 95
@@ -68,14 +121,14 @@
68 121 *
69 122 * @param string $id_base Optional Base ID for the widget, lower case,
70 123 * if left empty a portion of the widget's class name will be used. Has to be unique.
71 124 * @param string $name Name for the widget displayed on the configuration page.
72 - * @param array $action_options Optional Passed to wp_register_sidebar_widget()
73 - * - description: shown on the configuration page
74 - * - classname
75 - * @param array $control_options Optional Passed to wp_register_widget_control()
76 - * - width: required if more than 250px
77 - * - height: currently not used but may be needed in the future
125 + * @param array $action_options Optional Passed to wp_register_sidebar_widget().
126 + * - description: shown on the configuration page.
127 + * - classname.
128 + * @param array $control_options Optional Passed to wp_register_widget_control().
129 + * - width: required if more than 250px.
130 + * - height: currently not used but may be needed in the future.
78 131 */
79 132 public function __construct( $id_base, $name, $action_options = array(), $control_options = array() ) {
80 133 if ( ! defined( 'ABSPATH' ) ) {
81 134 die( 'You are not allowed to call this page directly.' );
@@ -111,11 +164,11 @@
111 164 }
112 165
113 166 $upgrade_class = isset( $action_options['classes'] ) && $action_options['classes'] === 'frm_show_upgrade';
114 167 if ( $action_options['group'] === $id_base ) {
115 - $upgrade_class = strpos( $action_options['classes'], 'frm_show_upgrade' ) !== false;
168 + $upgrade_class = strpos( $action_options['classes'], 'frm_show_upgrade' ) !== false;
116 169 $action_options['classes'] = $group['icon'];
117 - } elseif ( ! isset( $action_options['classes'] ) || empty( $action_options['classes'] ) || $upgrade_class ) {
170 + } elseif ( empty( $action_options['classes'] ) || $upgrade_class ) {
118 171 $action_options['classes'] = $group['icon'];
119 172 }
120 173
121 174 if ( $upgrade_class ) {
@@ -135,9 +188,9 @@
135 188
136 189 /**
137 190 * Help to switch old field id by new field id for duplicate form
138 191 *
139 - * @param string $action id of the field that needs to be switched
192 + * @param string $action id of the field that needs to be switched.
140 193 *
141 194 * @return string
142 195 */
143 196 public function maybe_switch_field_ids( $action ) {
@@ -176,14 +229,14 @@
176 229 * Constructs name attributes for use in form() fields
177 230 *
178 231 * This function should be used in form() methods to create name attributes for fields to be saved by update()
179 232 *
180 - * @param string $field_name Field name
233 + * @param string $field_name Field name.
181 234 *
182 235 * @return string Name attribute for $field_name
183 236 */
184 237 public function get_field_name( $field_name, $post_field = 'post_content' ) {
185 - $name = $this->option_name . '[' . $this->number . ']';
238 + $name = $this->option_name . '[' . $this->number . ']';
186 239 $name .= ( empty( $post_field ) ? '' : '[' . $post_field . ']' );
187 240 $name .= '[' . $field_name . ']';
188 241
189 242 return $name;
@@ -193,9 +246,9 @@
193 246 * Constructs id attributes for use in form() fields
194 247 *
195 248 * This function should be used in form() methods to create id attributes for fields to be saved by update()
196 249 *
197 - * @param string $field_name Field name
250 + * @param string $field_name Field name.
198 251 *
199 252 * @return string ID attribute for $field_name
200 253 */
201 254 public function get_field_id( $field_name ) {
@@ -270,17 +323,18 @@
270 323 unset( $action );
271 324 }
272 325 }
273 326
274 - /* Check if imported action should be created or updated
327 + /**
328 + * Check if imported action should be created or updated.
275 329 *
276 330 * @since 2.0
277 331 *
278 332 * @param array $action
279 - * @return integer $post_id
333 + * @return int $post_id
280 334 */
281 335 public function maybe_create_action( $action, $forms ) {
282 - if ( isset( $action['ID'] ) && is_numeric( $action['ID'] ) && isset( $forms[ $action['menu_order'] ] ) && $forms[ $action['menu_order'] ] == 'updated' ) {
336 + if ( isset( $action['ID'] ) && is_numeric( $action['ID'] ) && isset( $forms[ $action['menu_order'] ] ) && $forms[ $action['menu_order'] ] === 'updated' ) {
283 337 // Update action only
284 338 $action['post_content'] = FrmAppHelper::maybe_json_decode( $action['post_content'] );
285 339 $post_id = $this->save_settings( $action );
286 340 } else {
@@ -346,9 +400,9 @@
346 400 } elseif ( $ck == $subkey ) {
347 401 $action[ $ck ] = $this->maybe_switch_field_ids( $action[ $ck ] );
348 402 }
349 403 }
350 - }
404 + }//end if
351 405
352 406 return $action;
353 407 }
354 408
@@ -398,9 +452,9 @@
398 452 $new_instance['post_type'] = FrmFormActionsController::$action_post_type;
399 453 $new_instance['post_name'] = $this->form_id . '_' . $this->id_base . '_' . $this->number;
400 454 $new_instance['menu_order'] = $this->form_id;
401 455 $new_instance['post_date'] = isset( $old_instance->post_date ) ? $old_instance->post_date : '';
402 - $instance = $this->update( $new_instance, $old_instance );
456 + $instance = $this->update( $new_instance, $old_instance );
403 457
404 458 /**
405 459 * Filter an action's settings before saving.
406 460 *
@@ -408,12 +462,12 @@
408 462 * to update settings.
409 463 *
410 464 * @since 2.0
411 465 *
412 - * @param array $instance The current widget instance's settings.
413 - * @param array $new_instance Array of new widget settings.
414 - * @param array $old_instance Array of old widget settings.
415 - * @param WP_Widget $this The current widget instance.
466 + * @param array $instance The current widget instance's settings.
467 + * @param array $new_instance Array of new widget settings.
468 + * @param array $old_instance Array of old widget settings.
469 + * @param FrmFormAction $form_action FrmFormAction instance.
416 470 */
417 471 $instance = apply_filters( 'frm_action_update_callback', $instance, $new_instance, $old_instance, $this );
418 472
419 473 $instance['post_content'] = apply_filters( 'frm_before_save_action', $instance['post_content'], $instance, $new_instance, $old_instance, $this );
@@ -425,9 +479,9 @@
425 479
426 480 $action_ids[] = $this->save_settings( $instance );
427 481
428 482 $this->updated = true;
429 - }
483 + }//end foreach
430 484
431 485 return $action_ids;
432 486 }
433 487
@@ -436,9 +490,9 @@
436 490 *
437 491 * @since 3.04
438 492 *
439 493 * @param array $new_instance
440 - * @param stdClass|array $old_instance
494 + * @param array|stdClass $old_instance
441 495 * @return void
442 496 */
443 497 protected function maybe_update_status( $new_instance, $old_instance ) {
444 498 if ( ! is_object( $old_instance ) || $new_instance['post_status'] === $old_instance->post_status ) {
@@ -453,8 +507,12 @@
453 507 )
454 508 );
455 509 }
456 510
511 + /**
512 + * @param array $settings
513 + * @return int|WP_Error
514 + */
457 515 public function save_settings( $settings ) {
458 516 self::clear_cache();
459 517
460 518 return FrmDb::save_settings( $settings, 'frm_actions' );
@@ -480,15 +538,15 @@
480 538 // don't continue if there are no available actions
481 539 return array();
482 540 }
483 541
484 - if ( 'all' != $type ) {
542 + if ( 'all' !== $type ) {
485 543 return $action_controls->get_all( $form_id, $atts );
486 544 }
487 545
488 546 self::prepare_get_action( $atts );
489 547
490 - $limit = apply_filters( 'frm_form_action_limit', $atts['limit'], compact( 'type', 'form_id' ) );
548 + $limit = self::get_action_limit( $form_id, $atts['limit'] );
491 549
492 550 $args = self::action_args( $form_id, $limit );
493 551 $args['post_status'] = $atts['post_status'];
494 552 $actions = FrmDb::check_cache( json_encode( $args ), 'frm_actions', $args, 'get_posts' );
@@ -521,8 +579,24 @@
521 579 return $settings;
522 580 }
523 581
524 582 /**
583 + * Get the limit for the number of actions for a single form. By default, this is 99, but
584 + * it can be modified with a code snippet.
585 + *
586 + * @since 6.17 This logic from moved from FrmFormAction::get_action_for_form.
587 + *
588 + * @param int|string $form_id
589 + * @param int|string $limit The unfiltered limit value.
590 + *
591 + * @return int The filtered limit value.
592 + */
593 + public static function get_action_limit( $form_id, $limit = 99 ) {
594 + $type = 'all';
595 + return (int) apply_filters( 'frm_form_action_limit', (int) $limit, compact( 'type', 'form_id' ) );
596 + }
597 +
598 + /**
525 599 * @since 3.04
526 600 *
527 601 * @param array $args
528 602 * @param string $default_status
@@ -549,8 +623,12 @@
549 623 public static function get_single_action_type( $action_id, $type ) {
550 624 if ( ! $type ) {
551 625 return false;
552 626 }
627 +
628 + /**
629 + * @var FrmFormAction
630 + */
553 631 $action_control = FrmFormActionsController::get_form_actions( $type );
554 632
555 633 return $action_control->get_single_action( $action_id );
556 634 }
@@ -584,10 +662,10 @@
584 662 global $frm_vars;
585 663 $frm_vars['action_type'] = $type;
586 664
587 665 add_filter( 'posts_where', 'FrmFormActionsController::limit_by_type' );
588 - $query = self::action_args( $form_id, $limit );
589 - $query['post_status'] = $atts['post_status'];
666 + $query = self::action_args( $form_id, $limit );
667 + $query['post_status'] = $atts['post_status'];
590 668 $query['suppress_filters'] = false;
591 669
592 670 $actions = FrmDb::check_cache( json_encode( $query ) . '_type_' . $type, 'frm_actions', $query, 'get_posts' );
593 671 unset( $query );
@@ -635,9 +713,9 @@
635 713 return $args;
636 714 }
637 715
638 716 /**
639 - * @param WP_Post|array $action
717 + * @param array|WP_Post $action
640 718 */
641 719 public function prepare_action( $action ) {
642 720 $action->post_content = (array) FrmAppHelper::maybe_json_decode( $action->post_content );
643 721 $action->post_excerpt = sanitize_title( $action->post_excerpt );
@@ -648,9 +726,9 @@
648 726 $action->post_content += $default_values;
649 727
650 728 foreach ( $default_values as $k => $vals ) {
651 729 if ( is_array( $vals ) && ! empty( $vals ) ) {
652 - if ( 'event' == $k && ! $this->action_options['force_event'] && ! empty( $action->post_content[ $k ] ) ) {
730 + if ( 'event' === $k && ! $this->action_options['force_event'] && ! empty( $action->post_content[ $k ] ) ) {
653 731 continue;
654 732 }
655 733 $action->post_content[ $k ] = wp_parse_args( $action->post_content[ $k ], $vals );
656 734 }
@@ -734,9 +812,9 @@
734 812 /**
735 813 * Migrate settings from form->options into new action.
736 814 */
737 815 public function migrate_to_2( $form, $update = 'update' ) {
738 - $action = $this->prepare_new( $form->id );
816 + $action = $this->prepare_new( $form->id );
739 817 FrmAppHelper::unserialize_or_decode( $form->options );
740 818
741 819 // fill with existing options
742 820 foreach ( $action->post_content as $name => $val ) {
@@ -784,9 +862,9 @@
784 862 $notification = $action->post_content;
785 863 $stop = false;
786 864 $met = array();
787 865
788 - if ( ! isset( $notification['conditions'] ) || empty( $notification['conditions'] ) ) {
866 + if ( empty( $notification['conditions'] ) ) {
789 867 return $stop;
790 868 }
791 869
792 870 foreach ( $notification['conditions'] as $k => $condition ) {
@@ -803,18 +881,18 @@
803 881 $observed_value = self::get_value_from_entry( $entry, $condition['hide_field'] );
804 882
805 883 $stop = FrmFieldsHelper::value_meets_condition( $observed_value, $condition['hide_field_cond'], $condition['hide_opt'] );
806 884
807 - if ( $notification['conditions']['send_stop'] == 'send' ) {
885 + if ( $notification['conditions']['send_stop'] === 'send' ) {
808 886 $stop = $stop ? false : true;
809 887 }
810 888
811 889 $met[ $stop ] = $stop;
812 - }
890 + }//end foreach
813 891
814 - if ( $notification['conditions']['any_all'] == 'all' && ! empty( $met ) && isset( $met[0] ) && isset( $met[1] ) ) {
815 - $stop = ( $notification['conditions']['send_stop'] == 'send' );
816 - } elseif ( $notification['conditions']['any_all'] == 'any' && $notification['conditions']['send_stop'] == 'send' && isset( $met[0] ) ) {
892 + if ( $notification['conditions']['any_all'] === 'all' && ! empty( $met ) && isset( $met[0] ) && isset( $met[1] ) ) {
893 + $stop = ( $notification['conditions']['send_stop'] === 'send' );
894 + } elseif ( $notification['conditions']['any_all'] === 'any' && $notification['conditions']['send_stop'] === 'send' && isset( $met[0] ) ) {
817 895 $stop = false;
818 896 }
819 897
820 898 return $stop;
@@ -824,10 +902,8 @@
824 902 * Prepare the logic value for comparison against the entered value
825 903 *
826 904 * @since 2.01.02
827 905 *
828 - * @deprecated 4.06.02
829 - *
830 906 * @param array|string $logic_value
831 907 *
832 908 * @return void
833 909 */
@@ -835,9 +911,9 @@
835 911 if ( is_array( $logic_value ) ) {
836 912 $logic_value = reset( $logic_value );
837 913 }
838 914
839 - if ( $logic_value == 'current_user' ) {
915 + if ( $logic_value === 'current_user' ) {
840 916 $logic_value = get_current_user_id();
841 917 }
842 918
843 919 $logic_value = apply_filters( 'frm_content', $logic_value, $action->menu_order, $entry );
@@ -851,12 +927,11 @@
851 927 /**
852 928 * Get the value from a specific field and entry
853 929 *
854 930 * @since 2.01.02
855 - * @deprecated 4.06.02
856 931 *
857 932 * @param object $entry
858 - * @param int $field_id
933 + * @param int $field_id
859 934 *
860 935 * @return array|bool|mixed|string
861 936 */
862 937 private static function get_value_from_entry( $entry, $field_id ) {
@@ -921,6 +996,25 @@
921 996 * @return string
922 997 */
923 998 protected function get_upgrade_text() {
924 999 return __( 'Conditional form actions', 'formidable' );
1000 + }
1001 +
1002 + /**
1003 + * Gets form fields for form action settings.
1004 + *
1005 + * @since 6.10
1006 + *
1007 + * @param int $form_id Form ID.
1008 + * @return object[]
1009 + */
1010 + protected function get_form_fields( $form_id ) {
1011 + // Get form fields, include embedded and repeater child fields.
1012 + $form_fields = FrmField::get_all_for_form( $form_id, '', 'include' );
1013 + return array_filter(
1014 + $form_fields,
1015 + function ( $form_field ) {
1016 + return ! FrmField::is_no_save_field( $form_field->type );
1017 + }
1018 + );
925 1019 }
926 1020 }