forbidals

Back Back Up Advanced Editor

<?php
/**
 * Form Templates Controller class.
 *
 * @package Formidable
 */

if ( ! defined( 'ABSPATH' ) ) {
	die( 'You are not allowed to call this page directly.' );
}

/**
 * Class FrmFormTemplatesController.
 * Handles the Form Templates page in the admin area.
 *
 * @since 6.7
 */
class FrmFormTemplatesController {

/**
	 * The slug of the Form Templates page.
	 *
	 * @var string Unique identifier for the "Form Templates" page.
	 */
	const PAGE_SLUG = 'formidable-form-templates';

/**
	 * The script handle.
	 *
	 * @var string Unique handle for the admin script.
	 */
	const SCRIPT_HANDLE = 'frm-form-templates';

/**
	 * The required user capability to view form templates.
	 *
	 * @var string Required capability to access the view form templates.
	 */
	const REQUIRED_CAPABILITY = 'frm_view_forms';

/**
	 * The IDs of the featured templates.
	 *
	 * Contains the unique IDs for the templates that are considered "featured":
	 * "Contact Us", "Stripe Payment", "User Registration", "Create WordPress Post", "Survey", and "Quiz".
	 *
	 * @var array Unique IDs for the featured templates.
	 */
	const FEATURED_TEMPLATES_IDS = array( 20872734, 28223640, 20874748, 20882522, 20908981, 28109851 );

/**
	 * The IDs of the free templates.
	 *
	 * @var array Unique IDs for the free templates.
	 */
	const FREE_TEMPLATES_IDS = array( 20872734, 28223640 );

/**
	 * Option name to store favorite templates.
	 *
	 * @var string Unique identifier for storing favorite templates.
	 */
	const FAVORITE_TEMPLATES_OPTION = 'frm_favorite_templates';

/**
	 * Instance of the Form Template API handler.
	 *
	 * @var FrmFormTemplateApi Form Template API handler.
	 */
	private static $form_template_api;

/**
	 * Templates fetched from the API.
	 *
	 * @var array Templates information from API.
	 */
	private static $templates = array();

/**
	 * Featured templates.
	 *
	 * @var array Associative array with the featured templates' information.
	 */
	private static $featured_templates = array();

/**
	 * List of user favorite templates.
	 *
	 * @var array List of templates that the user has marked as favorites.
	 */
	private static $favorite_templates = array();

/**
	 * Templates fetched from the published form by user.
	 *
	 * @var array Templates information from published form.
	 */
	private static $custom_templates = array();

/**
	 * Categories for organizing templates.
	 *
	 * @var array Categories for organizing templates.
	 */
	private static $categories = array();

/**
	 * Status of API request, true if expired.
	 *
	 * @var bool Whether the API request is expired or not.
	 */
	private static $is_expired = false;

/**
	 * The type of license received from the API.
	 *
	 * @var string License type received from the API.
	 */
	private static $license_type = '';

/**
	 * Path to views.
	 *
	 * @var string Path to form templates views.
	 */
	private static $view_path = '';

/**
	 * Upgrade URL.
	 *
	 * @var string URL for upgrading accounts.
	 */
	private static $upgrade_link = '';

/**
	 * Renew URL.
	 *
	 * @var string URL for renewing accounts.
	 */
	private static $renew_link = '';

/**
	 * Initialize hooks for template page only.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function load_admin_hooks() {
		self::init_template_resources();

// Use the same priority as Applications so Form Templates appear directly under Applications.
		add_action( 'admin_menu', self::class . '::menu', 14 );
		add_action( 'admin_footer', self::class . '::render_modal' );
		add_filter( 'frm_form_nav_list', self::class . '::append_new_template_to_nav', 10, 2 );

if ( self::is_templates_page() ) {
			add_action( 'admin_init', self::class . '::set_form_templates_data' );
			add_action( 'admin_enqueue_scripts', self::class . '::enqueue_assets', 15 );
			add_filter( 'frm_show_footer_links', '__return_false' );
		}
	}

/**
	 * Add Form Templates menu item to sidebar and define index page.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function menu() {
		$label = __( 'Form Templates', 'formidable' );

add_submenu_page(
			'formidable',
			'Formidable | ' . $label,
			$label,
			self::REQUIRED_CAPABILITY,
			self::PAGE_SLUG,
			array( self::class, 'render' )
		);
	}

/**
	 * Renders the Form Templates page in the WordPress admin area.
	 *
	 * Sets up template data, fetches relevant information, determines which blocks to render,
	 * and includes the view file for displaying the Form Templates page.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function render() {
		// Include SVG images for icons.
		FrmAppHelper::include_svg();

$view_path    = self::get_view_path();
		$upgrade_link = self::get_upgrade_link();
		$renew_link   = self::get_renew_link();
		$license_type = self::get_license_type();
		$pricing      = FrmAppHelper::admin_upgrade_link( 'form-templates' );
		$expired      = self::is_expired();

// Get various template types and categories.
		$templates          = self::get_templates();
		$favorite_templates = self::get_favorite_templates();
		$featured_templates = self::get_featured_templates();
		$custom_templates   = self::get_custom_templates();
		$categories         = self::get_categories();

include $view_path . 'index.php';
	}

/**
	 * Renders a modal component in the WordPress admin area.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function render_modal() {
		$view_path  = self::$view_path;
		$view_parts = array();

// Check if the current page is the form templates page.
		if ( self::is_templates_page() ) {
			// User and license-related variables.
			$user            = wp_get_current_user();
			$expired         = self::is_expired();
			$upgrade_link    = self::get_upgrade_link();
			$renew_link      = self::get_renew_link();
			$published_forms = self::get_published_forms();

// Add `create-template` modal view.
			$view_parts[] = 'modals/create-template-modal.php';

if ( FrmFormTemplatesHelper::needs_get_free_templates_banner() ) {
				$leave_email_args = array(
					'title'              => esc_html__( 'Get 30+ Free Form Templates', 'formidable' ),
					'description'        => esc_html__( 'Just add your email address and you\'ll get 30+ free form templates to your account.', 'formidable' ),
					'submit_button_text' => esc_html_x( 'Get Templates', 'get free templates modal submit button text', 'formidable' ),
				);
				$view_parts[]     = 'modals/leave-email-modal.php';
			}

// Add 'upgrade' modal view for non-elite users.
			if ( 'elite' !== FrmAddonsController::license_type() ) {
				$view_parts[] = 'modals/upgrade-modal.php';
			}

// Add 'renew-account' modal view for expired users.
			if ( $expired ) {
				$view_parts[] = 'modals/renew-account-modal.php';
			}
		}//end if

// Check if the current page is the form builder page.
		if ( FrmAppHelper::is_admin_page( 'formidable' ) ) {
			$action = FrmAppHelper::simple_get( 'frm_action', 'sanitize_title' );

if ( 'edit' === $action || 'settings' === $action ) {
				$view_parts[] = 'modals/name-your-form-modal.php';
			}
		}

include $view_path . 'modal.php';
	}

/**
	 * Initializes and organizes form template data by performing the following actions:
	 * - Instantiates the Form Template API class
	 * - Retrieves and sets templates, including featured ones
	 * - Organizes and categorizes templates
	 * - Formats custom templates
	 * - Updates global variables to reflect the current state
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function set_form_templates_data() {
		self::$form_template_api = new FrmFormTemplateApi();

self::init_favorite_templates();
		self::fetch_and_format_custom_templates();
		self::retrieve_and_set_templates();
		self::organize_and_set_categories();
		self::assign_featured_templates();
	}

/**
	 * Initialize favorite templates from WordPress options.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	private static function init_favorite_templates() {
		$default_option_structure = array(
			'default' => array(),
			'custom'  => array(),
		);

$favorites = get_option( self::FAVORITE_TEMPLATES_OPTION, $default_option_structure );
		$favorites = wp_parse_args( $favorites, $default_option_structure );

// Set the favorite templates property and remove empty values.
		self::$favorite_templates = array(
			'default' => array_filter( (array) $favorites['default'] ),
			'custom'  => array_filter( (array) $favorites['custom'] ),
		);
	}

/**
	 * Handle AJAX request to add or remove favorite templates.
	 *
	 * Manages the $favorite_templates by using WordPress options to
	 * add or remove templates from the favorites list.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function ajax_add_or_remove_favorite() {
		// Check permission and nonce.
		FrmAppHelper::permission_check( self::REQUIRED_CAPABILITY );
		check_ajax_referer( 'frm_ajax', 'nonce' );

// Set up form templates environment, ensuring data is ready for processing.
		self::set_form_templates_data();

// Get posted data.
		$template_id        = FrmAppHelper::get_post_param( 'template_id', '', 'absint' );
		$operation          = FrmAppHelper::get_post_param( 'operation', '', 'sanitize_text_field' );
		$is_custom_template = FrmAppHelper::get_post_param( 'is_custom_template', '', 'rest_sanitize_boolean' );

// Determine the key based on whether it's a custom template or not.
		$key = $is_custom_template ? 'custom' : 'default';

// Perform add or remove operation.
		if ( 'add' === $operation ) {
			self::$favorite_templates[ $key ][] = $template_id;
		} elseif ( 'remove' === $operation ) {
			$position = array_search( $template_id, self::$favorite_templates[ $key ], true );

if ( $position !== false ) {
				unset( self::$favorite_templates[ $key ][ $position ] );
			}
		}

// Update the favorite templates option.
		update_option( self::FAVORITE_TEMPLATES_OPTION, self::$favorite_templates );

// Return the updated list of favorite templates.
		wp_send_json_success( self::$favorite_templates );
	}

/**
	 * Create a custom template from a form.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function ajax_create_template() {
		// Check permission and nonce.
		FrmAppHelper::permission_check( self::REQUIRED_CAPABILITY );
		check_ajax_referer( 'frm_ajax', 'nonce' );

// Set up form templates environment, ensuring data is ready for processing.
		self::set_form_templates_data();

// Get posted data.
		$form_id     = FrmAppHelper::get_param( 'xml', '', 'post', 'absint' );
		$new_form_id = FrmForm::duplicate( $form_id, 1, true );

if ( ! $new_form_id ) {
			// Send an error response if form duplication fails.
			$response = array(
				'message' => __( 'There was an error creating a template.', 'formidable' ),
			);
		} else {
			FrmForm::update( $new_form_id, FrmFormsController::get_modal_values() );

// Send a success response with redirect URL.
			$response = array(
				'redirect' => admin_url( 'admin.php?page=formidable&frm_action=duplicate&id=' . $new_form_id ) . '&_wpnonce=' . wp_create_nonce(),
			);
		}

// Send response.
		echo wp_json_encode( $response );
		wp_die();
	}

/**
	 * Handle AJAX request to subscribe the user to ActiveCampaign.
	 *
	 * @since 6.25
	 *
	 * @return void
	 */
	public static function ajax_get_free_templates() {
		FrmAppHelper::permission_check( self::REQUIRED_CAPABILITY );
		check_ajax_referer( 'frm_ajax', 'nonce' );

$email = FrmAppHelper::get_post_param( 'email', '', 'sanitize_email' );

if ( ! $email || ! is_email( $email ) ) {
			wp_send_json_error(
				array( 'message' => __( 'Please enter a valid email address.', 'formidable' ) ),
				WP_Http::BAD_REQUEST
			);
		}

self::$form_template_api = new FrmFormTemplateApi();
		self::$form_template_api->reset_cached();

FrmEmailCollectionHelper::subscribe_to_active_campaign( $email );
		self::$form_template_api::set_free_license_code( '1' );

wp_send_json_success();
	}

/**
	 * Fetch and format custom templates.
	 *
	 * Retrieves the custom templates, formats them, and assigns them to the class property.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	private static function fetch_and_format_custom_templates() {
		// Get all custom templates that are not default templates.
		$custom_templates = FrmForm::getAll(
			array(
				'is_template'      => 1,
				'default_template' => 0,
				'status'           => array( null, '', 'published' ),
			),
			'name'
		);

// Extract IDs from the custom templates for matching with favorite templates.
		$custom_templates_ids = wp_list_pluck( $custom_templates, 'id' );

// Refine the list of favorite templates to include only those present in custom templates.
		self::$favorite_templates['custom'] = array_intersect( self::$favorite_templates['custom'], $custom_templates_ids );

foreach ( $custom_templates as $template ) {
			$template = array(
				'id'          => absint( $template->id ),
				'name'        => $template->name,
				'key'         => $template->form_key,
				'description' => $template->description,
				'link'        => FrmForm::get_edit_link( absint( $template->id ) ),
				'url'         => wp_nonce_url( admin_url( 'admin.php?page=formidable&frm_action=duplicate&new_template=true&id=' . absint( $template->id ) ) ),
				'released'    => $template->created_at,
				'installed'   => 1,
				'is_custom'   => true,
				'created_at'  => $template->created_at,
			);

// Mark the template as favorite if it's in the favorite templates list.
			$template['is_favorite'] = in_array( $template['id'], self::$favorite_templates['custom'], true );

// Add the formatted template to the custom templates list.
			array_unshift( self::$custom_templates, $template );
		}
	}

/**
	 * Retrieve and set templates.
	 *
	 * Gets the templates from the API and assigns them to the class property.
	 * Also handles any errors returned from the API.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	private static function retrieve_and_set_templates() {
		self::$templates = self::$form_template_api->get_api_info();

self::$is_expired   = FrmAddonsController::is_license_expired();
		self::$license_type = FrmAddonsController::license_type();
	}

/**
	 * Organize and set categories.
	 *
	 * Iterates through templates to organize categories, performs filtering, sorting,
	 * and adds special categories.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	private static function organize_and_set_categories() {
		// Iterate through templates to assign categories.
		foreach ( self::$templates as $key => &$template ) {
			// Skip the template if the categories are not set.
			if ( ! isset( $template['categories'] ) || ! isset( $template['id'] ) ) {
				unset( self::$templates[ $key ] );
				continue;
			}

// Add a new key for category slugs.
			$template['category_slugs'] = array();

// Increment the count for each category.
			foreach ( $template['categories'] as $category ) {
				$category_slug = sanitize_title( $category );

// Add the slug to the new array.
				$template['category_slugs'][] = $category_slug;

if ( ! isset( self::$categories[ $category_slug ] ) ) {
					self::$categories[ $category_slug ] = array(
						'name'  => $category,
						'count' => 0,
					);
				}

++self::$categories[ $category_slug ]['count'];
			}

// Mark the template as favorite if it's in the favorite templates list.
			$template['is_favorite'] = in_array( $template['id'], self::$favorite_templates['default'], true );
		}//end foreach

// Unset the reference `$template` variable.
		unset( $template );

// Filter out certain and redundant categories.
		// 'PayPal', 'Stripe', and 'Twilio' are included elsewhere and should be ignored in this context.
		$redundant_cats = array_merge( array( 'PayPal', 'Stripe', 'Twilio' ), FrmFormsHelper::get_license_types() );

foreach ( $redundant_cats as $redundant_cat ) {
			$category_slug = sanitize_title( $redundant_cat );
			unset( self::$categories[ $category_slug ] );
		}

// Sort the categories by keys alphabetically.
		ksort( self::$categories );

// Add special categories.
		$special_categories = array(
			'favorites' => array(
				'name'  => __( 'Favorites', 'formidable' ),
				'count' => self::get_favorite_templates_count(),
			),
			'custom'    => array(
				'name'  => __( 'Custom', 'formidable' ),
				'count' => count( self::$custom_templates ),
			),
		);

// Add the 'Available Templates' category for non-elite users.
		if ( 'elite' !== FrmAddonsController::license_type() ) {
			$special_categories['available-templates'] = array(
				'name'  => __( 'Available Templates', 'formidable' ),
				// Assigned via JavaScript.
				'count' => 0,
			);
		}

$special_categories['all-items'] = array(
			'name'  => __( 'All Templates', 'formidable' ),
			'count' => self::get_template_count(),
		);

self::$categories = array_merge(
			$special_categories,
			self::$categories
		);
	}

/**
	 * Assign featured templates.
	 *
	 * Iterates through FEATURED_TEMPLATES_IDS and adds matching templates to
	 * the `featured_templates` class property.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	private static function assign_featured_templates() {
		foreach ( self::FEATURED_TEMPLATES_IDS as $key ) {
			if ( isset( self::$templates[ $key ] ) ) {
				self::$templates[ $key ]['is_featured'] = true;
				self::$featured_templates[]             = self::$templates[ $key ];
			}
		}
	}

/**
	 * Get the total count of favorite templates.
	 *
	 * @since 6.7
	 *
	 * @return int
	 */
	public static function get_favorite_templates_count() {
		$custom_count  = count( self::$favorite_templates['custom'] );
		$default_count = count( self::$favorite_templates['default'] );

return $custom_count + $default_count;
	}

/**
	 * Initializes essential resources.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	private static function init_template_resources() {
		self::$view_path = FrmAppHelper::plugin_path() . '/classes/views/form-templates/';

self::$upgrade_link = FrmAppHelper::admin_upgrade_link(
			array(
				'medium'  => 'form-templates',
				'content' => 'upgrade',
			)
		);

self::$renew_link = FrmAppHelper::admin_upgrade_link(
			array(
				'medium'  => 'form-templates',
				'content' => 'renew',
			)
		);
	}

/**
	 * Adds a Cancel button to the header of the Form Templates page.
	 *
	 * It's hidden by default and will show when the user clicks on 'Create Form' from
	 * another place in Formidable Forms.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function get_header_cancel_button() {
		echo '
		<a class="button frm-button-secondary frm_hidden" href="' . esc_url( admin_url( 'admin.php?page=formidable' ) ) . '" role="button">
			' . esc_html__( 'Cancel', 'formidable' ) . '
		</a>';
	}

/**
	 * Append 'new_template' query parameter to navigation links if it exists in the URL.
	 *
	 * @since 6.7
	 *
	 * @param array $nav_items Navigation items.
	 * @param array $nav_args Additional navigation arguments.
	 *
	 * @return array Modified navigation items with 'new_template' query parameter.
	 */
	public static function append_new_template_to_nav( $nav_items, $nav_args ) {
		$is_new_template = FrmAppHelper::simple_get( 'new_template' );

// Append 'new_template=true' to each nav item's link if 'new_template' exists in the URL.
		if ( $is_new_template ) {
			foreach ( $nav_items as &$item ) {
				$item['link'] .= '&new_template=true';
			}
		}

return $nav_items;
	}

/**
	 * Enqueues "Form Templates" scripts and styles.
	 *
	 * @since 6.7
	 *
	 * @return void
	 */
	public static function enqueue_assets() {
		$plugin_url      = FrmAppHelper::plugin_url();
		$version         = FrmAppHelper::plugin_version();
		$js_dependencies = array(
			'wp-i18n',
			// This prevents a console error "wp.hooks is undefined" in WP versions older than 5.7.
			'wp-hooks',
			'formidable_dom',
		);

// Enqueue styles that needed.
		wp_enqueue_style( 'formidable-admin' );
		wp_enqueue_style( 'formidable-animations' );
		wp_enqueue_style( 'formidable-grids' );

// Register and enqueue "Form Templates" style.
		wp_register_style( self::SCRIPT_HANDLE, $plugin_url . '/css/admin/form-templates.css', array(), $version );
		wp_enqueue_style( self::SCRIPT_HANDLE );

// Register and enqueue "Form Templates" script.
		wp_register_script( self::SCRIPT_HANDLE, $plugin_url . '/js/form-templates.js', $js_dependencies, $version, true );
		wp_localize_script( self::SCRIPT_HANDLE, 'frmFormTemplatesVars', self::get_js_variables() );
		wp_enqueue_script( self::SCRIPT_HANDLE );

/**
		 * Fires after "Form Templates" enqueue assets.
		 *
		 * @since 6.7
		 */
		do_action( 'frm_form_templates_enqueue_assets' );

FrmAppHelper::dequeue_extra_global_scripts();
	}

/**
	 * Get "Form Templates" JS variables as an array.
	 *
	 * @since 6.7
	 *
	 * @return array
	 */
	private static function get_js_variables() {
		$js_variables = array(
			'FEATURED_TEMPLATES_IDS' => self::FEATURED_TEMPLATES_IDS,
			'FREE_TEMPLATES_IDS'     => self::FREE_TEMPLATES_IDS,
			'templatesCount'         => self::get_template_count(),
			'favoritesCount'         => array(
				'total'   => self::get_favorite_templates_count(),
				'default' => count( self::$favorite_templates['default'] ),
				'custom'  => count( self::$favorite_templates['custom'] ),
			),
			'customCount'            => count( self::$custom_templates ),
			'upgradeLink'            => self::$upgrade_link,
		);

/**
		 * Filters `js_variables` passed to the "Form Templates".
		 *
		 * @since 6.7
		 *
		 * @param array $js_variables Array of js_variables passed to "Form Templates".
		 */
		return apply_filters( 'frm_form_templates_js_variables', $js_variables );
	}

/**
	 * Check if the current page is the form templates page.
	 *
	 * @since 6.7
	 *
	 * @return bool True if the current page is the form templates page, false otherwise.
	 */
	public static function is_templates_page() {
		return FrmAppHelper::is_admin_page( self::PAGE_SLUG );
	}

/**
	 * Get the list of templates.
	 *
	 * @since 6.7
	 *
	 * @return array A list of templates.
	 */
	public static function get_templates() {
		return self::$templates;
	}

/**
	 * Get the total number of templates.
	 *
	 * @since 6.8
	 *
	 * @return int
	 */
	public static function get_template_count() {
		if ( empty( self::$templates ) ) {
			self::$form_template_api = new FrmFormTemplateApi();
			self::retrieve_and_set_templates();
		}
		return count( self::$templates );
	}

/**
	 * Get the published forms based on applied filters.
	 *
	 * @since 6.7
	 *
	 * @return array An array of published forms.
	 */
	public static function get_published_forms() {
		$where = apply_filters( 'frm_forms_dropdown', array(), '' );
		return FrmForm::get_published_forms( $where );
	}

/**
	 * Get the list of featured templates.
	 *
	 * @since 6.7
	 *
	 * @return array A list of featured templates.
	 */
	public static function get_featured_templates() {
		return self::$featured_templates;
	}

/**
	 * Get the list of categories.
	 *
	 * @since 6.7
	 *
	 * @return array A list of categories.
	 */
	public static function get_categories() {
		return self::$categories;
	}

/**
	 * Get the user's favorite form templates.
	 *
	 * @since 6.7
	 *
	 * @return array The IDs of the user's favorite form templates.
	 */
	public static function get_favorite_templates() {
		return self::$favorite_templates;
	}

/**
	 * Get the list of custom templates.
	 *
	 * @since 6.7
	 *
	 * @return array A list of custom templates.
	 */
	public static function get_custom_templates() {
		return self::$custom_templates;
	}

/**
	 * Get the license type.
	 *
	 * @since 6.7
	 *
	 * @return string The license type.
	 */
	public static function get_license_type() {
		return self::$license_type;
	}

/**
	 * Checks if the API request was expired.
	 *
	 * @since 6.7
	 *
	 * @return bool True if the API request was expired, false otherwise.
	 */
	public static function is_expired() {
		return self::$is_expired;
	}

/**
	 * Get the path to form templates views.
	 *
	 * @since 6.7
	 *
	 * @return string Path to views.
	 */
	public static function get_view_path() {
		return self::$view_path;
	}

/**
	 * Get the upgrade link.
	 *
	 * @since 6.7
	 *
	 * @return string URL for upgrading accounts.
	 */
	public static function get_upgrade_link() {
		return self::$upgrade_link;
	}

/**
	 * Get the renewal link.
	 *
	 * @since 6.7
	 *
	 * @return string URL for renewing accounts.
	 */
	public static function get_renew_link() {
		return self::$renew_link;
	}
}