← All changes | classes/controllers/FrmFormTemplatesController.php +64 -93 6.28 → 6.8 View file →

		@@ -19,9 +19,9 @@
19	19
20	20	/**
21	21	* The slug of the Form Templates page.
22	22	*
23		- * @var string Unique identifier for the "Form Templates" page.
	23	+ * @var string PAGE_SLUG Unique identifier for the "Form Templates" page.
24	24	*/
25	25	const PAGE_SLUG = 'formidable-form-templates';
26	26
27	27	/**
		@@ -26,9 +26,9 @@
26	26
27	27	/**
28	28	* The script handle.
29	29	*
30		- * @var string Unique handle for the admin script.
	30	+ * @var string SCRIPT_HANDLE Unique handle for the admin script.
31	31	*/
32	32	const SCRIPT_HANDLE = 'frm-form-templates';
33	33
34	34	/**
		@@ -33,33 +33,26 @@
33	33
34	34	/**
35	35	* The required user capability to view form templates.
36	36	*
37		- * @var string Required capability to access the view form templates.
	37	+ * @var string REQUIRED_CAPABILITY Required capability to access the view form templates.
38	38	*/
39	39	const REQUIRED_CAPABILITY = 'frm_view_forms';
40	40
41	41	/**
42		- * The IDs of the featured templates.
	42	+ * The keys of the featured templates.
43	43	*
44		- * Contains the unique IDs for the templates that are considered "featured":
	44	+ * Contains the unique keys for the templates that are considered "featured":
45	45	* "Contact Us", "Stripe Payment", "User Registration", "Create WordPress Post", "Survey", and "Quiz".
46	46	*
47		- * @var array Unique IDs for the featured templates.
	47	+ * @var array FEATURED_TEMPLATES_KEYS Unique keys for the featured templates.
48	48	*/
49		- const FEATURED_TEMPLATES_IDS = array( 20872734, 28223640, 20874748, 20882522, 20908981, 28109851 );
	49	+ const FEATURED_TEMPLATES_KEYS = array( 20872734, 28223640, 20874748, 20882522, 20908981, 28109851 );
50	50
51	51	/**
52		- * The IDs of the free templates.
53		- *
54		- * @var array Unique IDs for the free templates.
55		- */
56		- const FREE_TEMPLATES_IDS = array( 20872734, 28223640 );
57		-
58		- /**
59	52	* Option name to store favorite templates.
60	53	*
61		- * @var string Unique identifier for storing favorite templates.
	54	+ * @var string FAVORITE_TEMPLATES_OPTION Unique identifier for storing favorite templates.
62	55	*/
63	56	const FAVORITE_TEMPLATES_OPTION = 'frm_favorite_templates';
64	57
65	58	/**
		@@ -64,9 +57,9 @@
64	57
65	58	/**
66	59	* Instance of the Form Template API handler.
67	60	*
68		- * @var FrmFormTemplateApi Form Template API handler.
	61	+ * @var FrmFormTemplateApi $form_template_api Form Template API handler.
69	62	*/
70	63	private static $form_template_api;
71	64
72	65	/**
		@@ -71,9 +64,9 @@
71	64
72	65	/**
73	66	* Templates fetched from the API.
74	67	*
75		- * @var array Templates information from API.
	68	+ * @var array $templates Templates information from API.
76	69	*/
77	70	private static $templates = array();
78	71
79	72	/**
		@@ -78,9 +71,9 @@
78	71
79	72	/**
80	73	* Featured templates.
81	74	*
82		- * @var array Associative array with the featured templates' information.
	75	+ * @var array $featured_templates Associative array with the featured templates' information.
83	76	*/
84	77	private static $featured_templates = array();
85	78
86	79	/**
		@@ -85,9 +78,9 @@
85	78
86	79	/**
87	80	* List of user favorite templates.
88	81	*
89		- * @var array List of templates that the user has marked as favorites.
	82	+ * @var array $favorite_templates List of templates that the user has marked as favorites.
90	83	*/
91	84	private static $favorite_templates = array();
92	85
93	86	/**
		@@ -92,9 +85,9 @@
92	85
93	86	/**
94	87	* Templates fetched from the published form by user.
95	88	*
96		- * @var array Templates information from published form.
	89	+ * @var array $custom_templates Templates information from published form.
97	90	*/
98	91	private static $custom_templates = array();
99	92
100	93	/**
		@@ -99,9 +92,9 @@
99	92
100	93	/**
101	94	* Categories for organizing templates.
102	95	*
103		- * @var array Categories for organizing templates.
	96	+ * @var array $categories Categories for organizing templates.
104	97	*/
105	98	private static $categories = array();
106	99
107	100	/**
		@@ -106,9 +99,9 @@
106	99
107	100	/**
108	101	* Status of API request, true if expired.
109	102	*
110		- * @var bool Whether the API request is expired or not.
	103	+ * @var bool $is_expired Whether the API request is expired or not.
111	104	*/
112	105	private static $is_expired = false;
113	106
114	107	/**
		@@ -113,9 +106,9 @@
113	106
114	107	/**
115	108	* The type of license received from the API.
116	109	*
117		- * @var string License type received from the API.
	110	+ * @var string $license_type License type received from the API.
118	111	*/
119	112	private static $license_type = '';
120	113
121	114	/**
		@@ -120,9 +113,9 @@
120	113
121	114	/**
122	115	* Path to views.
123	116	*
124		- * @var string Path to form templates views.
	117	+ * @var string $view_path Path to form templates views.
125	118	*/
126	119	private static $view_path = '';
127	120
128	121	/**
		@@ -127,9 +120,9 @@
127	120
128	121	/**
129	122	* Upgrade URL.
130	123	*
131		- * @var string URL for upgrading accounts.
	124	+ * @var string $upgrade_link URL for upgrading accounts.
132	125	*/
133	126	private static $upgrade_link = '';
134	127
135	128	/**
		@@ -134,9 +127,9 @@
134	127
135	128	/**
136	129	* Renew URL.
137	130	*
138		- * @var string URL for renewing accounts.
	131	+ * @var string $renew_link URL for renewing accounts.
139	132	*/
140	133	private static $renew_link = '';
141	134
142	135	/**
		@@ -142,26 +135,22 @@
142	135	/**
143	136	* Initialize hooks for template page only.
144	137	*
145	138	* @since 6.7
146		- *
147		- * @return void
148	139	*/
149	140	public static function load_admin_hooks() {
150	141	self::init_template_resources();
151	142
152	143	// Use the same priority as Applications so Form Templates appear directly under Applications.
153		- add_action( 'admin_menu', self::class . '::menu', 14 );
154		- add_action( 'admin_footer', self::class . '::render_modal' );
155		- add_filter( 'frm_form_nav_list', self::class . '::append_new_template_to_nav', 10, 2 );
	144	+ add_action( 'admin_menu', __CLASS__ . '::menu', 14 );
	145	+ add_action( 'admin_footer', __CLASS__ . '::render_modal' );
	146	+ add_filter( 'frm_form_nav_list', __CLASS__ . '::append_new_template_to_nav', 10, 2 );
156	147
157		- if ( ! self::is_templates_page() ) {
158		- return;
	148	+ if ( self::is_templates_page() ) {
	149	+ add_action( 'admin_init', __CLASS__ . '::set_form_templates_data' );
	150	+ add_action( 'admin_enqueue_scripts', __CLASS__ . '::enqueue_assets', 15 );
	151	+ add_filter( 'frm_show_footer_links', '__return_false' );
159	152	}
160		-
161		- add_action( 'admin_init', self::class . '::set_form_templates_data' );
162		- add_action( 'admin_enqueue_scripts', self::class . '::enqueue_assets', 15 );
163		- add_filter( 'frm_show_footer_links', '__return_false' );
164	153	}
165	154
166	155	/**
167	156	* Add Form Templates menu item to sidebar and define index page.
		@@ -178,9 +167,9 @@
178	167	'Formidable | ' . $label,
179	168	$label,
180	169	self::REQUIRED_CAPABILITY,
181	170	self::PAGE_SLUG,
182		- array( self::class, 'render' )
	171	+ array( __CLASS__, 'render' )
183	172	);
184	173	}
185	174
186	175	/**
		@@ -210,8 +199,9 @@
210	199	$featured_templates = self::get_featured_templates();
211	200	$custom_templates = self::get_custom_templates();
212	201	$categories = self::get_categories();
213	202
	203	+ // Render the view.
214	204	include $view_path . 'index.php';
215	205	}
216	206
217	207	/**
		@@ -236,15 +226,12 @@
236	226
237	227	// Add `create-template` modal view.
238	228	$view_parts[] = 'modals/create-template-modal.php';
239	229
240		- if ( FrmFormTemplatesHelper::needs_get_free_templates_banner() ) {
241		- $leave_email_args = array(
242		- 'title' => esc_html__( 'Get 30+ Free Form Templates', 'formidable' ),
243		- 'description' => esc_html__( 'Just add your email address and you\'ll get 30+ free form templates to your account.', 'formidable' ),
244		- 'submit_button_text' => esc_html_x( 'Get Templates', 'get free templates modal submit button text', 'formidable' ),
245		- );
246		- $view_parts[] = 'modals/leave-email-modal.php';
	230	+ // Add 'leave-email' and 'code-from-email' modals views for users without Pro or free access.
	231	+ if ( ! FrmAppHelper::pro_is_installed() && ! self::$form_template_api->has_free_access() ) {
	232	+ $view_parts[] = 'modals/leave-email-modal.php';
	233	+ $view_parts[] = 'modals/code-from-email-modal.php';
247	234	}
248	235
249	236	// Add 'upgrade' modal view for non-elite users.
250	237	if ( 'elite' !== FrmAddonsController::license_type() ) {
		@@ -265,8 +252,9 @@
265	252	$view_parts[] = 'modals/name-your-form-modal.php';
266	253	}
267	254	}
268	255
	256	+ // Render the view.
269	257	include $view_path . 'modal.php';
270	258	}
271	259
272	260	/**
		@@ -344,9 +332,8 @@
344	332	if ( 'add' === $operation ) {
345	333	self::$favorite_templates[ $key ][] = $template_id;
346	334	} elseif ( 'remove' === $operation ) {
347	335	$position = array_search( $template_id, self::$favorite_templates[ $key ], true );
348		-
349	336	if ( $position !== false ) {
350	337	unset( self::$favorite_templates[ $key ][ $position ] );
351	338	}
352	339	}
		@@ -396,37 +383,8 @@
396	383	wp_die();
397	384	}
398	385
399	386	/**
400		- * Handle AJAX request to subscribe the user to ActiveCampaign.
401		- *
402		- * @since 6.25
403		- *
404		- * @return void
405		- */
406		- public static function ajax_get_free_templates() {
407		- FrmAppHelper::permission_check( self::REQUIRED_CAPABILITY );
408		- check_ajax_referer( 'frm_ajax', 'nonce' );
409		-
410		- $email = FrmAppHelper::get_post_param( 'email', '', 'sanitize_email' );
411		-
412		- if ( ! $email || ! is_email( $email ) ) {
413		- wp_send_json_error(
414		- array( 'message' => __( 'Please enter a valid email address.', 'formidable' ) ),
415		- WP_Http::BAD_REQUEST
416		- );
417		- }
418		-
419		- self::$form_template_api = new FrmFormTemplateApi();
420		- self::$form_template_api->reset_cached();
421		-
422		- FrmEmailCollectionHelper::subscribe_to_active_campaign( $email );
423		- self::$form_template_api::set_free_license_code( '1' );
424		-
425		- wp_send_json_success();
426		- }
427		-
428		- /**
429	387	* Fetch and format custom templates.
430	388	*
431	389	* Retrieves the custom templates, formats them, and assigns them to the class property.
432	390	*
		@@ -503,9 +461,9 @@
503	461	private static function organize_and_set_categories() {
504	462	// Iterate through templates to assign categories.
505	463	foreach ( self::$templates as $key => &$template ) {
506	464	// Skip the template if the categories are not set.
507		- if ( ! isset( $template['categories'] ) || ! isset( $template['id'] ) ) {
	465	+ if ( ! isset( $template['categories'] ) ) {
508	466	unset( self::$templates[ $key ] );
509	467	continue;
510	468	}
511	469
		@@ -525,9 +483,9 @@
525	483	'count' => 0,
526	484	);
527	485	}
528	486
529		- ++self::$categories[ $category_slug ]['count'];
	487	+ self::$categories[ $category_slug ]['count']++;
530	488	}
531	489
532	490	// Mark the template as favorite if it's in the favorite templates list.
533	491	$template['is_favorite'] = in_array( $template['id'], self::$favorite_templates['default'], true );
		@@ -537,10 +495,9 @@
537	495	unset( $template );
538	496
539	497	// Filter out certain and redundant categories.
540	498	// 'PayPal', 'Stripe', and 'Twilio' are included elsewhere and should be ignored in this context.
541		- $redundant_cats = array_merge( array( 'PayPal', 'Stripe', 'Twilio' ), FrmFormsHelper::get_license_types() );
542		-
	499	+ $redundant_cats = array_merge( array( 'PayPal', 'Stripe', 'Twilio' ), FrmFormsHelper::ignore_template_categories() );
543	500	foreach ( $redundant_cats as $redundant_cat ) {
544	501	$category_slug = sanitize_title( $redundant_cat );
545	502	unset( self::$categories[ $category_slug ] );
546	503	}
		@@ -558,9 +515,8 @@
558	515	'name' => __( 'Custom', 'formidable' ),
559	516	'count' => count( self::$custom_templates ),
560	517	),
561	518	);
562		-
563	519	// Add the 'Available Templates' category for non-elite users.
564	520	if ( 'elite' !== FrmAddonsController::license_type() ) {
565	521	$special_categories['available-templates'] = array(
566	522	'name' => __( 'Available Templates', 'formidable' ),
		@@ -567,13 +523,17 @@
567	523	// Assigned via JavaScript.
568	524	'count' => 0,
569	525	);
570	526	}
571		-
572		- $special_categories['all-items'] = array(
	527	+ $special_categories['all-templates'] = array(
573	528	'name' => __( 'All Templates', 'formidable' ),
574	529	'count' => self::get_template_count(),
575	530	);
	531	+ $special_categories['free-templates'] = array(
	532	+ 'name' => __( 'Free Templates', 'formidable' ),
	533	+ // Assigned via JavaScript.
	534	+ 'count' => 0,
	535	+ );
576	536
577	537	self::$categories = array_merge(
578	538	$special_categories,
579	539	self::$categories
		@@ -582,9 +542,9 @@
582	542
583	543	/**
584	544	* Assign featured templates.
585	545	*
586		- * Iterates through FEATURED_TEMPLATES_IDS and adds matching templates to
	546	+ * Iterates through FEATURED_TEMPLATES_KEYS and adds matching templates to
587	547	* the `featured_templates` class property.
588	548	*
589	549	* @since 6.7
590	550	*
		@@ -590,9 +550,9 @@
590	550	*
591	551	* @return void
592	552	*/
593	553	private static function assign_featured_templates() {
594		- foreach ( self::FEATURED_TEMPLATES_IDS as $key ) {
	554	+ foreach ( self::FEATURED_TEMPLATES_KEYS as $key ) {
595	555	if ( isset( self::$templates[ $key ] ) ) {
596	556	self::$templates[ $key ]['is_featured'] = true;
597	557	self::$featured_templates[] = self::$templates[ $key ];
598	558	}
		@@ -661,9 +621,8 @@
661	621	* @since 6.7
662	622	*
663	623	* @param array $nav_items Navigation items.
664	624	* @param array $nav_args Additional navigation arguments.
665		- *
666	625	* @return array Modified navigation items with 'new_template' query parameter.
667	626	*/
668	627	public static function append_new_template_to_nav( $nav_items, $nav_args ) {
669	628	$is_new_template = FrmAppHelper::simple_get( 'new_template' );
		@@ -696,9 +655,8 @@
696	655	);
697	656
698	657	// Enqueue styles that needed.
699	658	wp_enqueue_style( 'formidable-admin' );
700		- wp_enqueue_style( 'formidable-animations' );
701	659	wp_enqueue_style( 'formidable-grids' );
702	660
703	661	// Register and enqueue "Form Templates" style.
704	662	wp_register_style( self::SCRIPT_HANDLE, $plugin_url . '/css/admin/form-templates.css', array(), $version );
		@@ -715,9 +673,9 @@
715	673	* @since 6.7
716	674	*/
717	675	do_action( 'frm_form_templates_enqueue_assets' );
718	676
719		- FrmAppHelper::dequeue_extra_global_scripts();
	677	+ self::dequeue_scripts();
720	678	}
721	679
722	680	/**
723	681	* Get "Form Templates" JS variables as an array.
		@@ -727,18 +685,17 @@
727	685	* @return array
728	686	*/
729	687	private static function get_js_variables() {
730	688	$js_variables = array(
731		- 'FEATURED_TEMPLATES_IDS' => self::FEATURED_TEMPLATES_IDS,
732		- 'FREE_TEMPLATES_IDS' => self::FREE_TEMPLATES_IDS,
733		- 'templatesCount' => self::get_template_count(),
734		- 'favoritesCount' => array(
	689	+ 'FEATURED_TEMPLATES_KEYS' => self::FEATURED_TEMPLATES_KEYS,
	690	+ 'templatesCount' => self::get_template_count(),
	691	+ 'favoritesCount' => array(
735	692	'total' => self::get_favorite_templates_count(),
736	693	'default' => count( self::$favorite_templates['default'] ),
737	694	'custom' => count( self::$favorite_templates['custom'] ),
738	695	),
739		- 'customCount' => count( self::$custom_templates ),
740		- 'upgradeLink' => self::$upgrade_link,
	696	+ 'customCount' => count( self::$custom_templates ),
	697	+ 'upgradeLink' => self::$upgrade_link,
741	698	);
742	699
743	700	/**
744	701	* Filters `js_variables` passed to the "Form Templates".
		@@ -747,8 +704,22 @@
747	704	*
748	705	* @param array $js_variables Array of js_variables passed to "Form Templates".
749	706	*/
750	707	return apply_filters( 'frm_form_templates_js_variables', $js_variables );
	708	+ }
	709	+
	710	+ /**
	711	+ * Dequeue scripts and styles on "Form Templates".
	712	+ *
	713	+ * Avoid extra scripts loading on "Form Templates" page that aren't needed.
	714	+ *
	715	+ * @since 6.7
	716	+ *
	717	+ * @return void
	718	+ */
	719	+ private static function dequeue_scripts() {
	720	+ wp_dequeue_script( 'frm-surveys-admin' );
	721	+ wp_dequeue_script( 'frm-quizzes-form-action' );
751	722	}
752	723
753	724	/**
754	725	* Check if the current page is the form templates page.