← All changes | classes/models/FrmFormAction.php +80 -27 6.4 → 6.8 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.' );
		@@ -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,9 +229,9 @@
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' ) {
		@@ -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,9 +323,10 @@
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
		@@ -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
		@@ -411,9 +465,8 @@
411	465	*
412	466	* @param array $instance The current widget instance's settings.
413	467	* @param array $new_instance Array of new widget settings.
414	468	* @param array $old_instance Array of old widget settings.
415		- * @param WP_Widget $this The current widget instance.
416	469	*/
417	470	$instance = apply_filters( 'frm_action_update_callback', $instance, $new_instance, $old_instance, $this );
418	471
419	472	$instance['post_content'] = apply_filters( 'frm_before_save_action', $instance['post_content'], $instance, $new_instance, $old_instance, $this );
		@@ -425,9 +478,9 @@
425	478
426	479	$action_ids[] = $this->save_settings( $instance );
427	480
428	481	$this->updated = true;
429		- }
	482	+ }//end foreach
430	483
431	484	return $action_ids;
432	485	}
433	486
		@@ -648,9 +701,9 @@
648	701	$action->post_content += $default_values;
649	702
650	703	foreach ( $default_values as $k => $vals ) {
651	704	if ( is_array( $vals ) && ! empty( $vals ) ) {
652		- if ( 'event' == $k && ! $this->action_options['force_event'] && ! empty( $action->post_content[ $k ] ) ) {
	705	+ if ( 'event' === $k && ! $this->action_options['force_event'] && ! empty( $action->post_content[ $k ] ) ) {
653	706	continue;
654	707	}
655	708	$action->post_content[ $k ] = wp_parse_args( $action->post_content[ $k ], $vals );
656	709	}
		@@ -808,9 +861,9 @@
808	861	$stop = $stop ? false : true;
809	862	}
810	863
811	864	$met[ $stop ] = $stop;
812		- }
	865	+ }//end foreach
813	866
814	867	if ( $notification['conditions']['any_all'] == 'all' && ! empty( $met ) && isset( $met[0] ) && isset( $met[1] ) ) {
815	868	$stop = ( $notification['conditions']['send_stop'] == 'send' );
816	869	} elseif ( $notification['conditions']['any_all'] == 'any' && $notification['conditions']['send_stop'] == 'send' && isset( $met[0] ) ) {
		@@ -854,9 +907,9 @@
854	907	* @since 2.01.02
855	908	* @deprecated 4.06.02
856	909	*
857	910	* @param object $entry
858		- * @param int $field_id
	911	+ * @param int $field_id
859	912	*
860	913	* @return array|bool|mixed|string
861	914	*/
862	915	private static function get_value_from_entry( $entry, $field_id ) {