← All changes | classes/models/FrmFormAction.php +78 -26 6.5 → 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,9 @@
34	86
35	87	/**
36	88	* Echo the settings update form
37	89	*
38		- * @param WP_Post $instance Current settings
	90	+ * @param WP_Post $instance Current settings.
39	91	* @param array $args
40	92	*/
41	93	public function form( $instance, $args = array() ) {
42	94	echo '<p class="no-options-widget">' . esc_html__( 'There are no options for this action.', 'formidable' ) . '</p>';
		@@ -69,14 +121,14 @@
69	121	*
70	122	* @param string $id_base Optional Base ID for the widget, lower case,
71	123	* if left empty a portion of the widget's class name will be used. Has to be unique.
72	124	* @param string $name Name for the widget displayed on the configuration page.
73		- * @param array $action_options Optional Passed to wp_register_sidebar_widget()
74		- * - description: shown on the configuration page
75		- * - classname
76		- * @param array $control_options Optional Passed to wp_register_widget_control()
77		- * - width: required if more than 250px
78		- * - 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.
79	131	*/
80	132	public function __construct( $id_base, $name, $action_options = array(), $control_options = array() ) {
81	133	if ( ! defined( 'ABSPATH' ) ) {
82	134	die( 'You are not allowed to call this page directly.' );
		@@ -136,9 +188,9 @@
136	188
137	189	/**
138	190	* Help to switch old field id by new field id for duplicate form
139	191	*
140		- * @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.
141	193	*
142	194	* @return string
143	195	*/
144	196	public function maybe_switch_field_ids( $action ) {
		@@ -177,9 +229,9 @@
177	229	* Constructs name attributes for use in form() fields
178	230	*
179	231	* This function should be used in form() methods to create name attributes for fields to be saved by update()
180	232	*
181		- * @param string $field_name Field name
	233	+ * @param string $field_name Field name.
182	234	*
183	235	* @return string Name attribute for $field_name
184	236	*/
185	237	public function get_field_name( $field_name, $post_field = 'post_content' ) {
		@@ -194,9 +246,9 @@
194	246	* Constructs id attributes for use in form() fields
195	247	*
196	248	* This function should be used in form() methods to create id attributes for fields to be saved by update()
197	249	*
198		- * @param string $field_name Field name
	250	+ * @param string $field_name Field name.
199	251	*
200	252	* @return string ID attribute for $field_name
201	253	*/
202	254	public function get_field_id( $field_name ) {
		@@ -271,9 +323,10 @@
271	323	unset( $action );
272	324	}
273	325	}
274	326
275		- /* Check if imported action should be created or updated
	327	+ /**
	328	+ * Check if imported action should be created or updated.
276	329	*
277	330	* @since 2.0
278	331	*
279	332	* @param array $action
		@@ -347,9 +400,9 @@
347	400	} elseif ( $ck == $subkey ) {
348	401	$action[ $ck ] = $this->maybe_switch_field_ids( $action[ $ck ] );
349	402	}
350	403	}
351		- }
	404	+ }//end if
352	405
353	406	return $action;
354	407	}
355	408
		@@ -412,9 +465,8 @@
412	465	*
413	466	* @param array $instance The current widget instance's settings.
414	467	* @param array $new_instance Array of new widget settings.
415	468	* @param array $old_instance Array of old widget settings.
416		- * @param WP_Widget $this The current widget instance.
417	469	*/
418	470	$instance = apply_filters( 'frm_action_update_callback', $instance, $new_instance, $old_instance, $this );
419	471
420	472	$instance['post_content'] = apply_filters( 'frm_before_save_action', $instance['post_content'], $instance, $new_instance, $old_instance, $this );
		@@ -426,9 +478,9 @@
426	478
427	479	$action_ids[] = $this->save_settings( $instance );
428	480
429	481	$this->updated = true;
430		- }
	482	+ }//end foreach
431	483
432	484	return $action_ids;
433	485	}
434	486
		@@ -809,9 +861,9 @@
809	861	$stop = $stop ? false : true;
810	862	}
811	863
812	864	$met[ $stop ] = $stop;
813		- }
	865	+ }//end foreach
814	866
815	867	if ( $notification['conditions']['any_all'] == 'all' && ! empty( $met ) && isset( $met[0] ) && isset( $met[1] ) ) {
816	868	$stop = ( $notification['conditions']['send_stop'] == 'send' );
817	869	} elseif ( $notification['conditions']['any_all'] == 'any' && $notification['conditions']['send_stop'] == 'send' && isset( $met[0] ) ) {
		@@ -855,9 +907,9 @@
855	907	* @since 2.01.02
856	908	* @deprecated 4.06.02
857	909	*
858	910	* @param object $entry
859		- * @param int $field_id
	911	+ * @param int $field_id
860	912	*
861	913	* @return array|bool|mixed|string
862	914	*/
863	915	private static function get_value_from_entry( $entry, $field_id ) {