eventespresso / event-espresso-core

caffeinated/admin/extend/messages/espresso_events_Messages_Hooks_Extend.class.php

Spacing +13 added lines, -13 removed lines

@@ -63,7 +63,7 @@ 
      */
     protected function _extend_properties()
     {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'messages/assets/');
         $this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
         $this->_metaboxes = [
             0 => [
@@ -78,11 +78,11 @@ 
         $this->_scripts_styles = [
             'registers' => [
                 'events_msg_admin'     => [
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+                    'url'     => EE_MSGS_EXTEND_ASSETS_URL.'events_messages_admin.js',
                     'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
                 ],
                 'events_msg_admin_css' => [
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+                    'url'  => EE_MSGS_EXTEND_ASSETS_URL.'ee_msg_events_admin.css',
                     'type' => 'css',
                 ],
             ],
@@ -154,18 +154,18 @@ 
                 ['action' => 'settings'],
                 EE_MSG_ADMIN_URL
             );
-            $error_msg        = sprintf(
+            $error_msg = sprintf(
                 esc_html__(
                     'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
                     'event_espresso'
                 ),
                 '<strong>',
                 '</strong>',
-                '<a href="' . $msg_activate_url . '">',
+                '<a href="'.$msg_activate_url.'">',
                 '</a>'
             );
-            $error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+            $error_content    = '<div class="error"><p>'.$error_msg.'</p></div>';
+            $internal_content = '<div id="messages-error"><p>'.$error_msg.'</p></div>';
 
             echo $error_content;
             echo $internal_content;
@@ -186,8 +186,8 @@ 
                 ['event' => $EVT_ID]
             );
 
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
+            if ( ! empty($tab_content)) {
+                $tabs[$name] = $tab_content;
             }
         }
 
@@ -201,7 +201,7 @@ 
         $notices = '
 	<div id="espresso-ajax-loading" class="ajax-loader-grey">
 		<span class="ee-spinner ee-spin"></span>
-		<span class="hidden">' . esc_html__('loading...', 'event_espresso') . '</span>
+		<span class="hidden">' . esc_html__('loading...', 'event_espresso').'</span>
 	</div>
 	<div class="ee-notices"></div>';
 
@@ -210,7 +210,7 @@ 
         }
 
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+        echo $notices.'<div class="messages-tabs-content">'.$tabbed_content.'</div>';
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
         return '';
     }
@@ -227,7 +227,7 @@ 
      */
     public function create_new_custom()
     {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
             wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
         }
 
@@ -270,7 +270,7 @@ 
     public function edit_admin_footer()
     {
         EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+            EE_CORE_CAF_ADMIN_EXTEND.'messages/templates/create_custom_template_form.template.php'
         );
     }
 

Indentation +284 added lines, -284 removed lines

@@ -15,294 +15,294 @@
 class espresso_events_Messages_Hooks_Extend extends espresso_events_Messages_Hooks
 {
 
-    /**
-     * @var Messages_Admin_Page
-     */
-    protected $_page_object;
-
-
-    /**
-     * espresso_events_Messages_Hooks_Extend constructor.
-     *
-     * @param EE_Admin_Page $admin_page
-     * @throws EE_Error
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        /**
-         * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
-         */
-        if (
-            ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_messages',
-                'messages_events_editor_metabox'
-            )
-        ) {
-            return;
-        }
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            [$this, 'caf_updates'],
-            10
-        );
-        add_action(
-            'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
-            [$this, 'duplicate_custom_message_settings'],
-            10,
-            2
-        );
-        parent::__construct($admin_page);
-    }
-
-
-    /**
-     * extending the properties set in espresso_events_Messages_Hooks
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_properties()
-    {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
-        $this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
-        $this->_metaboxes = [
-            0 => [
-                'page_route' => ['edit', 'create_new'],
-                'func'       => 'messages_metabox',
-                'label'      => esc_html__('Notifications', 'event_espresso'),
-                'priority'   => 'high',
-            ],
-        ];
-
-        // see explanation for layout in EE_Admin_Hooks
-        $this->_scripts_styles = [
-            'registers' => [
-                'events_msg_admin'     => [
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
-                    'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
-                ],
-                'events_msg_admin_css' => [
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
-                    'type' => 'css',
-                ],
-            ],
-            'enqueues'  => [
-                'events_msg_admin'     => ['edit', 'create_new'],
-                'events_msg_admin_css' => ['edit', 'create_new'],
-            ],
-        ];
-    }
-
-
-    public function caf_updates($update_callbacks)
-    {
-        $update_callbacks[] = [$this, 'attach_evt_message_templates'];
-        return $update_callbacks;
-    }
-
-
-    /**
-     * Handles attaching Message Templates to the Event on save.
-     *
-     * @param EE_Event $event EE event object
-     * @param array    $data  The request data from the form
-     * @return bool success or fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attach_evt_message_templates(EE_Event $event, array $data): bool
-    {
-        $success = true;
-        if (isset($data['event_message_templates_relation'])) {
-            // first get all existing relations on the Event for message types.
-            $existing_templates = EEM_Event_Message_Template::instance()->messageTemplateGroupIDsForEvent($event);
-            $current_templates  = $data['event_message_templates_relation'];
-            // new templates are those in the $current_templates array that don't exist in $existing_templates
-            $templates_to_add = array_diff($current_templates, $existing_templates);
-            foreach ($templates_to_add as $template_to_add) {
-                $added_template = $event->_add_relation_to($template_to_add, 'Message_Template_Group');
-                // toggle success to false if we don't get back a template group object
-                $success = $added_template instanceof EE_Message_Template_Group ? $success : false;
-            }
-            // templates to remove are those in the $existing_templates array that don't exist in $current_templates
-            $templates_to_remove = array_diff($existing_templates, $current_templates);
-            foreach ($templates_to_remove as $template_to_remove) {
-                $removed_template = $event->_remove_relation_to($template_to_remove, 'Message_Template_Group');
-                // toggle success to false if we don't get back a template group object
-                $success = $removed_template instanceof EE_Message_Template_Group ? $success : false;
-            }
-        }
-        return $success;
-    }
-
-
-    /**
-     * @param $event
-     * @param $callback_args
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function messages_metabox($event, $callback_args)
-    {
-        // convert 'evt_id' to 'EVT_ID'
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
-        $EVT_ID = $this->request->getRequestParam('evt_id', $EVT_ID, 'int');
-        $this->request->setRequestParam('EVT_ID', $EVT_ID);
-
-        // get the active messengers (b/c messenger objects have the active message templates)
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers        = $message_resource_manager->active_messengers();
-        $tabs                     = [];
-
-        // empty messengers?
-        // Note message types will always have at least one available because every messenger has a default message type
-        // associated with it (payment) if no other message types are selected.
-        if (empty($active_messengers)) {
-            $msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
-                ['action' => 'settings'],
-                EE_MSG_ADMIN_URL
-            );
-            $error_msg        = sprintf(
-                esc_html__(
-                    'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>',
-                '<a href="' . $msg_activate_url . '">',
-                '</a>'
-            );
-            $error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
-
-            echo $error_content;
-            echo $internal_content;
-            return '';
-        }
-
-        // get content for active messengers
-        foreach ($active_messengers as $name => $messenger) {
-            // first check if there are any active message types for this messenger.
-            $active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
-            if (empty($active_mts)) {
-                continue;
-            }
-
-            $tab_content = $messenger->get_messenger_admin_page_content(
-                'events',
-                'edit',
-                ['event' => $EVT_ID]
-            );
-
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
-            }
-        }
-
-
-        // we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
-        $tabbed_content = EEH_Tabbed_Content::display($tabs);
-        if ($tabbed_content instanceof WP_Error) {
-            $tabbed_content = $tabbed_content->get_error_message();
-        }
-
-        $notices = '
+	/**
+	 * @var Messages_Admin_Page
+	 */
+	protected $_page_object;
+
+
+	/**
+	 * espresso_events_Messages_Hooks_Extend constructor.
+	 *
+	 * @param EE_Admin_Page $admin_page
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		/**
+		 * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
+		 */
+		if (
+			! EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_messages',
+				'messages_events_editor_metabox'
+			)
+		) {
+			return;
+		}
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			[$this, 'caf_updates'],
+			10
+		);
+		add_action(
+			'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
+			[$this, 'duplicate_custom_message_settings'],
+			10,
+			2
+		);
+		parent::__construct($admin_page);
+	}
+
+
+	/**
+	 * extending the properties set in espresso_events_Messages_Hooks
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_properties()
+	{
+		define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+		$this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
+		$this->_metaboxes = [
+			0 => [
+				'page_route' => ['edit', 'create_new'],
+				'func'       => 'messages_metabox',
+				'label'      => esc_html__('Notifications', 'event_espresso'),
+				'priority'   => 'high',
+			],
+		];
+
+		// see explanation for layout in EE_Admin_Hooks
+		$this->_scripts_styles = [
+			'registers' => [
+				'events_msg_admin'     => [
+					'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+					'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
+				],
+				'events_msg_admin_css' => [
+					'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+					'type' => 'css',
+				],
+			],
+			'enqueues'  => [
+				'events_msg_admin'     => ['edit', 'create_new'],
+				'events_msg_admin_css' => ['edit', 'create_new'],
+			],
+		];
+	}
+
+
+	public function caf_updates($update_callbacks)
+	{
+		$update_callbacks[] = [$this, 'attach_evt_message_templates'];
+		return $update_callbacks;
+	}
+
+
+	/**
+	 * Handles attaching Message Templates to the Event on save.
+	 *
+	 * @param EE_Event $event EE event object
+	 * @param array    $data  The request data from the form
+	 * @return bool success or fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attach_evt_message_templates(EE_Event $event, array $data): bool
+	{
+		$success = true;
+		if (isset($data['event_message_templates_relation'])) {
+			// first get all existing relations on the Event for message types.
+			$existing_templates = EEM_Event_Message_Template::instance()->messageTemplateGroupIDsForEvent($event);
+			$current_templates  = $data['event_message_templates_relation'];
+			// new templates are those in the $current_templates array that don't exist in $existing_templates
+			$templates_to_add = array_diff($current_templates, $existing_templates);
+			foreach ($templates_to_add as $template_to_add) {
+				$added_template = $event->_add_relation_to($template_to_add, 'Message_Template_Group');
+				// toggle success to false if we don't get back a template group object
+				$success = $added_template instanceof EE_Message_Template_Group ? $success : false;
+			}
+			// templates to remove are those in the $existing_templates array that don't exist in $current_templates
+			$templates_to_remove = array_diff($existing_templates, $current_templates);
+			foreach ($templates_to_remove as $template_to_remove) {
+				$removed_template = $event->_remove_relation_to($template_to_remove, 'Message_Template_Group');
+				// toggle success to false if we don't get back a template group object
+				$success = $removed_template instanceof EE_Message_Template_Group ? $success : false;
+			}
+		}
+		return $success;
+	}
+
+
+	/**
+	 * @param $event
+	 * @param $callback_args
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function messages_metabox($event, $callback_args)
+	{
+		// convert 'evt_id' to 'EVT_ID'
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
+		$EVT_ID = $this->request->getRequestParam('evt_id', $EVT_ID, 'int');
+		$this->request->setRequestParam('EVT_ID', $EVT_ID);
+
+		// get the active messengers (b/c messenger objects have the active message templates)
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers        = $message_resource_manager->active_messengers();
+		$tabs                     = [];
+
+		// empty messengers?
+		// Note message types will always have at least one available because every messenger has a default message type
+		// associated with it (payment) if no other message types are selected.
+		if (empty($active_messengers)) {
+			$msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
+				['action' => 'settings'],
+				EE_MSG_ADMIN_URL
+			);
+			$error_msg        = sprintf(
+				esc_html__(
+					'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>',
+				'<a href="' . $msg_activate_url . '">',
+				'</a>'
+			);
+			$error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
+			$internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+
+			echo $error_content;
+			echo $internal_content;
+			return '';
+		}
+
+		// get content for active messengers
+		foreach ($active_messengers as $name => $messenger) {
+			// first check if there are any active message types for this messenger.
+			$active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
+			if (empty($active_mts)) {
+				continue;
+			}
+
+			$tab_content = $messenger->get_messenger_admin_page_content(
+				'events',
+				'edit',
+				['event' => $EVT_ID]
+			);
+
+			if (! empty($tab_content)) {
+				$tabs[ $name ] = $tab_content;
+			}
+		}
+
+
+		// we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
+		$tabbed_content = EEH_Tabbed_Content::display($tabs);
+		if ($tabbed_content instanceof WP_Error) {
+			$tabbed_content = $tabbed_content->get_error_message();
+		}
+
+		$notices = '
 	<div id="espresso-ajax-loading" class="ajax-loader-grey">
 		<span class="ee-spinner ee-spin"></span>
 		<span class="hidden">' . esc_html__('loading...', 'event_espresso') . '</span>
 	</div>
 	<div class="ee-notices"></div>';
 
-        if (defined('DOING_AJAX')) {
-            return $tabbed_content;
-        }
-
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
-        return '';
-    }
-
-
-    /**
-     * Ajax callback for ee_msgs_create_new_custom ajax request.
-     * Takes incoming GRP_ID and name and description values from ajax request
-     * to create a new custom template based off of the incoming GRP_ID.
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_new_custom()
-    {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
-            wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
-        }
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-
-        // let's clean up the request data a bit for downstream usage of name and description.
-        $templateName = $this->request->getRequestParam('custom_template_args[MTP_name]', '');
-        $request->setRequestParam('templateName', $templateName);
-        $templateDescription = $this->request->getRequestParam('custom_template_args[MTP_description]', '');
-        $request->setRequestParam('templateDescription', $templateDescription);
-
-        // set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
-        $this->_set_page_object();
-
-        // is this a template switch if so EE_Admin_Page child needs this object
-        $this->_page_object->set_hook_object($this);
-
-        $this->_page_object->add_message_template(
-            $this->request->getRequestParam('messageType', ''),
-            $this->request->getRequestParam('messenger', ''),
-            $this->request->getRequestParam('group_ID', 0, 'int')
-        );
-    }
-
-
-    public function create_new_admin_footer()
-    {
-        $this->edit_admin_footer();
-    }
-
-
-    /**
-     * This is the dynamic method for this class
-     * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function edit_admin_footer()
-    {
-        EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
-        );
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
-     * the assigned custom message templates.
-     *
-     * @param EE_Event $new_event
-     * @param EE_Event $original_event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
-    {
-        $message_template_groups = $original_event->get_many_related('Message_Template_Group');
-        foreach ($message_template_groups as $message_template_group) {
-            $new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
-        }
-        // save new event
-        $new_event->save();
-    }
+		if (defined('DOING_AJAX')) {
+			return $tabbed_content;
+		}
+
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
+		echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
+		return '';
+	}
+
+
+	/**
+	 * Ajax callback for ee_msgs_create_new_custom ajax request.
+	 * Takes incoming GRP_ID and name and description values from ajax request
+	 * to create a new custom template based off of the incoming GRP_ID.
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_new_custom()
+	{
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+			wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
+		}
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+
+		// let's clean up the request data a bit for downstream usage of name and description.
+		$templateName = $this->request->getRequestParam('custom_template_args[MTP_name]', '');
+		$request->setRequestParam('templateName', $templateName);
+		$templateDescription = $this->request->getRequestParam('custom_template_args[MTP_description]', '');
+		$request->setRequestParam('templateDescription', $templateDescription);
+
+		// set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
+		$this->_set_page_object();
+
+		// is this a template switch if so EE_Admin_Page child needs this object
+		$this->_page_object->set_hook_object($this);
+
+		$this->_page_object->add_message_template(
+			$this->request->getRequestParam('messageType', ''),
+			$this->request->getRequestParam('messenger', ''),
+			$this->request->getRequestParam('group_ID', 0, 'int')
+		);
+	}
+
+
+	public function create_new_admin_footer()
+	{
+		$this->edit_admin_footer();
+	}
+
+
+	/**
+	 * This is the dynamic method for this class
+	 * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function edit_admin_footer()
+	{
+		EEH_Template::display_template(
+			EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+		);
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
+	 * the assigned custom message templates.
+	 *
+	 * @param EE_Event $new_event
+	 * @param EE_Event $original_event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
+	{
+		$message_template_groups = $original_event->get_many_related('Message_Template_Group');
+		foreach ($message_template_groups as $message_template_group) {
+			$new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
+		}
+		// save new event
+		$new_event->save();
+	}
 }

core/services/request/sanitizers/RequestSanitizer.php

Indentation +61 added lines, -61 removed lines

@@ -6,67 +6,67 @@
 
 class RequestSanitizer
 {
-    /**
-     * Will sanitize the supplied request parameter based on the specified data type
-     *
-     * @param mixed  $param     the supplied request parameter
-     * @param string $type      the specified data type (default: "string")
-     *                          valid values: "bool", "float", "int", "key", "url", or "string"
-     * @param bool   $is_array  if true, then $param will be treated as an array of $type
-     * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
-     * @return array|bool|float|int|string
-     * @since 4.10.14.p
-     */
-    public function clean($param, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        if ($delimiter !== '' && is_string($param)) {
-            $param = explode($delimiter, $param);
-            $is_array = is_array($param);
-            // unset the delimiter else this function will recurse forever when we loop over the array of results
-            $delimiter = '';
-        }
-        // check if we are getting an improperly typed array and correct
-        $is_array = $is_array && is_array($param);
-        if ($is_array) {
-            $values = [];
-            foreach ((array) $param as $key => $value) {
-                $values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
-            }
-            return $values;
-        }
-        return $this->sanitizeParam($param, $type);
-    }
+	/**
+	 * Will sanitize the supplied request parameter based on the specified data type
+	 *
+	 * @param mixed  $param     the supplied request parameter
+	 * @param string $type      the specified data type (default: "string")
+	 *                          valid values: "bool", "float", "int", "key", "url", or "string"
+	 * @param bool   $is_array  if true, then $param will be treated as an array of $type
+	 * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
+	 * @return array|bool|float|int|string
+	 * @since 4.10.14.p
+	 */
+	public function clean($param, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		if ($delimiter !== '' && is_string($param)) {
+			$param = explode($delimiter, $param);
+			$is_array = is_array($param);
+			// unset the delimiter else this function will recurse forever when we loop over the array of results
+			$delimiter = '';
+		}
+		// check if we are getting an improperly typed array and correct
+		$is_array = $is_array && is_array($param);
+		if ($is_array) {
+			$values = [];
+			foreach ((array) $param as $key => $value) {
+				$values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
+			}
+			return $values;
+		}
+		return $this->sanitizeParam($param, $type);
+	}
 
 
-    /**
-     * @param mixed  $param
-     * @param string $type
-     * @return array|float|int|mixed|string|string[]|null
-     * @since   4.10.20.p
-     */
-    public function sanitizeParam($param, $type = DataType::STRING)
-    {
-        switch ($type) {
-            case DataType::BOOL:
-                return filter_var($param, FILTER_VALIDATE_BOOLEAN);
-            case DataType::FLOAT:
-                return (float) $param;
-            case DataType::FQCN:
-                return preg_replace('[^\\\w\d]', '', $param);
-            case DataType::HTML:
-                $allowed_tags = AllowedTags::getAllowedTags();
-                return wp_kses($param, $allowed_tags);
-            case DataType::INT:
-                return (int) $param;
-            case DataType::KEY:
-                return sanitize_key($param);
-            case DataType::TITLE:
-                return sanitize_title($param);
-            case DataType::URL:
-                return esc_url_raw($param);
-            case DataType::STRING:
-            default:
-                return sanitize_text_field($param);
-        }
-    }
+	/**
+	 * @param mixed  $param
+	 * @param string $type
+	 * @return array|float|int|mixed|string|string[]|null
+	 * @since   4.10.20.p
+	 */
+	public function sanitizeParam($param, $type = DataType::STRING)
+	{
+		switch ($type) {
+			case DataType::BOOL:
+				return filter_var($param, FILTER_VALIDATE_BOOLEAN);
+			case DataType::FLOAT:
+				return (float) $param;
+			case DataType::FQCN:
+				return preg_replace('[^\\\w\d]', '', $param);
+			case DataType::HTML:
+				$allowed_tags = AllowedTags::getAllowedTags();
+				return wp_kses($param, $allowed_tags);
+			case DataType::INT:
+				return (int) $param;
+			case DataType::KEY:
+				return sanitize_key($param);
+			case DataType::TITLE:
+				return sanitize_title($param);
+			case DataType::URL:
+				return esc_url_raw($param);
+			case DataType::STRING:
+			default:
+				return sanitize_text_field($param);
+		}
+	}
 }

core/services/request/sanitizers/AllowedTags.php

Indentation +91 added lines, -91 removed lines

@@ -13,102 +13,102 @@
 class AllowedTags
 {
 
-    /**
-     * @var array[]
-     */
-    private static $attributes = [
-        'action'     => [],
-        'align'      => [],
-        'alt'        => [],
-        'class'      => [],
-        'data'       => [],
-        'for'        => [],
-        'height'     => [],
-        'href'       => [],
-        'id'         => [],
-        'method'     => [],
-        'name'       => [],
-        'novalidate' => [],
-        'rel'        => [],
-        'src'        => [],
-        'style'      => [],
-        'tabindex'   => [],
-        'target'     => [],
-        'title'      => [],
-        'type'       => [],
-        'value'      => [],
-        'width'      => [],
-    ];
+	/**
+	 * @var array[]
+	 */
+	private static $attributes = [
+		'action'     => [],
+		'align'      => [],
+		'alt'        => [],
+		'class'      => [],
+		'data'       => [],
+		'for'        => [],
+		'height'     => [],
+		'href'       => [],
+		'id'         => [],
+		'method'     => [],
+		'name'       => [],
+		'novalidate' => [],
+		'rel'        => [],
+		'src'        => [],
+		'style'      => [],
+		'tabindex'   => [],
+		'target'     => [],
+		'title'      => [],
+		'type'       => [],
+		'value'      => [],
+		'width'      => [],
+	];
 
 
-    /**
-     * @var array
-     */
-    private static $tags = [
-        'a',
-        'abbr',
-        'b',
-        'br',
-        'code',
-        'div',
-        'em',
-        'form',
-        'h1',
-        'h2',
-        'h3',
-        'h4',
-        'h5',
-        'h6',
-        'hr',
-        'i',
-        'iframe',
-        'img',
-        'input',
-        'label',
-        'li',
-        'ol',
-        'p',
-        'pre',
-        'script',
-        'small',
-        'span',
-        'strong',
-        'style',
-        'table',
-        'td',
-        'textarea',
-        'tr',
-        'ul',
-    ];
+	/**
+	 * @var array
+	 */
+	private static $tags = [
+		'a',
+		'abbr',
+		'b',
+		'br',
+		'code',
+		'div',
+		'em',
+		'form',
+		'h1',
+		'h2',
+		'h3',
+		'h4',
+		'h5',
+		'h6',
+		'hr',
+		'i',
+		'iframe',
+		'img',
+		'input',
+		'label',
+		'li',
+		'ol',
+		'p',
+		'pre',
+		'script',
+		'small',
+		'span',
+		'strong',
+		'style',
+		'table',
+		'td',
+		'textarea',
+		'tr',
+		'ul',
+	];
 
-    /**
-     * @var array
-     */
-    private static $allowed_tags;
+	/**
+	 * @var array
+	 */
+	private static $allowed_tags;
 
 
-    /**
-     * merges additional tags and attributes into the WP global $allowedposttags
-     */
-    private static function initializeAllowedTags()
-    {
-        global $allowedposttags;
-        $allowed_tags = [];
-        foreach (AllowedTags::$tags as $tag) {
-            $allowed_tags[ $tag ] = AllowedTags::$attributes;
-        }
-        AllowedTags::$allowed_tags = array_merge_recursive($allowedposttags, $allowed_tags);
-    }
+	/**
+	 * merges additional tags and attributes into the WP global $allowedposttags
+	 */
+	private static function initializeAllowedTags()
+	{
+		global $allowedposttags;
+		$allowed_tags = [];
+		foreach (AllowedTags::$tags as $tag) {
+			$allowed_tags[ $tag ] = AllowedTags::$attributes;
+		}
+		AllowedTags::$allowed_tags = array_merge_recursive($allowedposttags, $allowed_tags);
+	}
 
 
-    /**
-     * @return array[]
-     */
-    public static function getAllowedTags()
-    {
-        if (empty(AllowedTags::$allowed_tags)) {
-            AllowedTags::initializeAllowedTags();
-        }
-        return AllowedTags::$allowed_tags;
-    }
+	/**
+	 * @return array[]
+	 */
+	public static function getAllowedTags()
+	{
+		if (empty(AllowedTags::$allowed_tags)) {
+			AllowedTags::initializeAllowedTags();
+		}
+		return AllowedTags::$allowed_tags;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
         global $allowedposttags;
         $allowed_tags = [];
         foreach (AllowedTags::$tags as $tag) {
-            $allowed_tags[ $tag ] = AllowedTags::$attributes;
+            $allowed_tags[$tag] = AllowedTags::$attributes;
         }
         AllowedTags::$allowed_tags = array_merge_recursive($allowedposttags, $allowed_tags);
     }

core/services/request/DataType.php

Indentation +41 added lines, -41 removed lines

@@ -12,58 +12,58 @@
  */
 class DataType
 {
-    // can't use ARRAY as name until we switch to PHP 7+
-    // const ARRAY   = 'array';
+	// can't use ARRAY as name until we switch to PHP 7+
+	// const ARRAY   = 'array';
 
-    const BOOL    = 'bool';
-    const BOOLEAN = 'bool';
+	const BOOL    = 'bool';
+	const BOOLEAN = 'bool';
 
-    const DOUBLE  = 'float';
-    const FLOAT   = 'float';
+	const DOUBLE  = 'float';
+	const FLOAT   = 'float';
 
-    const FQCN    = 'fqcn';
+	const FQCN    = 'fqcn';
 
-    const HTML    = 'html';
+	const HTML    = 'html';
 
-    const INT     = 'int';
-    const INTEGER = 'int';
+	const INT     = 'int';
+	const INTEGER = 'int';
 
-    const KEY     = 'key';
+	const KEY     = 'key';
 
-    const OBJECT  = 'object';
+	const OBJECT  = 'object';
 
-    const NULL    = 'null';
+	const NULL    = 'null';
 
-    const TITLE   = 'title';
+	const TITLE   = 'title';
 
-    const URL     = 'url';
+	const URL     = 'url';
 
-    const STRING  = 'string';
+	const STRING  = 'string';
 
 
-    /**
-     * @param mixed  $param
-     * @param string $type
-     * @return mixed
-     */
-    public static function setDataType($param, $type)
-    {
-        switch ($type) {
-            case DataType::NULL:
-                return null;
-            case DataType::OBJECT:
-                return $param;
-            case DataType::FQCN:
-            case DataType::HTML:
-            case DataType::KEY:
-            case DataType::STRING:
-            case DataType::TITLE:
-            case DataType::URL:
-                settype($param, DataType::STRING);
-                break;
-            default:
-                settype($param, $type);
-        }
-        return $param;
-    }
+	/**
+	 * @param mixed  $param
+	 * @param string $type
+	 * @return mixed
+	 */
+	public static function setDataType($param, $type)
+	{
+		switch ($type) {
+			case DataType::NULL:
+				return null;
+			case DataType::OBJECT:
+				return $param;
+			case DataType::FQCN:
+			case DataType::HTML:
+			case DataType::KEY:
+			case DataType::STRING:
+			case DataType::TITLE:
+			case DataType::URL:
+				settype($param, DataType::STRING);
+				break;
+			default:
+				settype($param, $type);
+		}
+		return $param;
+	}
 }

core/services/request/RequestParams.php

Spacing +16 added lines, -16 removed lines

@@ -17,13 +17,13 @@ 
      * Used for matches() and parameterDrillDown()
      * 'bool' will return true or false if match is found or not
      */
-    const RETURN_BOOL  = 'bool';
+    const RETURN_BOOL = 'bool';
 
     /**
      * Used for matches() and parameterDrillDown()
      * 'key' will return the first key found that matches the supplied pattern
      */
-    const RETURN_KEY   = 'key';
+    const RETURN_KEY = 'key';
 
     /**
      * Used for matches() and parameterDrillDown()
@@ -113,7 +113,7 @@ 
     {
         // don't allow "ee" to be overwritten unless explicitly instructed to do so
         if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -237,7 +237,7 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === self::RETURN_VALUE) {
                     return $request_param;
@@ -299,30 +299,30 @@ 
                 $key      = $real_key ?: $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->parameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
                     $return,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default, $return);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -336,12 +336,12 @@ 
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
         // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+        $this->get[$key]     = null;
+        $this->post[$key]    = null;
+        $this->request[$key] = null;
+        unset($this->get[$key], $this->post[$key], $this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+            unset($_GET[$key], $_POST[$key], $_REQUEST[$key]);
         }
     }
 

Indentation +345 added lines, -345 removed lines

@@ -13,349 +13,349 @@
  */
 class RequestParams
 {
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'bool' will return true or false if match is found or not
-     */
-    const RETURN_BOOL  = 'bool';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'key' will return the first key found that matches the supplied pattern
-     */
-    const RETURN_KEY   = 'key';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'value' will return the value for the first request parameter
-     */
-    const RETURN_VALUE = 'value';
-
-    /**
-     * $_GET parameters
-     *
-     * @var array
-     */
-    protected $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array
-     */
-    protected $post;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array
-     */
-    protected $request;
-
-    /**
-     * @var RequestSanitizer
-     */
-    protected $sanitizer;
-
-
-    /**
-     * RequestParams constructor.
-     *
-     * @param RequestSanitizer $sanitizer
-     * @param array            $get
-     * @param array            $post
-     */
-    public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
-    {
-        $this->sanitizer = $sanitizer;
-        $this->get       = ! empty($get) ? $get : $_GET;
-        $this->post      = ! empty($post) ? $post : $_POST;
-        $this->request   = array_merge($this->get, $this->post);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request = array_merge($this->request, $request_params);
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($key, $default, 'get'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        $type = $is_array ? 'array' : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return (bool) $this->parameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($pattern, $default, 'match'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        $type = $is_array ? 'array' : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are the RETURN_* constants:
-     *                                      RETURN_BOOL will return true or false if match is found or not
-     *                                      RETURN_KEY will return the first key found that matches the supplied pattern
-     *                                      RETURN_VALUE will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
-    {
-        $return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            ['\*', '\?'],
-            ['.*', '.'],
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === self::RETURN_VALUE) {
-                    return $request_param;
-                }
-                // or actual key or true just to indicate it was found
-                return $return === self::RETURN_KEY ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === self::RETURN_VALUE ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param string $return
-     * @param mixed  $request_params
-     * @return bool|mixed|null
-     */
-    private function parameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        $return = self::RETURN_VALUE,
-        $request_params = []
-    ) {
-        $callback       = in_array($callback, ['is_set', 'get', 'match'], true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
-                $key      = $real_key ?: $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->parameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $return,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default, $return);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        foreach ($keys as $key) {
-            $this->unSetRequestParam($key, $unset_from_global_too);
-        }
-    }
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'bool' will return true or false if match is found or not
+	 */
+	const RETURN_BOOL  = 'bool';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'key' will return the first key found that matches the supplied pattern
+	 */
+	const RETURN_KEY   = 'key';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'value' will return the value for the first request parameter
+	 */
+	const RETURN_VALUE = 'value';
+
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array
+	 */
+	protected $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array
+	 */
+	protected $post;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array
+	 */
+	protected $request;
+
+	/**
+	 * @var RequestSanitizer
+	 */
+	protected $sanitizer;
+
+
+	/**
+	 * RequestParams constructor.
+	 *
+	 * @param RequestSanitizer $sanitizer
+	 * @param array            $get
+	 * @param array            $post
+	 */
+	public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
+	{
+		$this->sanitizer = $sanitizer;
+		$this->get       = ! empty($get) ? $get : $_GET;
+		$this->post      = ! empty($post) ? $post : $_POST;
+		$this->request   = array_merge($this->get, $this->post);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request = array_merge($this->request, $request_params);
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($key, $default, 'get'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		$type = $is_array ? 'array' : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return (bool) $this->parameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($pattern, $default, 'match'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		$type = $is_array ? 'array' : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are the RETURN_* constants:
+	 *                                      RETURN_BOOL will return true or false if match is found or not
+	 *                                      RETURN_KEY will return the first key found that matches the supplied pattern
+	 *                                      RETURN_VALUE will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
+	{
+		$return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			['\*', '\?'],
+			['.*', '.'],
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === self::RETURN_VALUE) {
+					return $request_param;
+				}
+				// or actual key or true just to indicate it was found
+				return $return === self::RETURN_KEY ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === self::RETURN_VALUE ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param string $return
+	 * @param mixed  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function parameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		$return = self::RETURN_VALUE,
+		$request_params = []
+	) {
+		$callback       = in_array($callback, ['is_set', 'get', 'match'], true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
+				$key      = $real_key ?: $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->parameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$return,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default, $return);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->get[ $key ]     = null;
+		$this->post[ $key ]    = null;
+		$this->request[ $key ] = null;
+		unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		foreach ($keys as $key) {
+			$this->unSetRequestParam($key, $unset_from_global_too);
+		}
+	}
 }

core/helpers/EEH_Array.helper.php

Spacing +5 added lines, -5 removed lines

@@ -82,7 +82,7 @@ 
      */
     public static function is_set($arr, $index, $default)
     {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+        return isset($arr[$index]) ? $arr[$index] : $default;
     }
 
     /**
@@ -170,7 +170,7 @@ 
     public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
     {
         foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
+            $array1[$key] = $value;
         }
         return $array1;
     }
@@ -192,8 +192,8 @@ 
         $multidimensional = array();
         $reference = &$multidimensional;
         foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
+            $reference[$key] = array();
+            $reference = &$reference[$key];
         }
         if ($final_value !== null) {
             $reference = $final_value;
@@ -224,7 +224,7 @@ 
     {
         if (is_array($element)) {
             foreach ($element as $key => $value) {
-                $element[ $key ] = EEH_Array::addSlashesRecursively($value);
+                $element[$key] = EEH_Array::addSlashesRecursively($value);
             }
             return $element;
         }

Indentation +217 added lines, -217 removed lines

@@ -13,221 +13,221 @@
 {
 
 
-    /**
-     * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
-     * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
-     *
-     * @uses array_udiff core php function for setting up our own array comparison
-     * @uses self::_compare_objects as the custom method for array_udiff
-     * @param  array $array1 an array of objects
-     * @param  array $array2 an array of objects
-     * @return array         an array of objects found in array 1 that aren't found in array 2.
-     */
-    public static function object_array_diff($array1, $array2)
-    {
-        return array_udiff($array1, $array2, array('self', '_compare_objects'));
-    }
-
-    /**
-     * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
-     *
-     * @param array $array
-     * @return boolean
-     */
-    public static function is_associative_array(array $array): bool
-    {
-        return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
-    }
-
-    /**
-     * Gets an item from the array and leave the array intact. Use in place of end()
-     * when you don't want to change the array
-     *
-     * @param array $arr
-     * @return mixed what ever is in the array
-     */
-    public static function get_one_item_from_array($arr)
-    {
-        $item = end($arr);
-        reset($arr);
-        return $item;
-    }
-
-    /**
-     * Detects if this is a multi-dimensional array
-     * meaning that at least one top-level value is an array. Eg [ [], ...]
-     *
-     * @param mixed $arr
-     * @return boolean
-     */
-    public static function is_multi_dimensional_array($arr)
-    {
-        if (is_array($arr)) {
-            foreach ($arr as $item) {
-                if (is_array($item)) {
-                    return true; // yep, there's at least 2 levels to this array
-                }
-            }
-        }
-        return false; // there's only 1 level, or it's not an array at all!
-    }
-
-    /**
-     * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
-     *
-     * @param array $arr
-     * @param mixed $index
-     * @param mixed $default
-     * @return mixed
-     */
-    public static function is_set($arr, $index, $default)
-    {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
-    }
-
-    /**
-     * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
-     *
-     * @param mixed $value usually a string, but could be an array or object
-     * @return mixed the UN-serialized data
-     */
-    public static function maybe_unserialize($value)
-    {
-        $data = maybe_unserialize($value);
-        // it's possible that this still has serialized data if it's the session.
-        //  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesn't unserialize this automatically.
-        $token = 'C';
-        $data = is_string($data) ? trim($data) : $data;
-        if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
-            return unserialize($data);
-        } else {
-            return $data;
-        }
-    }
-
-
-    /**
-     * insert_into_array
-     *
-     * @param array        $target_array the array to insert new data into
-     * @param array        $array_to_insert the new data to be inserted
-     * @param int | string $offset a known key within $target_array where new data will be inserted
-     * @param bool         $add_before whether to add new data before or after the offset key
-     * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
-     * @return array
-     */
-    public static function insert_into_array(
-        $target_array = array(),
-        $array_to_insert = array(),
-        $offset = null,
-        $add_before = true,
-        $preserve_keys = true
-    ) {
-        // ensure incoming arrays are actually arrays
-        $target_array = (array) $target_array;
-        $array_to_insert = (array) $array_to_insert;
-        // if no offset key was supplied
-        if (empty($offset)) {
-            // use start or end of $target_array based on whether we are adding before or not
-            $offset = $add_before ? 0 : count($target_array);
-        }
-        // if offset key is a string, then find the corresponding numeric location for that element
-        $offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
-        // add one to the offset if adding after
-        $offset = $add_before ? $offset : $offset + 1;
-        // but ensure offset does not exceed the length of the array
-        $offset = $offset > count($target_array) ? count($target_array) : $offset;
-        // reindex array ???
-        if ($preserve_keys) {
-            // take a slice of the target array from the beginning till the offset,
-            // then add the new data
-            // then add another slice that starts at the offset and goes till the end
-            return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
-                $target_array,
-                $offset,
-                null,
-                true
-            );
-        } else {
-            // since we don't want to preserve keys, we can use array_splice
-            array_splice($target_array, $offset, 0, $array_to_insert);
-            return $target_array;
-        }
-    }
-
-
-    /**
-     * array_merge() is slow and should never be used while looping over data
-     * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
-     * so really this acts more like array_replace( $array1, $array2 )
-     * or a union with the arrays flipped ( $array2 + $array1 )
-     * this saves a few lines of code and improves readability
-     *
-     * @param array $array1
-     * @param array $array2
-     * @return array
-     */
-    public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
-    {
-        foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
-        }
-        return $array1;
-    }
-
-
-    /**
-     * given a flat array like $array = array('A', 'B', 'C')
-     * will convert into a multidimensional array like $array[A][B][C]
-     * if $final_value is provided and is anything other than null,
-     * then that will be set as the value for the innermost array key
-     * like so: $array[A][B][C] = $final_value
-     *
-     * @param array $flat_array
-     * @param mixed $final_value
-     * @return array
-     */
-    public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
-    {
-        $multidimensional = array();
-        $reference = &$multidimensional;
-        foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
-        }
-        if ($final_value !== null) {
-            $reference = $final_value;
-        }
-        return $multidimensional;
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    public static function is_array_numerically_and_sequentially_indexed(array $array)
-    {
-        return empty($array) || array_keys($array) === range(0, count($array) - 1);
-    }
-
-
-    /**
-     * recursively walks through an array and adds slashes to all no array elements
-     *
-     * @param mixed $element
-     * @return array|string
-     * @since   $VID:$
-     */
-    public static function addSlashesRecursively($element)
-    {
-        if (is_array($element)) {
-            foreach ($element as $key => $value) {
-                $element[ $key ] = EEH_Array::addSlashesRecursively($value);
-            }
-            return $element;
-        }
-        return is_string($element) ? addslashes($element) : $element;
-    }
+	/**
+	 * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
+	 * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
+	 *
+	 * @uses array_udiff core php function for setting up our own array comparison
+	 * @uses self::_compare_objects as the custom method for array_udiff
+	 * @param  array $array1 an array of objects
+	 * @param  array $array2 an array of objects
+	 * @return array         an array of objects found in array 1 that aren't found in array 2.
+	 */
+	public static function object_array_diff($array1, $array2)
+	{
+		return array_udiff($array1, $array2, array('self', '_compare_objects'));
+	}
+
+	/**
+	 * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
+	 *
+	 * @param array $array
+	 * @return boolean
+	 */
+	public static function is_associative_array(array $array): bool
+	{
+		return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
+	}
+
+	/**
+	 * Gets an item from the array and leave the array intact. Use in place of end()
+	 * when you don't want to change the array
+	 *
+	 * @param array $arr
+	 * @return mixed what ever is in the array
+	 */
+	public static function get_one_item_from_array($arr)
+	{
+		$item = end($arr);
+		reset($arr);
+		return $item;
+	}
+
+	/**
+	 * Detects if this is a multi-dimensional array
+	 * meaning that at least one top-level value is an array. Eg [ [], ...]
+	 *
+	 * @param mixed $arr
+	 * @return boolean
+	 */
+	public static function is_multi_dimensional_array($arr)
+	{
+		if (is_array($arr)) {
+			foreach ($arr as $item) {
+				if (is_array($item)) {
+					return true; // yep, there's at least 2 levels to this array
+				}
+			}
+		}
+		return false; // there's only 1 level, or it's not an array at all!
+	}
+
+	/**
+	 * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
+	 *
+	 * @param array $arr
+	 * @param mixed $index
+	 * @param mixed $default
+	 * @return mixed
+	 */
+	public static function is_set($arr, $index, $default)
+	{
+		return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+	}
+
+	/**
+	 * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
+	 *
+	 * @param mixed $value usually a string, but could be an array or object
+	 * @return mixed the UN-serialized data
+	 */
+	public static function maybe_unserialize($value)
+	{
+		$data = maybe_unserialize($value);
+		// it's possible that this still has serialized data if it's the session.
+		//  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesn't unserialize this automatically.
+		$token = 'C';
+		$data = is_string($data) ? trim($data) : $data;
+		if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
+			return unserialize($data);
+		} else {
+			return $data;
+		}
+	}
+
+
+	/**
+	 * insert_into_array
+	 *
+	 * @param array        $target_array the array to insert new data into
+	 * @param array        $array_to_insert the new data to be inserted
+	 * @param int | string $offset a known key within $target_array where new data will be inserted
+	 * @param bool         $add_before whether to add new data before or after the offset key
+	 * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
+	 * @return array
+	 */
+	public static function insert_into_array(
+		$target_array = array(),
+		$array_to_insert = array(),
+		$offset = null,
+		$add_before = true,
+		$preserve_keys = true
+	) {
+		// ensure incoming arrays are actually arrays
+		$target_array = (array) $target_array;
+		$array_to_insert = (array) $array_to_insert;
+		// if no offset key was supplied
+		if (empty($offset)) {
+			// use start or end of $target_array based on whether we are adding before or not
+			$offset = $add_before ? 0 : count($target_array);
+		}
+		// if offset key is a string, then find the corresponding numeric location for that element
+		$offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
+		// add one to the offset if adding after
+		$offset = $add_before ? $offset : $offset + 1;
+		// but ensure offset does not exceed the length of the array
+		$offset = $offset > count($target_array) ? count($target_array) : $offset;
+		// reindex array ???
+		if ($preserve_keys) {
+			// take a slice of the target array from the beginning till the offset,
+			// then add the new data
+			// then add another slice that starts at the offset and goes till the end
+			return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
+				$target_array,
+				$offset,
+				null,
+				true
+			);
+		} else {
+			// since we don't want to preserve keys, we can use array_splice
+			array_splice($target_array, $offset, 0, $array_to_insert);
+			return $target_array;
+		}
+	}
+
+
+	/**
+	 * array_merge() is slow and should never be used while looping over data
+	 * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
+	 * so really this acts more like array_replace( $array1, $array2 )
+	 * or a union with the arrays flipped ( $array2 + $array1 )
+	 * this saves a few lines of code and improves readability
+	 *
+	 * @param array $array1
+	 * @param array $array2
+	 * @return array
+	 */
+	public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
+	{
+		foreach ($array2 as $key => $value) {
+			$array1[ $key ] = $value;
+		}
+		return $array1;
+	}
+
+
+	/**
+	 * given a flat array like $array = array('A', 'B', 'C')
+	 * will convert into a multidimensional array like $array[A][B][C]
+	 * if $final_value is provided and is anything other than null,
+	 * then that will be set as the value for the innermost array key
+	 * like so: $array[A][B][C] = $final_value
+	 *
+	 * @param array $flat_array
+	 * @param mixed $final_value
+	 * @return array
+	 */
+	public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
+	{
+		$multidimensional = array();
+		$reference = &$multidimensional;
+		foreach ($flat_array as $key) {
+			$reference[ $key ] = array();
+			$reference = &$reference[ $key ];
+		}
+		if ($final_value !== null) {
+			$reference = $final_value;
+		}
+		return $multidimensional;
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	public static function is_array_numerically_and_sequentially_indexed(array $array)
+	{
+		return empty($array) || array_keys($array) === range(0, count($array) - 1);
+	}
+
+
+	/**
+	 * recursively walks through an array and adds slashes to all no array elements
+	 *
+	 * @param mixed $element
+	 * @return array|string
+	 * @since   $VID:$
+	 */
+	public static function addSlashesRecursively($element)
+	{
+		if (is_array($element)) {
+			foreach ($element as $key => $value) {
+				$element[ $key ] = EEH_Array::addSlashesRecursively($value);
+			}
+			return $element;
+		}
+		return is_string($element) ? addslashes($element) : $element;
+	}
 }

core/helpers/EEH_Form_Fields.helper.php

Spacing +136 added lines, -136 removed lines

@@ -110,8 +110,8 @@ 
             $type           = $input_value['input'];
             $value          = $input_value['value'];
 
-            $id    = $form_id ? $form_id . '-' . $input_key : $input_key;
-            $class = $required ? 'required ' . $css_class : $css_class;
+            $id    = $form_id ? $form_id.'-'.$input_key : $input_key;
+            $class = $required ? 'required '.$css_class : $css_class;
 
             // what type of input are we dealing with ?
             switch ($type) {
@@ -163,8 +163,8 @@ 
             }
         } // end foreach( $input_vars as $input_key => $input_value )
 
-        if (! empty($inputs)) {
-            $glue   = "
+        if ( ! empty($inputs)) {
+            $glue = "
                 </li>
                 <li>
                     ";
@@ -177,7 +177,7 @@ 
             </ul>
             ";
         }
-        return $output . implode("\n", $hidden_inputs);
+        return $output.implode("\n", $hidden_inputs);
     }
 
 
@@ -258,7 +258,7 @@ 
             // generate label
             $label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
             // generate field name
-            $name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+            $name = ! empty($unique_id) ? $field_name.'['.$unique_id.']' : $field_name;
 
             // we determine what we're building based on the type
             switch ($type) {
@@ -269,14 +269,14 @@ 
                         foreach ($value as $key => $val) {
                             $c_input .= self::adminMulti(
                                 $default,
-                                isset($classes[ $key ]) ? $classes[ $key ] : '',
-                                $field_name . '_' . $value,
+                                isset($classes[$key]) ? $classes[$key] : '',
+                                $field_name.'_'.$value,
                                 $name,
                                 $required,
                                 $tab_index,
                                 $type,
                                 $val,
-                                isset($labels[ $key ]) ? $labels[ $key ] : ''
+                                isset($labels[$key]) ? $labels[$key] : ''
                             );
                         }
                         $field = $c_input;
@@ -302,7 +302,7 @@ 
                 case 'select':
                     $options = [];
                     foreach ($value as $key => $val) {
-                        $options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
+                        $options[$val] = isset($labels[$key]) ? $labels[$key] : '';
                     }
                     $field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
                     break;
@@ -328,7 +328,7 @@ 
                     $field = self::adminText($class, $id, $name, $required, $tab_index, $value);
             }
 
-            $form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
+            $form_fields[$field_name] = ['label' => $label, 'field' => $field.$extra_desc];
         }
 
         return $form_fields;
@@ -536,7 +536,7 @@ 
     public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
     {
         // if $values was submitted in the wrong format, convert it over
-        if (! empty($values) && (! array_key_exists(0, $values) || ! is_array($values[0]))) {
+        if ( ! empty($values) && ( ! array_key_exists(0, $values) || ! is_array($values[0]))) {
             $converted_values = [];
             foreach ($values as $id => $text) {
                 $converted_values[] = ['id' => $id, 'text' => $text];
@@ -545,18 +545,18 @@ 
         }
 
         $field =
-            '<select id="' . EEH_Formatter::ee_tep_output_string($name)
-            . '" name="' . EEH_Formatter::ee_tep_output_string($name)
+            '<select id="'.EEH_Formatter::ee_tep_output_string($name)
+            . '" name="'.EEH_Formatter::ee_tep_output_string($name)
             . '"';
 
         if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
+            $field .= ' '.$parameters;
         }
         if ($autosize) {
             $size = 'med';
             for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
+                if ($values[$ii]['text']) {
+                    if (strlen($values[$ii]['text']) > 5) {
                         $size = 'wide';
                     }
                 }
@@ -565,22 +565,22 @@ 
             $size = '';
         }
 
-        $field .= ' class="' . $class . ' ' . $size . '">';
+        $field .= ' class="'.$class.' '.$size.'">';
 
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
+        if (empty($default) && isset($GLOBALS[$name])) {
+            $default = stripslashes($GLOBALS[$name]);
         }
 
 
         for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
+            $field .= '<option value="'.$values[$i]['id'].'"';
+            if ($default == $values[$i]['id']) {
                 $field .= ' selected = "selected"';
             }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
+            if (isset($values[$i]['class'])) {
+                $field .= ' class="'.$values[$i]['class'].'"';
             }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
+            $field .= '>'.$values[$i]['text'].'</option>';
         }
         $field .= '</select>';
 
@@ -606,11 +606,11 @@ 
         $after_question_group_questions  =
             apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
+                if ( ! empty($QSG['QSG_questions'])) {
                     // use fieldsets
                     $html .= "\n\t"
                              . '<'
@@ -635,7 +635,7 @@ 
                     $html .= $before_question_group_questions;
                     // loop thru questions
                     foreach ($QSG['QSG_questions'] as $question) {
-                        $QFI  = new EE_Question_Form_Input(
+                        $QFI = new EE_Question_Form_Input(
                             $question['qst_obj'],
                             $question['ans_obj'],
                             $question
@@ -643,7 +643,7 @@ 
                         $html .= self::generate_form_input($QFI);
                     }
                     $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
+                    $html .= "\n\t".'</'.$group_wrapper.'>';
                 }
             }
         }
@@ -683,25 +683,25 @@ 
             'input_id'    => '',
             'input_class' => '',
         ];
-        $q_meta         = array_merge($default_q_meta, $q_meta);
+        $q_meta = array_merge($default_q_meta, $q_meta);
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 if ($QSG instanceof EE_Question_Group) {
                     // check that questions exist
 
                     $where = ['QST_deleted' => 0];
-                    if (! $from_admin) {
+                    if ( ! $from_admin) {
                         $where['QST_admin_only'] = 0;
                     }
                     $questions =
                         $QSG->questions([$where, 'order_by' => ['Question_Group_Question.QGQ_order' => 'ASC']]);
-                    if (! empty($questions)) {
+                    if ( ! empty($questions)) {
                         // use fieldsets
                         $html .= "\n\t"
-                                 . '<' . $group_wrapper . ' class="espresso-question-group-wrap" '
-                                 . 'id="' . $QSG->get('QSG_identifier') . '">';
+                                 . '<'.$group_wrapper.' class="espresso-question-group-wrap" '
+                                 . 'id="'.$QSG->get('QSG_identifier').'">';
                         // group_name
                         if ($QSG->show_group_name()) {
                             $html .= "\n\t\t"
@@ -726,21 +726,21 @@ 
                             /** @var RequestInterface $request */
                             $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
                             $request_qstn = $request->getRequestParam('qstn', [], 'string', true);
-                            if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+                            if ( ! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
                                 // check for answer in $request_qstn in case we are reprocessing a form after an error
-                                if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
-                                        ? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
-                                        : sanitize_text_field($request_qstn[ $q_meta['input_id'] ][ $qstn_id ]);
+                                if (isset($request_qstn[$q_meta['input_id']][$qstn_id])) {
+                                    $answer = is_array($request_qstn[$q_meta['input_id']][$qstn_id])
+                                        ? $request_qstn[$q_meta['input_id']][$qstn_id]
+                                        : sanitize_text_field($request_qstn[$q_meta['input_id']][$qstn_id]);
                                 }
                             } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
                                 // attendee data from the session
                                 $answer =
-                                    isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+                                    isset($q_meta['attendee'][$qstn_id]) ? $q_meta['attendee'][$qstn_id] : null;
                             }
 
 
-                            $QFI  = new EE_Question_Form_Input(
+                            $QFI = new EE_Question_Form_Input(
                                 $QST,
                                 EE_Answer::new_instance(
                                     [
@@ -755,7 +755,7 @@ 
                             $html .= self::generate_form_input($QFI);
                         }
                         $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
+                        $html .= "\n\t".'</'.$group_wrapper.'>';
                     }
                 }
             }
@@ -803,7 +803,7 @@ 
             $QFI->get('QST_required_text') != ''
                 ? $QFI->get('QST_required_text')
                 : esc_html__('This field is required', 'event_espresso');
-        $required_text     = $QST_required
+        $required_text = $QST_required
             ? "\n\t\t\t"
               . '<div class="required-text hidden">'
               . self::prep_answer($required_text, $use_html_entities)
@@ -949,7 +949,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -961,13 +961,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -976,12 +976,12 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+            . '<input type="text" name="'.$name.'" id="'.$id.'" '
+            . 'class="'.$class.' '.$required['class'].'" value="'.esc_attr($answer).'"  '
+            . 'title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1015,7 +1015,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1031,13 +1031,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -1046,14 +1046,14 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+            . '<textarea name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" '
+            . 'rows="'.$dimensions['rows'].'" cols="'.$dimensions['cols'].'"  '
+            . 'title="'.$required['msg'].'" '.$disabled.' '.$extra.'>'
             . $answer
             . '</textarea>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1090,7 +1090,7 @@ 
     ) {
 
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -1108,13 +1108,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -1123,16 +1123,16 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+            . '<select name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" '
+            . 'title="'.esc_attr($required['msg']).'"'.$disabled.' '.$extra.'>';
         // recursively count array elements, to determine total number of options
         $only_option = count($options, 1) == 1;
-        if (! $only_option) {
+        if ( ! $only_option) {
             // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
-            $selected   = $answer === null ? ' selected="selected"' : '';
+            $selected = $answer === null ? ' selected="selected"' : '';
             $input_html .= $add_please_select_option
                 ? "\n\t\t\t\t"
-                  . '<option value=""' . $selected . '>'
+                  . '<option value=""'.$selected.'>'
                   . esc_html__(' - please select - ', 'event_espresso')
                   . '</option>'
                 : '';
@@ -1155,7 +1155,7 @@ 
                 );
         }
 
-        $input_html .= "\n\t\t\t" . '</select>';
+        $input_html .= "\n\t\t\t".'</select>';
 
         $input_html =
             apply_filters(
@@ -1170,7 +1170,7 @@ 
             );
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1188,11 +1188,11 @@ 
      */
     private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
     {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+        $html = "\n\t\t\t\t".'<optgroup label="'.self::prep_option_value($opt_group).'">';
         foreach ($QSOs as $QSO) {
             $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
         }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
+        $html .= "\n\t\t\t\t".'</optgroup>';
         return $html;
     }
 
@@ -1219,7 +1219,7 @@ 
         $value    = ! empty($value) ? $value : $key;
         $selected = ($answer == $key || $only_option) ? 'selected="selected"' : '';
         return "\n\t\t\t\t"
-               . '<option value="' . self::prep_option_value($key) . '" ' . $selected . '> '
+               . '<option value="'.self::prep_option_value($key).'" '.$selected.'> '
                . $value
                . '&nbsp;&nbsp;&nbsp;</option>';
     }
@@ -1263,7 +1263,7 @@ 
         $use_desc_4_label = false
     ) {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -1280,7 +1280,7 @@ 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
+            . '<label class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label> ';
@@ -1289,49 +1289,49 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-radio-btn-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
             if ($OPT instanceof EE_Question_Option) {
                 $value   = self::prep_option_value($OPT->value());
                 $label   = $use_desc_4_label ? $OPT->desc() : $OPT->value();
                 $size    = $use_desc_4_label
-                    ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc())
+                    ? self::get_label_size_class($OPT->value().' '.$OPT->desc())
                     : self::get_label_size_class($OPT->value());
-                $desc    = $OPT->desc();// no self::prep_answer
+                $desc    = $OPT->desc(); // no self::prep_answer
                 $answer  = is_numeric($value) && empty($answer) ? 0 : $answer;
                 $checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
-                $opt     = '-' . sanitize_key($value);
+                $opt     = '-'.sanitize_key($value);
 
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
+                $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+                $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-radio-btn-lbl">';
+                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$label.'</span>' : '';
                 $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'title="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
+                               . '<input type="radio" name="'.$name.'" id="'.$id.$opt.'" '
+                               . 'class="'.$class.'" value="'.$value.'" '
+                               . 'title="'.esc_attr($required['msg']).'" '.$disabled
+                               . $checked.' '.$extra.'/>';
                 $input_html .= ! $label_b4
                     ? "\n\t\t\t\t\t\t"
                       . '<span class="espresso-radio-btn-desc">'
                       . $label
                       . '</span>'
                     : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
+                $input_html .= "\n\t\t\t\t\t".'</label>';
                 $input_html .= $use_desc_4_label
                     ? ''
-                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
+                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">'.$desc.'</span>';
+                $input_html .= "\n\t\t\t\t".'</li>';
             }
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1366,7 +1366,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         $answer = maybe_unserialize($answer);
@@ -1376,7 +1376,7 @@ 
 
         foreach ($answer as $key => $value) {
             $key            = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
+            $answer[$key] = self::prep_answer($value, $use_html_entities);
         }
 
         // prep the required array
@@ -1391,7 +1391,7 @@ 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
+            . '<label class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label> ';
@@ -1400,42 +1400,42 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-checkbox-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size  = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+            $value = $OPT->value(); // self::prep_option_value( $OPT->value() );
+            $size  = self::get_label_size_class($OPT->value().' '.$OPT->desc());
             $text  = self::prep_answer($OPT->value());
             $desc  = $OPT->desc();
-            $opt   = '-' . sanitize_key($value);
+            $opt   = '-'.sanitize_key($value);
 
             $checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
 
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+            $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+            $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-checkbox-lbl">';
+            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
             $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
+                           . '<input type="checkbox" name="'.$name.'['.$OPT->ID().']" '
+                           . 'id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" '
+                           . 'title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
+            $input_html .= "\n\t\t\t\t\t".'</label>';
+            if ( ! empty($desc) && $desc != $text) {
                 $input_html .= "\n\t\t\t\t\t"
                                . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'
                                . $desc
                                . '</div>';
             }
-            $input_html .= "\n\t\t\t\t" . '</li>';
+            $input_html .= "\n\t\t\t\t".'</li>';
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1467,7 +1467,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1479,13 +1479,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -1494,14 +1494,14 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+            . '<input type="text" name="'.$name.'" id="'.$id.'" '
+            . 'class="'.$class.' '.$required['class'].' datepicker" value="'.$answer.'"  '
+            . 'title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
         // enqueue scripts
         wp_register_style(
             'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -1509,7 +1509,7 @@ 
         wp_enqueue_script('jquery-ui-datepicker');
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1536,7 +1536,7 @@ 
     public static function hidden_input($name, $value, $id = '')
     {
         $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' . $value . '"/>';
+        return '<input id="'.$id.'" type="hidden" name="'.$name.'" value="'.$value.'"/>';
     }
 
 
@@ -1581,7 +1581,7 @@ 
         $prepped_answer_options = [];
         if (is_array($QSOs) && ! empty($QSOs)) {
             foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
+                if ( ! $QSO instanceof EE_Question_Option) {
                     $QSO = EE_Question_Option::new_instance(
                         [
                             'QSO_value' => is_array($QSO) && isset($QSO['id'])
@@ -1594,7 +1594,7 @@ 
                     );
                 }
                 if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+                    $prepped_answer_options[$QSO->opt_group()][] = $QSO;
                 } else {
                     $prepped_answer_options[] = $QSO;
                 }
@@ -1806,7 +1806,7 @@ 
         $options = [];
         for ($x = 1; $x <= 12; $x++) {
             $mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $mm ] = $mm;
+            $options[$mm] = $mm;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1824,7 +1824,7 @@ 
         $next_decade  = $current_year + 10;
         for ($x = $current_year; $x <= $next_decade; $x++) {
             $yy             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $yy ] = $yy;
+            $options[$yy] = $yy;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1843,7 +1843,7 @@ 
     public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
     {
         $_where = [];
-        if (! empty($status)) {
+        if ( ! empty($status)) {
             $_where['STS_ID'] = $status;
         }
 
@@ -1862,7 +1862,7 @@ 
         ];
 
         foreach ($regdtts as $regdtt) {
-            $date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+            $date      = $regdtt->reg_month.' '.$regdtt->reg_year;
             $options[] = [
                 'text' => $date,
                 'id'   => $date,
@@ -1911,7 +1911,7 @@ 
         // categories?
 
 
-        if (! empty($evt_category)) {
+        if ( ! empty($evt_category)) {
             $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
             $where['Event.Term_Taxonomy.term_id']  = $evt_category;
         }
@@ -1934,8 +1934,8 @@ 
         global $wp_locale;
 
         foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id             = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+            $localized_date = $wp_locale->get_month($DTT->dtt_month_num).' '.$DTT->dtt_year;
+            $id             = $DTT->dtt_month.' '.$DTT->dtt_year;
             $options[]      = [
                 'text' => $localized_date,
                 'id'   => $id,
@@ -2008,16 +2008,16 @@ 
             return $btn;
         }
         $text = ! empty($text) ? $text : esc_html__('Submit', 'event_espresso');
-        $btn  .= '<input id="' . $ID . '-btn" class="' . $class . '" '
-                 . 'type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
+        $btn .= '<input id="'.$ID.'-btn" class="'.$class.'" '
+                 . 'type="submit" value="'.$text.'" '.$extra_attributes.'/>';
+        if ( ! $input_only) {
+            $btn_frm = '<form id="'.$ID.'-frm" method="POST" action="'.$url.'">';
             $btn_frm .= ! empty($nonce_action)
-                ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false)
+                ? wp_nonce_field($nonce_action, $nonce_action.'_nonce', true, false)
                 : '';
             $btn_frm .= $btn;
             $btn_frm .= '</form>';
-            $btn     = $btn_frm;
+            $btn = $btn_frm;
             unset($btn_frm);
         }
         return $btn;

Indentation +1971 added lines, -1971 removed lines

@@ -29,1997 +29,1997 @@
 {
 
 
-    /**
-     *  Generates HTML for the forms used on admin pages
-     *
-     *
-     * @static
-     * @access public
-     * @param array $input_vars - array of input field details
-     *                          format:
-     *                          $template_form_fields['field-id'] = array(
-     *                          'name' => 'name_attribute',
-     *                          'label' => esc_html__('Field Label', 'event_espresso'), //or false
-     *                          'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden',
-     *                          'checkbox', 'wp_editor'
-     *                          'type' => 'int', //what "type" the value is (i.e. string, int etc)
-     *                          'required' => false, //boolean for whether the field is required
-     *                          'validation' => true, //boolean, whether to validate the field (todo)
-     *                          'value' => 'some_value_for_field', //what value is used for field
-     *                          'format' => '%d', //what format the value is (%d, %f, or %s)
-     *                          'db-col' => 'column_in_db' //used to indicate which column the field corresponds with
-     *                          in the db
-     *                          'options' => optiona, optionb || array('value' => 'label', '') //if the input type is
-     *                          "select", this allows you to set the args for the different <option> tags.
-     *                          'tabindex' => 1 //this allows you to set the tabindex for the field.
-     *                          'append_content' => '' //this allows you to send in html content to append to the
-     *                          field.
-     *                          )
-     * @param array $form_id    - used for defining unique identifiers for the form.
-     * @return string
-     * @todo   : at some point we can break this down into other static methods to abstract it a bit better.
-     */
-    public static function get_form_fields($input_vars = [], $form_id = false)
-    {
-
-        if (empty($input_vars)) {
-            EE_Error::add_error(
-                esc_html__('missing required variables for the form field generator', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $output        = "";
-        $inputs        = [];
-        $hidden_inputs = [];
-
-        // cycle thru inputs
-        foreach ($input_vars as $input_key => $input_value) {
-            $defaults = [
-                'append_content' => '',
-                'css_class'      => '',
-                'cols'           => 80,
-                'db-col'         => 'column_in_db',
-                'format'         => '%d',
-                'input'          => 'hidden',
-                'label'          => esc_html__('No label', 'event_espresso'),
-                'name'           => $input_key,
-                'options'        => [],
-                'required'       => false,
-                'tabindex'       => 0,
-                'rows'           => 10,
-                'type'           => 'int',
-                'validation'     => true,
-                'value'          => 'some_value_for_field',
-            ];
-
-            $input_value = wp_parse_args($input_value, $defaults);
-
-            $append_content = $input_value['append_content'];
-            $css_class      = $input_value['css_class'];
-            $cols           = $input_value['cols'];
-            $label          = $input_value['label'];
-            $name           = $input_value['name'];
-            $options        = $input_value['options'];
-            $required       = $input_value['required'];
-            $tab_index      = $input_value['tabindex'];
-            $rows           = $input_value['rows'];
-            $type           = $input_value['input'];
-            $value          = $input_value['value'];
-
-            $id    = $form_id ? $form_id . '-' . $input_key : $input_key;
-            $class = $required ? 'required ' . $css_class : $css_class;
-
-            // what type of input are we dealing with ?
-            switch ($type) {
-                case 'checkbox':
-                case 'radio':
-                    $field = self::adminMulti($value, $class, $id, $name, $required, $tab_index, $type, 1, $label);
-                    $field .= $append_content ?: '';
-                    break;
-
-                case 'hidden':
-                    $field           = null;
-                    $hidden_inputs[] = self::adminHidden($css_class, $id, $name, $value);
-                    break;
-
-                case 'select':
-                    $options = is_array($options) ? $options : explode(',', $options);
-                    $field   = self::adminLabel($id, $label, $required);
-                    $field   .= self::adminSelect($value, $class, $id, $name, $required, $tab_index, $options);
-                    $field   .= $append_content ?: '';
-                    break;
-
-                case 'textarea':
-                    $field = self::adminLabel($id, $label, $required);
-                    $field .= self::adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value);
-                    $field .= $append_content ?: '';
-                    break;
-
-                case 'wp_editor':
-                    $label = esc_html($label);
-                    $field = "<h4>{$label}</h4>";
-                    $field .= $append_content ?: '';
-                    $field .= self::adminWpEditor(
-                        $class,
-                        $id,
-                        $name,
-                        $rows,
-                        $tab_index,
-                        $value
-                    );
-                    break;
-
-                default:
-                    $field = self::adminLabel($id, $label, $required);
-                    $field .= self::adminText($class, $id, $name, $required, $tab_index, $value);
-                    $field .= $append_content ?: '';
-            }
-            if ($field) {
-                $inputs[] = $field;
-            }
-        } // end foreach( $input_vars as $input_key => $input_value )
-
-        if (! empty($inputs)) {
-            $glue   = "
+	/**
+	 *  Generates HTML for the forms used on admin pages
+	 *
+	 *
+	 * @static
+	 * @access public
+	 * @param array $input_vars - array of input field details
+	 *                          format:
+	 *                          $template_form_fields['field-id'] = array(
+	 *                          'name' => 'name_attribute',
+	 *                          'label' => esc_html__('Field Label', 'event_espresso'), //or false
+	 *                          'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden',
+	 *                          'checkbox', 'wp_editor'
+	 *                          'type' => 'int', //what "type" the value is (i.e. string, int etc)
+	 *                          'required' => false, //boolean for whether the field is required
+	 *                          'validation' => true, //boolean, whether to validate the field (todo)
+	 *                          'value' => 'some_value_for_field', //what value is used for field
+	 *                          'format' => '%d', //what format the value is (%d, %f, or %s)
+	 *                          'db-col' => 'column_in_db' //used to indicate which column the field corresponds with
+	 *                          in the db
+	 *                          'options' => optiona, optionb || array('value' => 'label', '') //if the input type is
+	 *                          "select", this allows you to set the args for the different <option> tags.
+	 *                          'tabindex' => 1 //this allows you to set the tabindex for the field.
+	 *                          'append_content' => '' //this allows you to send in html content to append to the
+	 *                          field.
+	 *                          )
+	 * @param array $form_id    - used for defining unique identifiers for the form.
+	 * @return string
+	 * @todo   : at some point we can break this down into other static methods to abstract it a bit better.
+	 */
+	public static function get_form_fields($input_vars = [], $form_id = false)
+	{
+
+		if (empty($input_vars)) {
+			EE_Error::add_error(
+				esc_html__('missing required variables for the form field generator', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$output        = "";
+		$inputs        = [];
+		$hidden_inputs = [];
+
+		// cycle thru inputs
+		foreach ($input_vars as $input_key => $input_value) {
+			$defaults = [
+				'append_content' => '',
+				'css_class'      => '',
+				'cols'           => 80,
+				'db-col'         => 'column_in_db',
+				'format'         => '%d',
+				'input'          => 'hidden',
+				'label'          => esc_html__('No label', 'event_espresso'),
+				'name'           => $input_key,
+				'options'        => [],
+				'required'       => false,
+				'tabindex'       => 0,
+				'rows'           => 10,
+				'type'           => 'int',
+				'validation'     => true,
+				'value'          => 'some_value_for_field',
+			];
+
+			$input_value = wp_parse_args($input_value, $defaults);
+
+			$append_content = $input_value['append_content'];
+			$css_class      = $input_value['css_class'];
+			$cols           = $input_value['cols'];
+			$label          = $input_value['label'];
+			$name           = $input_value['name'];
+			$options        = $input_value['options'];
+			$required       = $input_value['required'];
+			$tab_index      = $input_value['tabindex'];
+			$rows           = $input_value['rows'];
+			$type           = $input_value['input'];
+			$value          = $input_value['value'];
+
+			$id    = $form_id ? $form_id . '-' . $input_key : $input_key;
+			$class = $required ? 'required ' . $css_class : $css_class;
+
+			// what type of input are we dealing with ?
+			switch ($type) {
+				case 'checkbox':
+				case 'radio':
+					$field = self::adminMulti($value, $class, $id, $name, $required, $tab_index, $type, 1, $label);
+					$field .= $append_content ?: '';
+					break;
+
+				case 'hidden':
+					$field           = null;
+					$hidden_inputs[] = self::adminHidden($css_class, $id, $name, $value);
+					break;
+
+				case 'select':
+					$options = is_array($options) ? $options : explode(',', $options);
+					$field   = self::adminLabel($id, $label, $required);
+					$field   .= self::adminSelect($value, $class, $id, $name, $required, $tab_index, $options);
+					$field   .= $append_content ?: '';
+					break;
+
+				case 'textarea':
+					$field = self::adminLabel($id, $label, $required);
+					$field .= self::adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value);
+					$field .= $append_content ?: '';
+					break;
+
+				case 'wp_editor':
+					$label = esc_html($label);
+					$field = "<h4>{$label}</h4>";
+					$field .= $append_content ?: '';
+					$field .= self::adminWpEditor(
+						$class,
+						$id,
+						$name,
+						$rows,
+						$tab_index,
+						$value
+					);
+					break;
+
+				default:
+					$field = self::adminLabel($id, $label, $required);
+					$field .= self::adminText($class, $id, $name, $required, $tab_index, $value);
+					$field .= $append_content ?: '';
+			}
+			if ($field) {
+				$inputs[] = $field;
+			}
+		} // end foreach( $input_vars as $input_key => $input_value )
+
+		if (! empty($inputs)) {
+			$glue   = "
                 </li>
                 <li>
                     ";
-            $inputs = implode($glue, $inputs);
-            $output = "
+			$inputs = implode($glue, $inputs);
+			$output = "
             <ul>
                 <li>
                 {$inputs}
                 </li>
             </ul>
             ";
-        }
-        return $output . implode("\n", $hidden_inputs);
-    }
-
-
-    /**
-     * form_fields_array
-     * This utility function assembles form fields from a given structured array with field information.
-     * //TODO: This is an alternate generator that we may want to use instead.
-     *
-     * @param array $fields structured array of fields to assemble in the following format:
-     *                      [field_name] => array(
-     *                      ['label'] => 'label for field',
-     *                      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select
-     *                      type of field you can indicated the labels for each option via this index
-     *                      ['extra_desc'] => 'extra description for the field', //optional
-     *                      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults
-     *                      to text
-     *                      ['value'] => 'value that goes in the field', //(if multi then this is an array of values
-     *                      and the 'default' paramater will be used for what is selected)
-     *                      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
-     *                      ['class'] => 'name-of-class(es)-for-input',
-     *                      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi
-     *                      select type of field you can indicate the css class for each option via this index.
-     *                      ['id'] => 'css-id-for-input') //defaults to 'field_name'
-     *                      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields
-     *                      generated are going to be used in a loop and you want to make sure that the field
-     *                      identifiers are unique from each other.
-     *                      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types
-     *                      such as textarea to indicate cols/rows.
-     *                      ['tabindex'] => '' //this allows you to set the tabindex for the field.
-     *                      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally
-     *                      contain an array of arguments for the editor setup.
-     *
-     * @return array         an array of inputs for form indexed by field name, and in the following structure:
-     *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
-     */
-    public static function get_form_fields_array($fields)
-    {
-
-        $form_fields = [];
-        $fields      = (array) $fields;
-
-        foreach ($fields as $field_name => $field_atts) {
-            // defaults:
-            $defaults = [
-                'class'         => '',
-                'classes'       => '',
-                'default'       => '',
-                'dimensions'    => ['10', '5'],
-                'extra_desc'    => '',
-                'id'            => $field_name,
-                'label'         => '',
-                'labels'        => '',
-                'required'      => false,
-                'tabindex'      => 0,
-                'type'          => 'text',
-                'unique_id'     => '',
-                'value'         => '',
-                'wpeditor_args' => [],
-            ];
-            // merge defaults with passed arguments
-            $_fields = wp_parse_args($field_atts, $defaults);
-
-            $class          = $_fields['class'];
-            $classes        = $_fields['classes'];
-            $default        = $_fields['default'];
-            $dims           = $_fields['dimensions'];
-            $extra_desc     = $_fields['extra_desc'];
-            $id             = $_fields['id'];
-            $label          = $_fields['label'];
-            $labels         = $_fields['labels'];
-            $required       = $_fields['required'];
-            $tab_index      = $_fields['tabindex'];
-            $type           = $_fields['type'];
-            $unique_id      = $_fields['unique_id'];
-            $value          = $_fields['value'];
-            $wp_editor_args = $_fields['wpeditor_args'];
-
-            // generate label
-            $label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
-            // generate field name
-            $name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
-
-            // we determine what we're building based on the type
-            switch ($type) {
-                case 'checkbox':
-                case 'radio':
-                    if (is_array($value)) {
-                        $c_input = '';
-                        foreach ($value as $key => $val) {
-                            $c_input .= self::adminMulti(
-                                $default,
-                                isset($classes[ $key ]) ? $classes[ $key ] : '',
-                                $field_name . '_' . $value,
-                                $name,
-                                $required,
-                                $tab_index,
-                                $type,
-                                $val,
-                                isset($labels[ $key ]) ? $labels[ $key ] : ''
-                            );
-                        }
-                        $field = $c_input;
-                    } else {
-                        $field = self::adminMulti(
-                            $default,
-                            $class,
-                            $id,
-                            $name,
-                            $required,
-                            $tab_index,
-                            $type,
-                            $value,
-                            $_fields['label']
-                        );
-                    }
-                    break;
-
-                case 'hidden':
-                    $field = self::adminHidden($class, $id, $name, $value);
-                    break;
-
-                case 'select':
-                    $options = [];
-                    foreach ($value as $key => $val) {
-                        $options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
-                    }
-                    $field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
-                    break;
-
-                case 'textarea':
-                    $field =
-                        self::adminTextarea($class, $dims[0], $id, $name, $required, $dims[1], $tab_index, $value);
-                    break;
-
-                case 'wp_editor':
-                    $field = self::adminWpEditor(
-                        $class,
-                        $_fields['id'],
-                        $name,
-                        $dims[1],
-                        $tab_index,
-                        $value,
-                        $wp_editor_args
-                    );
-                    break;
-
-                default:
-                    $field = self::adminText($class, $id, $name, $required, $tab_index, $value);
-            }
-
-            $form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
-        }
-
-        return $form_fields;
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminHidden($class, $id, $name, $value)
-    {
-        $id    = esc_attr($id);
-        $name  = esc_attr($name);
-        $class = esc_attr($class);
-        return "
+		}
+		return $output . implode("\n", $hidden_inputs);
+	}
+
+
+	/**
+	 * form_fields_array
+	 * This utility function assembles form fields from a given structured array with field information.
+	 * //TODO: This is an alternate generator that we may want to use instead.
+	 *
+	 * @param array $fields structured array of fields to assemble in the following format:
+	 *                      [field_name] => array(
+	 *                      ['label'] => 'label for field',
+	 *                      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select
+	 *                      type of field you can indicated the labels for each option via this index
+	 *                      ['extra_desc'] => 'extra description for the field', //optional
+	 *                      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults
+	 *                      to text
+	 *                      ['value'] => 'value that goes in the field', //(if multi then this is an array of values
+	 *                      and the 'default' paramater will be used for what is selected)
+	 *                      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
+	 *                      ['class'] => 'name-of-class(es)-for-input',
+	 *                      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi
+	 *                      select type of field you can indicate the css class for each option via this index.
+	 *                      ['id'] => 'css-id-for-input') //defaults to 'field_name'
+	 *                      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields
+	 *                      generated are going to be used in a loop and you want to make sure that the field
+	 *                      identifiers are unique from each other.
+	 *                      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types
+	 *                      such as textarea to indicate cols/rows.
+	 *                      ['tabindex'] => '' //this allows you to set the tabindex for the field.
+	 *                      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally
+	 *                      contain an array of arguments for the editor setup.
+	 *
+	 * @return array         an array of inputs for form indexed by field name, and in the following structure:
+	 *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
+	 */
+	public static function get_form_fields_array($fields)
+	{
+
+		$form_fields = [];
+		$fields      = (array) $fields;
+
+		foreach ($fields as $field_name => $field_atts) {
+			// defaults:
+			$defaults = [
+				'class'         => '',
+				'classes'       => '',
+				'default'       => '',
+				'dimensions'    => ['10', '5'],
+				'extra_desc'    => '',
+				'id'            => $field_name,
+				'label'         => '',
+				'labels'        => '',
+				'required'      => false,
+				'tabindex'      => 0,
+				'type'          => 'text',
+				'unique_id'     => '',
+				'value'         => '',
+				'wpeditor_args' => [],
+			];
+			// merge defaults with passed arguments
+			$_fields = wp_parse_args($field_atts, $defaults);
+
+			$class          = $_fields['class'];
+			$classes        = $_fields['classes'];
+			$default        = $_fields['default'];
+			$dims           = $_fields['dimensions'];
+			$extra_desc     = $_fields['extra_desc'];
+			$id             = $_fields['id'];
+			$label          = $_fields['label'];
+			$labels         = $_fields['labels'];
+			$required       = $_fields['required'];
+			$tab_index      = $_fields['tabindex'];
+			$type           = $_fields['type'];
+			$unique_id      = $_fields['unique_id'];
+			$value          = $_fields['value'];
+			$wp_editor_args = $_fields['wpeditor_args'];
+
+			// generate label
+			$label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
+			// generate field name
+			$name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+
+			// we determine what we're building based on the type
+			switch ($type) {
+				case 'checkbox':
+				case 'radio':
+					if (is_array($value)) {
+						$c_input = '';
+						foreach ($value as $key => $val) {
+							$c_input .= self::adminMulti(
+								$default,
+								isset($classes[ $key ]) ? $classes[ $key ] : '',
+								$field_name . '_' . $value,
+								$name,
+								$required,
+								$tab_index,
+								$type,
+								$val,
+								isset($labels[ $key ]) ? $labels[ $key ] : ''
+							);
+						}
+						$field = $c_input;
+					} else {
+						$field = self::adminMulti(
+							$default,
+							$class,
+							$id,
+							$name,
+							$required,
+							$tab_index,
+							$type,
+							$value,
+							$_fields['label']
+						);
+					}
+					break;
+
+				case 'hidden':
+					$field = self::adminHidden($class, $id, $name, $value);
+					break;
+
+				case 'select':
+					$options = [];
+					foreach ($value as $key => $val) {
+						$options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
+					}
+					$field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
+					break;
+
+				case 'textarea':
+					$field =
+						self::adminTextarea($class, $dims[0], $id, $name, $required, $dims[1], $tab_index, $value);
+					break;
+
+				case 'wp_editor':
+					$field = self::adminWpEditor(
+						$class,
+						$_fields['id'],
+						$name,
+						$dims[1],
+						$tab_index,
+						$value,
+						$wp_editor_args
+					);
+					break;
+
+				default:
+					$field = self::adminText($class, $id, $name, $required, $tab_index, $value);
+			}
+
+			$form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
+		}
+
+		return $form_fields;
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminHidden($class, $id, $name, $value)
+	{
+		$id    = esc_attr($id);
+		$name  = esc_attr($name);
+		$class = esc_attr($class);
+		return "
         <input name='{$name}' type='hidden' id='{$id}' class='{$class}' value='{$value}' />";
-    }
-
-
-    /**
-     * @param string $id
-     * @param string $label
-     * @param string $required
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminLabel($id, $label, $required)
-    {
-        $id       = esc_attr($id);
-        $label    = esc_html($label);
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? " <span>*</span>" : '';
-        return "<label for='{$id}'>{$label}{$required}</label>";
-    }
-
-
-    /**
-     * @param string $default
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param string $type
-     * @param string $value
-     * @param string $label
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminMulti($default, $class, $id, $name, $required, $tab_index, $type, $value, $label = '')
-    {
-        $id        = esc_attr($id);
-        $name      = esc_attr($name);
-        $class     = esc_attr($class);
-        $tab_index = absint($tab_index);
-        $checked   = ! empty($default) && $default == $value ? 'checked="checked" ' : '';
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        $input     = "
+	}
+
+
+	/**
+	 * @param string $id
+	 * @param string $label
+	 * @param string $required
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminLabel($id, $label, $required)
+	{
+		$id       = esc_attr($id);
+		$label    = esc_html($label);
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? " <span>*</span>" : '';
+		return "<label for='{$id}'>{$label}{$required}</label>";
+	}
+
+
+	/**
+	 * @param string $default
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param string $type
+	 * @param string $value
+	 * @param string $label
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminMulti($default, $class, $id, $name, $required, $tab_index, $type, $value, $label = '')
+	{
+		$id        = esc_attr($id);
+		$name      = esc_attr($name);
+		$class     = esc_attr($class);
+		$tab_index = absint($tab_index);
+		$checked   = ! empty($default) && $default == $value ? 'checked="checked" ' : '';
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		$input     = "
         <input name='{$name}[]' type='{$type}' id='{$id}' class='{$class}' value='{$value}' {$checked} {$required} tabindex='{$tab_index}'/>";
-        if ($label === '') {
-            return $input;
-        }
-        $label = esc_html($label);
-        return "
+		if ($label === '') {
+			return $input;
+		}
+		$label = esc_html($label);
+		return "
         <label for='$id'>
             {$input}
             {$label}
         </label>";
-    }
-
-
-    /**
-     * @param string $default
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param array  $options
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminSelect($default, $class, $id, $name, $required, $tab_index, $options = [])
-    {
-        $options_array = [];
-        foreach ($options as $value => $label) {
-            $selected        = ! empty($default) && $default == $value ? 'selected="selected"' : '';
-            $value           = esc_attr($value);
-            $label           = wp_strip_all_tags($label);
-            $options_array[] = "<option value='{$value}' {$selected}>{$label}</option>";
-        }
-        $options_html = implode($options_array, "\n");
-        $id           = esc_attr($id);
-        $name         = esc_attr($name);
-        $class        = esc_attr($class);
-        $tab_index    = absint($tab_index);
-        $required     = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        return "
+	}
+
+
+	/**
+	 * @param string $default
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param array  $options
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminSelect($default, $class, $id, $name, $required, $tab_index, $options = [])
+	{
+		$options_array = [];
+		foreach ($options as $value => $label) {
+			$selected        = ! empty($default) && $default == $value ? 'selected="selected"' : '';
+			$value           = esc_attr($value);
+			$label           = wp_strip_all_tags($label);
+			$options_array[] = "<option value='{$value}' {$selected}>{$label}</option>";
+		}
+		$options_html = implode($options_array, "\n");
+		$id           = esc_attr($id);
+		$name         = esc_attr($name);
+		$class        = esc_attr($class);
+		$tab_index    = absint($tab_index);
+		$required     = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		return "
         <select name='{$name}' id='{$id}' class='{$class}' {$required} tabindex='{$tab_index}'>
             {$options_html}
         </select>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminText($class, $id, $name, $required, $tab_index, $value)
-    {
-        $id        = esc_attr($id);
-        $name      = esc_attr($name);
-        $class     = esc_attr($class);
-        $tab_index = absint($tab_index);
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        return "
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminText($class, $id, $name, $required, $tab_index, $value)
+	{
+		$id        = esc_attr($id);
+		$name      = esc_attr($name);
+		$class     = esc_attr($class);
+		$tab_index = absint($tab_index);
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		return "
         <input name='{$name}' type='text' id='{$id}' class='{$class}' value='{$value}' {$required} tabindex='{$tab_index}'/>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param int    $cols
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $rows
-     * @param int    $tab_index
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value)
-    {
-        $id        = esc_attr($id);
-        $name      = esc_attr($name);
-        $class     = esc_attr($class);
-        $cols      = absint($cols);
-        $rows      = absint($rows);
-        $value     = esc_textarea($value);
-        $tab_index = absint($tab_index);
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        return "
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param int    $cols
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $rows
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value)
+	{
+		$id        = esc_attr($id);
+		$name      = esc_attr($name);
+		$class     = esc_attr($class);
+		$cols      = absint($cols);
+		$rows      = absint($rows);
+		$value     = esc_textarea($value);
+		$tab_index = absint($tab_index);
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		return "
         <textarea name='{$name}' id='{$id}' class='{$class}' rows='{$rows}' cols='{$cols}' {$required} tabindex='{$tab_index}'>
             {$value}
         </textarea>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param int    $rows
-     * @param int    $tab_index
-     * @param string $value
-     * @param array  $wp_editor_args
-     * @return false|string
-     * @since   4.10.14.p
-     */
-    private static function adminWpEditor($class, $id, $name, $rows, $tab_index, $value, $wp_editor_args = [])
-    {
-        $editor_settings = $wp_editor_args + [
-                'textarea_name' => esc_attr($name),
-                'textarea_rows' => absint($rows),
-                'editor_class'  => esc_attr($class),
-                'tabindex'      => absint($tab_index),
-            ];
-        ob_start();
-        wp_editor($value, esc_attr($id), $editor_settings);
-        return ob_get_clean();
-    }
-
-
-    /**
-     * espresso admin page select_input
-     * Turns an array into a select fields
-     *
-     * @static
-     * @access public
-     * @param string  $name       field name
-     * @param array   $values     option values, numbered array starting at 0, where each value is an array with a key
-     *                            'text' (meaning text to display' and 'id' (meaning the internal value) eg:
-     *                            array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or
-     *                            as an array of key-value pairs, where the key is to be used for the select input's
-     *                            name, and the value will be the text shown to the user.  Optionally you can also
-     *                            include an additional key of "class" which will add a specific class to the option
-     *                            for that value.
-     * @param string  $default    default value
-     * @param string  $parameters extra parameters
-     * @param string  $class      css class
-     * @param boolean $autosize   whether to autosize the select or not
-     * @return string              html string for the select input
-     */
-    public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
-    {
-        // if $values was submitted in the wrong format, convert it over
-        if (! empty($values) && (! array_key_exists(0, $values) || ! is_array($values[0]))) {
-            $converted_values = [];
-            foreach ($values as $id => $text) {
-                $converted_values[] = ['id' => $id, 'text' => $text];
-            }
-            $values = $converted_values;
-        }
-
-        $field =
-            '<select id="' . EEH_Formatter::ee_tep_output_string($name)
-            . '" name="' . EEH_Formatter::ee_tep_output_string($name)
-            . '"';
-
-        if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
-        }
-        if ($autosize) {
-            $size = 'med';
-            for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
-                        $size = 'wide';
-                    }
-                }
-            }
-        } else {
-            $size = '';
-        }
-
-        $field .= ' class="' . $class . ' ' . $size . '">';
-
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
-        }
-
-
-        for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
-                $field .= ' selected = "selected"';
-            }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
-            }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
-        }
-        $field .= '</select>';
-
-        return $field;
-    }
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param array  $question_groups
-     * @param string $group_wrapper
-     * @return string HTML
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_groups_html($question_groups = [], $group_wrapper = 'fieldset')
-    {
-
-        $html                            = '';
-        $before_question_group_questions =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions  =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        if (! empty($question_groups)) {
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
-                    // use fieldsets
-                    $html .= "\n\t"
-                             . '<'
-                             . $group_wrapper
-                             . ' class="espresso-question-group-wrap" id="'
-                             . $QSG['QSG_identifier']
-                             . '">';
-                    // group_name
-                    $html .= $QSG['QSG_show_group_name']
-                        ? "\n\t\t"
-                          . '<h5 class="espresso-question-group-title-h5 section-title">'
-                          . self::prep_answer($QSG['QSG_name'])
-                          . '</h5>'
-                        : '';
-                    // group_desc
-                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc'])
-                        ? '<div class="espresso-question-group-desc-pg">'
-                          . self::prep_answer($QSG['QSG_desc'])
-                          . '</div>'
-                        : '';
-
-                    $html .= $before_question_group_questions;
-                    // loop thru questions
-                    foreach ($QSG['QSG_questions'] as $question) {
-                        $QFI  = new EE_Question_Form_Input(
-                            $question['qst_obj'],
-                            $question['ans_obj'],
-                            $question
-                        );
-                        $html .= self::generate_form_input($QFI);
-                    }
-                    $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
-                }
-            }
-        }
-
-        return $html;
-    }
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param array  $question_groups
-     * @param array  $q_meta
-     * @param bool   $from_admin
-     * @param string $group_wrapper
-     * @return string HTML
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_groups_html2(
-        $question_groups = [],
-        $q_meta = [],
-        $from_admin = false,
-        $group_wrapper = 'fieldset'
-    ) {
-
-        $html                            = '';
-        $before_question_group_questions =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions  =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        $default_q_meta = [
-            'att_nmbr'    => 1,
-            'ticket_id'   => '',
-            'input_name'  => '',
-            'input_id'    => '',
-            'input_class' => '',
-        ];
-        $q_meta         = array_merge($default_q_meta, $q_meta);
-
-        if (! empty($question_groups)) {
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                if ($QSG instanceof EE_Question_Group) {
-                    // check that questions exist
-
-                    $where = ['QST_deleted' => 0];
-                    if (! $from_admin) {
-                        $where['QST_admin_only'] = 0;
-                    }
-                    $questions =
-                        $QSG->questions([$where, 'order_by' => ['Question_Group_Question.QGQ_order' => 'ASC']]);
-                    if (! empty($questions)) {
-                        // use fieldsets
-                        $html .= "\n\t"
-                                 . '<' . $group_wrapper . ' class="espresso-question-group-wrap" '
-                                 . 'id="' . $QSG->get('QSG_identifier') . '">';
-                        // group_name
-                        if ($QSG->show_group_name()) {
-                            $html .= "\n\t\t"
-                                     . '<h5 class="espresso-question-group-title-h5 section-title">'
-                                     . $QSG->get_pretty('QSG_name')
-                                     . '</h5>';
-                        }
-                        // group_desc
-                        if ($QSG->show_group_desc()) {
-                            $html .= '<div class="espresso-question-group-desc-pg">'
-                                     . $QSG->get_pretty('QSG_desc')
-                                     . '</div>';
-                        }
-
-                        $html .= $before_question_group_questions;
-                        // loop thru questions
-                        foreach ($questions as $QST) {
-                            $qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
-
-                            $answer = null;
-
-                            /** @var RequestInterface $request */
-                            $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-                            $request_qstn = $request->getRequestParam('qstn', [], 'string', true);
-                            if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
-                                // check for answer in $request_qstn in case we are reprocessing a form after an error
-                                if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
-                                        ? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
-                                        : sanitize_text_field($request_qstn[ $q_meta['input_id'] ][ $qstn_id ]);
-                                }
-                            } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
-                                // attendee data from the session
-                                $answer =
-                                    isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
-                            }
-
-
-                            $QFI  = new EE_Question_Form_Input(
-                                $QST,
-                                EE_Answer::new_instance(
-                                    [
-                                        'ANS_ID'    => 0,
-                                        'QST_ID'    => 0,
-                                        'REG_ID'    => 0,
-                                        'ANS_value' => $answer,
-                                    ]
-                                ),
-                                $q_meta
-                            );
-                            $html .= self::generate_form_input($QFI);
-                        }
-                        $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
-                    }
-                }
-            }
-        }
-        return $html;
-    }
-
-
-    /**
-     * generate_form_input
-     *
-     * @param EE_Question_Form_Input $QFI
-     * @return string HTML
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_form_input(EE_Question_Form_Input $QFI)
-    {
-        if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
-            return '';
-        }
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-
-        $QFI = self::_load_system_dropdowns($QFI);
-        $QFI = self::_load_specialized_dropdowns($QFI);
-
-        // we also need to verify
-
-        $display_text = $QFI->get('QST_display_text');
-        $input_name   = $QFI->get('QST_input_name');
-        $answer       = $request->getRequestParam($input_name, $QFI->get('ANS_value'));
-        $input_id     = $QFI->get('QST_input_id');
-        $input_class  = $QFI->get('QST_input_class');
-        //      $disabled = $QFI->get('QST_disabled') ? ' disabled="disabled"' : '';
-        $disabled          = $QFI->get('QST_disabled');
-        $required_label    = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
-        $QST_required      = $QFI->get('QST_required');
-        $required          =
-            $QST_required
-                ? ['label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required]
-                : [];
-        $use_html_entities = $QFI->get_meta('htmlentities');
-        $required_text     =
-            $QFI->get('QST_required_text') != ''
-                ? $QFI->get('QST_required_text')
-                : esc_html__('This field is required', 'event_espresso');
-        $required_text     = $QST_required
-            ? "\n\t\t\t"
-              . '<div class="required-text hidden">'
-              . self::prep_answer($required_text, $use_html_entities)
-              . '</div>'
-            : '';
-        $label_class       = 'espresso-form-input-lbl';
-        $QST_options       = $QFI->options(true, $answer);
-        $options           = is_array($QST_options) ? self::prep_answer_options($QST_options) : [];
-        $system_ID         = $QFI->get('QST_system');
-        $label_b4          = $QFI->get_meta('label_b4');
-        $use_desc_4_label  = $QFI->get_meta('use_desc_4_label');
-
-
-        switch ($QFI->get('QST_type')) {
-            case 'TEXTAREA':
-                return EEH_Form_Fields::textarea(
-                    $display_text,
-                    $answer,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    [],
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities
-                );
-
-            case 'DROPDOWN':
-                return EEH_Form_Fields::select(
-                    $display_text,
-                    $answer,
-                    $options,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities,
-                    true
-                );
-
-
-            case 'RADIO_BTN':
-                return EEH_Form_Fields::radio(
-                    $display_text,
-                    $answer,
-                    $options,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities,
-                    $label_b4,
-                    $use_desc_4_label
-                );
-
-            case 'CHECKBOX':
-                return EEH_Form_Fields::checkbox(
-                    $display_text,
-                    $answer,
-                    $options,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $label_b4,
-                    $system_ID,
-                    $use_html_entities
-                );
-
-            case 'DATE':
-                return EEH_Form_Fields::datepicker(
-                    $display_text,
-                    $answer,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities
-                );
-
-            case 'TEXT':
-            default:
-                return EEH_Form_Fields::text(
-                    $display_text,
-                    $answer,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities
-                );
-        }
-    }
-
-
-    /**
-     * generates HTML for a form text input
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function text(
-        $question = false,
-        $answer = null,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for a form textarea
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $dimensions  array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function textarea(
-        $question = false,
-        $answer = null,
-        $name = false,
-        $id = '',
-        $class = '',
-        $dimensions = false,
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // make sure $dimensions is an array
-        $dimensions = is_array($dimensions) ? $dimensions : [];
-        // and set some defaults
-        $dimensions = array_merge(['rows' => 3, 'cols' => 40], $dimensions);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
-            . $answer
-            . '</textarea>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for a form select input
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param array  $options     array of answer options where array key = option value and array value = option
-     *                            display text
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function select(
-        $question = false,
-        $answer = null,
-        $options = false,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true,
-        $add_please_select_option = false
-    ) {
-
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer =
-            is_array($answer)
-                ? self::prep_answer(array_shift($answer), $use_html_entities)
-                : self::prep_answer(
-                    $answer,
-                    $use_html_entities
-                );
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
-        // recursively count array elements, to determine total number of options
-        $only_option = count($options, 1) == 1;
-        if (! $only_option) {
-            // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
-            $selected   = $answer === null ? ' selected="selected"' : '';
-            $input_html .= $add_please_select_option
-                ? "\n\t\t\t\t"
-                  . '<option value=""' . $selected . '>'
-                  . esc_html__(' - please select - ', 'event_espresso')
-                  . '</option>'
-                : '';
-        }
-        foreach ($options as $key => $value) {
-            // if value is an array, then create option groups, else create regular ol' options
-            $input_html .= is_array($value)
-                ? self::_generate_select_option_group(
-                    $key,
-                    $value,
-                    $answer,
-                    $use_html_entities
-                )
-                : self::_generate_select_option(
-                    $value->value(),
-                    $value->desc(),
-                    $answer,
-                    $only_option,
-                    $use_html_entities
-                );
-        }
-
-        $input_html .= "\n\t\t\t" . '</select>';
-
-        $input_html =
-            apply_filters(
-                'FHEE__EEH_Form_Fields__select__before_end_wrapper',
-                $input_html,
-                $question,
-                $answer,
-                $name,
-                $id,
-                $class,
-                $system_ID
-            );
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     *  _generate_select_option_group
-     *
-     *  if  $value for a select box is an array, then the key will be used as the optgroup label
-     *  and the value array will be looped thru and the elements sent to _generate_select_option
-     *
-     * @param mixed   $opt_group
-     * @param mixed   $QSOs
-     * @param mixed   $answer
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
-    {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
-        foreach ($QSOs as $QSO) {
-            $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
-        }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
-        return $html;
-    }
-
-
-    /**
-     *  _generate_select_option
-     *
-     * @param mixed   $key
-     * @param mixed   $value
-     * @param mixed   $answer
-     * @param int     $only_option
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option(
-        $key,
-        $value,
-        $answer,
-        $only_option = false,
-        $use_html_entities = true
-    ) {
-        $key      = self::prep_answer($key, $use_html_entities);
-        $value    = self::prep_answer($value, $use_html_entities);
-        $value    = ! empty($value) ? $value : $key;
-        $selected = ($answer == $key || $only_option) ? 'selected="selected"' : '';
-        return "\n\t\t\t\t"
-               . '<option value="' . self::prep_option_value($key) . '" ' . $selected . '> '
-               . $value
-               . '&nbsp;&nbsp;&nbsp;</option>';
-    }
-
-
-    /**
-     * generates HTML for form radio button inputs
-     *
-     * @param bool|string $question    label content
-     * @param string      $answer      form input value attribute
-     * @param array|bool  $options     array of answer options where array key = option value and array value = option
-     *                                 display text
-     * @param bool|string $name        form input name attribute
-     * @param string      $id          form input css id attribute
-     * @param string      $class       form input css class attribute
-     * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                                 required 'class', and required 'msg' attribute
-     * @param string      $required_text
-     * @param string      $label_class css class attribute for the label
-     * @param bool|string $disabled    disabled="disabled" or null
-     * @param bool        $system_ID
-     * @param bool        $use_html_entities
-     * @param bool        $label_b4
-     * @param bool        $use_desc_4_label
-     * @return string HTML
-     */
-    public static function radio(
-        $question = false,
-        $answer = null,
-        $options = false,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true,
-        $label_b4 = false,
-        $use_desc_4_label = false
-    ) {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class       = ! empty($class) ? $class : 'espresso-radio-btn-inp';
-        $extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            if ($OPT instanceof EE_Question_Option) {
-                $value   = self::prep_option_value($OPT->value());
-                $label   = $use_desc_4_label ? $OPT->desc() : $OPT->value();
-                $size    = $use_desc_4_label
-                    ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc())
-                    : self::get_label_size_class($OPT->value());
-                $desc    = $OPT->desc();// no self::prep_answer
-                $answer  = is_numeric($value) && empty($answer) ? 0 : $answer;
-                $checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
-                $opt     = '-' . sanitize_key($value);
-
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'title="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4
-                    ? "\n\t\t\t\t\t\t"
-                      . '<span class="espresso-radio-btn-desc">'
-                      . $label
-                      . '</span>'
-                    : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
-                $input_html .= $use_desc_4_label
-                    ? ''
-                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
-            }
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for form checkbox inputs
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param array  $options     array of options where array key = option value and array value = option display text
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function checkbox(
-        $question = false,
-        $answer = null,
-        $options = false,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $label_b4 = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        $answer = maybe_unserialize($answer);
-
-        // prep the answer(s)
-        $answer = is_array($answer) ? $answer : [sanitize_key($answer) => $answer];
-
-        foreach ($answer as $key => $value) {
-            $key            = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
-        }
-
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class       = empty($class) ? 'espresso-radio-btn-inp' : $class;
-        $extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size  = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
-            $text  = self::prep_answer($OPT->value());
-            $desc  = $OPT->desc();
-            $opt   = '-' . sanitize_key($value);
-
-            $checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
-
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
-                $input_html .= "\n\t\t\t\t\t"
-                               . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'
-                               . $desc
-                               . '</div>';
-            }
-            $input_html .= "\n\t\t\t\t" . '</li>';
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for a form datepicker input
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function datepicker(
-        $question = false,
-        $answer = null,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
-
-        // enqueue scripts
-        wp_register_style(
-            'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('jquery-ui-datepicker');
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     *  remove_label_keep_required_msg
-     *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
-     *
-     * @access public
-     * @return     string
-     */
-    public static function remove_label_keep_required_msg($label_html, $required_text)
-    {
-        return $required_text;
-    }
-
-
-    /**
-     * Simply returns the HTML for a hidden input of the given name and value.
-     *
-     * @param string $name
-     * @param string $value
-     * @return string HTML
-     */
-    public static function hidden_input($name, $value, $id = '')
-    {
-        $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' . $value . '"/>';
-    }
-
-
-    /**
-     * prep_question
-     *
-     * @param string $question
-     * @return string
-     */
-    public static function prep_question($question)
-    {
-        return $question;
-    }
-
-
-    /**
-     *  prep_answer
-     *
-     * @param mixed $answer
-     * @return string
-     */
-    public static function prep_answer($answer, $use_html_entities = true)
-    {
-        // make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired,
-        // we want "0".
-        if (is_bool($answer)) {
-            $answer = $answer ? 1 : 0;
-        }
-        $answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
-        return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
-    }
-
-
-    /**
-     *  prep_answer_options
-     *
-     * @param array $QSOs array of EE_Question_Option objects
-     * @return array
-     */
-    public static function prep_answer_options($QSOs = [])
-    {
-        $prepped_answer_options = [];
-        if (is_array($QSOs) && ! empty($QSOs)) {
-            foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
-                    $QSO = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value' => is_array($QSO) && isset($QSO['id'])
-                                ? (string) $QSO['id']
-                                : (string) $key,
-                            'QSO_desc'  => is_array($QSO) && isset($QSO['text'])
-                                ? (string) $QSO['text']
-                                : (string) $QSO,
-                        ]
-                    );
-                }
-                if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
-                } else {
-                    $prepped_answer_options[] = $QSO;
-                }
-            }
-        }
-        //      d( $prepped_answer_options );
-        return $prepped_answer_options;
-    }
-
-
-    /**
-     *  prep_option_value
-     *
-     * @param string $option_value
-     * @return string
-     */
-    public static function prep_option_value($option_value)
-    {
-        return esc_attr(trim(stripslashes($option_value)));
-    }
-
-
-    /**
-     *  prep_required
-     *
-     * @param string|array $required
-     * @return array
-     */
-    public static function prep_required($required = [])
-    {
-        // make sure required is an array
-        $required = is_array($required) ? $required : [];
-        // and set some defaults
-        return array_merge(['label' => '', 'class' => '', 'msg' => ''], $required);
-    }
-
-
-    /**
-     *  get_label_size_class
-     *
-     * @param string $value
-     * @return string
-     */
-    public static function get_label_size_class($value = false)
-    {
-        if ($value === false || $value === '') {
-            return ' class="medium-lbl"';
-        }
-        // determine length of option value
-        $val_size = strlen($value);
-        switch ($val_size) {
-            case $val_size < 3:
-                $size = ' class="nano-lbl"';
-                break;
-            case $val_size < 6:
-                $size = ' class="micro-lbl"';
-                break;
-            case $val_size < 12:
-                $size = ' class="tiny-lbl"';
-                break;
-            case $val_size < 25:
-                $size = ' class="small-lbl"';
-                break;
-            case $val_size > 100:
-                $size = ' class="big-lbl"';
-                break;
-            default:
-                $size = ' class="medium-lbl"';
-                break;
-        }
-        return $size;
-    }
-
-
-    /**
-     *  _load_system_dropdowns
-     *
-     * @param EE_Question_Form_Input $QFI
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private static function _load_system_dropdowns($QFI)
-    {
-        $QST_system = $QFI->get('QST_system');
-        switch ($QST_system) {
-            case 'state':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'country':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-            case 'admin-state':
-                $QFI = self::generate_state_dropdown($QFI, true);
-                break;
-            case 'admin-country':
-                $QFI = self::generate_country_dropdown($QFI, true);
-                break;
-        }
-        return $QFI;
-    }
-
-
-    /**
-     * This preps dropdowns that are specialized.
-     *
-     * @param EE_Question_Form_Input $QFI
-     *
-     * @return EE_Question_Form_Input
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since  4.6.0
-     */
-    protected static function _load_specialized_dropdowns($QFI)
-    {
-        switch ($QFI->get('QST_type')) {
-            case 'STATE':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'COUNTRY':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-        }
-        return $QFI;
-    }
-
-
-    /**
-     *    generate_state_dropdown
-     *
-     * @param EE_Question_Form_Input $QST
-     * @param bool                   $get_all
-     * @return EE_Question_Form_Input
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_state_dropdown($QST, $get_all = false)
-    {
-        $states = $get_all
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_states_of_active_countries();
-        if ($states && count($states) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // if multiple countries, we'll create option groups within the dropdown
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $QSO = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value'   => $state->ID(),
-                            'QSO_desc'    => $state->name(),
-                            'QST_ID'      => $QST->get('QST_ID'),
-                            'QSO_deleted' => false,
-                        ]
-                    );
-                    // set option group
-                    $QSO->set_opt_group($state->country()->name());
-                    // add option to question
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-    /**
-     *    generate_country_dropdown
-     *
-     * @param      $QST
-     * @param bool $get_all
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @internal param array $question
-     */
-    public static function generate_country_dropdown($QST, $get_all = false)
-    {
-        $countries = $get_all
-            ? EEM_Country::instance()->get_all_countries()
-            : EEM_Country::instance()->get_all_active_countries();
-        if ($countries && count($countries) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // now add countries
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $QSO = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value'   => $country->ID(),
-                            'QSO_desc'    => $country->name(),
-                            'QST_ID'      => $QST->get('QST_ID'),
-                            'QSO_deleted' => false,
-                        ]
-                    );
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-    /**
-     *  generates options for a month dropdown selector with numbers from 01 to 12
-     *
-     * @return array()
-     */
-    public static function two_digit_months_dropdown_options()
-    {
-        $options = [];
-        for ($x = 1; $x <= 12; $x++) {
-            $mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $mm ] = $mm;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-    /**
-     *  generates a year dropdown selector with numbers for the next ten years
-     *
-     * @return array
-     */
-    public static function next_decade_two_digit_year_dropdown_options()
-    {
-        $options      = [];
-        $current_year = date('y');
-        $next_decade  = $current_year + 10;
-        for ($x = $current_year; $x <= $next_decade; $x++) {
-            $yy             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $yy ] = $yy;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-    /**
-     * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for
-     * list table filter.
-     *
-     * @param string  $cur_date     any currently selected date can be entered here.
-     * @param string  $status       Registration status
-     * @param integer $evt_category Event Category ID if the Event Category filter is selected
-     * @return string                html
-     * @throws EE_Error
-     */
-    public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
-    {
-        $_where = [];
-        if (! empty($status)) {
-            $_where['STS_ID'] = $status;
-        }
-
-        if ($evt_category > 0) {
-            $_where['Event.Term_Taxonomy.term_id'] = $evt_category;
-        }
-
-        $regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
-
-        // setup vals for select input helper
-        $options = [
-            0 => [
-                'text' => esc_html__('Select a Month/Year', 'event_espresso'),
-                'id'   => '',
-            ],
-        ];
-
-        foreach ($regdtts as $regdtt) {
-            $date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
-            $options[] = [
-                'text' => $date,
-                'id'   => $date,
-            ];
-        }
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-    /**
-     * generates a month/year dropdown selector for all events matching the given criteria
-     * Typically used for list table filter
-     *
-     * @param string $cur_date          any currently selected date can be entered here.
-     * @param string $status            "view" (i.e. all, today, month, draft)
-     * @param int    $evt_category      category event belongs to
-     * @param string $evt_active_status "upcoming", "expired", "active", or "inactive"
-     * @return string                    html
-     * @throws EE_Error
-     */
-    public static function generate_event_months_dropdown(
-        $cur_date = '',
-        $status = null,
-        $evt_category = null,
-        $evt_active_status = null
-    ) {
-        // determine what post_status our condition will have for the query.
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                $where['Event.status'] = ['NOT IN', ['trash']];
-                break;
-            case 'draft':
-                $where['Event.status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['Event.status'] = $status;
-        }
-
-        // phpcs:enable
-
-        // categories?
-
-
-        if (! empty($evt_category)) {
-            $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Event.Term_Taxonomy.term_id']  = $evt_category;
-        }
-
-
-        //      $where['DTT_is_primary'] = 1;
-
-        $DTTS = EEM_Datetime::instance()->get_dtt_months_and_years($where, $evt_active_status);
-
-        // let's setup vals for select input helper
-        $options = [
-            0 => [
-                'text' => esc_html__('Select a Month/Year', 'event_espresso'),
-                'id'   => "",
-            ],
-        ];
-
-
-        // translate month and date
-        global $wp_locale;
-
-        foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id             = $DTT->dtt_month . ' ' . $DTT->dtt_year;
-            $options[]      = [
-                'text' => $localized_date,
-                'id'   => $id,
-            ];
-        }
-
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-    /**
-     * generates the dropdown selector for event categories
-     * typically used as a filter on list tables.
-     *
-     * @param integer $current_cat currently selected category
-     * @return string               html for dropdown
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_event_category_dropdown($current_cat = -1)
-    {
-        $categories = EEM_Term::instance()->get_all_ee_categories(true);
-        $options    = [
-            '0' => [
-                'text' => esc_html__('All Categories', 'event_espresso'),
-                'id'   => -1,
-            ],
-        ];
-
-        // setup categories for dropdown
-        foreach ($categories as $category) {
-            $options[] = [
-                'text' => $category->get('name'),
-                'id'   => $category->ID(),
-            ];
-        }
-
-        return self::select_input('EVT_CAT', $options, $current_cat);
-    }
-
-
-    /**
-     *    generate a submit button with or without it's own microform
-     *    this is the only way to create buttons that are compatible across all themes
-     *
-     * @access    public
-     * @param string      $url              - the form action
-     * @param string      $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm"
-     *                                      for the form
-     * @param string      $class            - css classes (separated by spaces if more than one)
-     * @param string      $text             - what appears on the button
-     * @param string      $nonce_action     - if using nonces
-     * @param bool|string $input_only       - whether to print form header and footer. TRUE returns the input without
-     *                                      the form
-     * @param string      $extra_attributes - any extra attributes that need to be attached to the form input
-     * @return    string
-     */
-    public static function submit_button(
-        $url = '',
-        $ID = '',
-        $class = '',
-        $text = '',
-        $nonce_action = '',
-        $input_only = false,
-        $extra_attributes = ''
-    ) {
-        $btn = '';
-        if (empty($url) || empty($ID)) {
-            return $btn;
-        }
-        $text = ! empty($text) ? $text : esc_html__('Submit', 'event_espresso');
-        $btn  .= '<input id="' . $ID . '-btn" class="' . $class . '" '
-                 . 'type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
-            $btn_frm .= ! empty($nonce_action)
-                ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false)
-                : '';
-            $btn_frm .= $btn;
-            $btn_frm .= '</form>';
-            $btn     = $btn_frm;
-            unset($btn_frm);
-        }
-        return $btn;
-    }
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param int    $rows
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @param array  $wp_editor_args
+	 * @return false|string
+	 * @since   4.10.14.p
+	 */
+	private static function adminWpEditor($class, $id, $name, $rows, $tab_index, $value, $wp_editor_args = [])
+	{
+		$editor_settings = $wp_editor_args + [
+				'textarea_name' => esc_attr($name),
+				'textarea_rows' => absint($rows),
+				'editor_class'  => esc_attr($class),
+				'tabindex'      => absint($tab_index),
+			];
+		ob_start();
+		wp_editor($value, esc_attr($id), $editor_settings);
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * espresso admin page select_input
+	 * Turns an array into a select fields
+	 *
+	 * @static
+	 * @access public
+	 * @param string  $name       field name
+	 * @param array   $values     option values, numbered array starting at 0, where each value is an array with a key
+	 *                            'text' (meaning text to display' and 'id' (meaning the internal value) eg:
+	 *                            array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or
+	 *                            as an array of key-value pairs, where the key is to be used for the select input's
+	 *                            name, and the value will be the text shown to the user.  Optionally you can also
+	 *                            include an additional key of "class" which will add a specific class to the option
+	 *                            for that value.
+	 * @param string  $default    default value
+	 * @param string  $parameters extra parameters
+	 * @param string  $class      css class
+	 * @param boolean $autosize   whether to autosize the select or not
+	 * @return string              html string for the select input
+	 */
+	public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
+	{
+		// if $values was submitted in the wrong format, convert it over
+		if (! empty($values) && (! array_key_exists(0, $values) || ! is_array($values[0]))) {
+			$converted_values = [];
+			foreach ($values as $id => $text) {
+				$converted_values[] = ['id' => $id, 'text' => $text];
+			}
+			$values = $converted_values;
+		}
+
+		$field =
+			'<select id="' . EEH_Formatter::ee_tep_output_string($name)
+			. '" name="' . EEH_Formatter::ee_tep_output_string($name)
+			. '"';
+
+		if (EEH_Formatter::ee_tep_not_null($parameters)) {
+			$field .= ' ' . $parameters;
+		}
+		if ($autosize) {
+			$size = 'med';
+			for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
+				if ($values[ $ii ]['text']) {
+					if (strlen($values[ $ii ]['text']) > 5) {
+						$size = 'wide';
+					}
+				}
+			}
+		} else {
+			$size = '';
+		}
+
+		$field .= ' class="' . $class . ' ' . $size . '">';
+
+		if (empty($default) && isset($GLOBALS[ $name ])) {
+			$default = stripslashes($GLOBALS[ $name ]);
+		}
+
+
+		for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
+			$field .= '<option value="' . $values[ $i ]['id'] . '"';
+			if ($default == $values[ $i ]['id']) {
+				$field .= ' selected = "selected"';
+			}
+			if (isset($values[ $i ]['class'])) {
+				$field .= ' class="' . $values[ $i ]['class'] . '"';
+			}
+			$field .= '>' . $values[ $i ]['text'] . '</option>';
+		}
+		$field .= '</select>';
+
+		return $field;
+	}
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param array  $question_groups
+	 * @param string $group_wrapper
+	 * @return string HTML
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_groups_html($question_groups = [], $group_wrapper = 'fieldset')
+	{
+
+		$html                            = '';
+		$before_question_group_questions =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions  =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		if (! empty($question_groups)) {
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				// check that questions exist
+				if (! empty($QSG['QSG_questions'])) {
+					// use fieldsets
+					$html .= "\n\t"
+							 . '<'
+							 . $group_wrapper
+							 . ' class="espresso-question-group-wrap" id="'
+							 . $QSG['QSG_identifier']
+							 . '">';
+					// group_name
+					$html .= $QSG['QSG_show_group_name']
+						? "\n\t\t"
+						  . '<h5 class="espresso-question-group-title-h5 section-title">'
+						  . self::prep_answer($QSG['QSG_name'])
+						  . '</h5>'
+						: '';
+					// group_desc
+					$html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc'])
+						? '<div class="espresso-question-group-desc-pg">'
+						  . self::prep_answer($QSG['QSG_desc'])
+						  . '</div>'
+						: '';
+
+					$html .= $before_question_group_questions;
+					// loop thru questions
+					foreach ($QSG['QSG_questions'] as $question) {
+						$QFI  = new EE_Question_Form_Input(
+							$question['qst_obj'],
+							$question['ans_obj'],
+							$question
+						);
+						$html .= self::generate_form_input($QFI);
+					}
+					$html .= $after_question_group_questions;
+					$html .= "\n\t" . '</' . $group_wrapper . '>';
+				}
+			}
+		}
+
+		return $html;
+	}
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param array  $question_groups
+	 * @param array  $q_meta
+	 * @param bool   $from_admin
+	 * @param string $group_wrapper
+	 * @return string HTML
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_groups_html2(
+		$question_groups = [],
+		$q_meta = [],
+		$from_admin = false,
+		$group_wrapper = 'fieldset'
+	) {
+
+		$html                            = '';
+		$before_question_group_questions =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions  =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		$default_q_meta = [
+			'att_nmbr'    => 1,
+			'ticket_id'   => '',
+			'input_name'  => '',
+			'input_id'    => '',
+			'input_class' => '',
+		];
+		$q_meta         = array_merge($default_q_meta, $q_meta);
+
+		if (! empty($question_groups)) {
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				if ($QSG instanceof EE_Question_Group) {
+					// check that questions exist
+
+					$where = ['QST_deleted' => 0];
+					if (! $from_admin) {
+						$where['QST_admin_only'] = 0;
+					}
+					$questions =
+						$QSG->questions([$where, 'order_by' => ['Question_Group_Question.QGQ_order' => 'ASC']]);
+					if (! empty($questions)) {
+						// use fieldsets
+						$html .= "\n\t"
+								 . '<' . $group_wrapper . ' class="espresso-question-group-wrap" '
+								 . 'id="' . $QSG->get('QSG_identifier') . '">';
+						// group_name
+						if ($QSG->show_group_name()) {
+							$html .= "\n\t\t"
+									 . '<h5 class="espresso-question-group-title-h5 section-title">'
+									 . $QSG->get_pretty('QSG_name')
+									 . '</h5>';
+						}
+						// group_desc
+						if ($QSG->show_group_desc()) {
+							$html .= '<div class="espresso-question-group-desc-pg">'
+									 . $QSG->get_pretty('QSG_desc')
+									 . '</div>';
+						}
+
+						$html .= $before_question_group_questions;
+						// loop thru questions
+						foreach ($questions as $QST) {
+							$qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
+
+							$answer = null;
+
+							/** @var RequestInterface $request */
+							$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+							$request_qstn = $request->getRequestParam('qstn', [], 'string', true);
+							if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+								// check for answer in $request_qstn in case we are reprocessing a form after an error
+								if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
+									$answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
+										? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
+										: sanitize_text_field($request_qstn[ $q_meta['input_id'] ][ $qstn_id ]);
+								}
+							} elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
+								// attendee data from the session
+								$answer =
+									isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+							}
+
+
+							$QFI  = new EE_Question_Form_Input(
+								$QST,
+								EE_Answer::new_instance(
+									[
+										'ANS_ID'    => 0,
+										'QST_ID'    => 0,
+										'REG_ID'    => 0,
+										'ANS_value' => $answer,
+									]
+								),
+								$q_meta
+							);
+							$html .= self::generate_form_input($QFI);
+						}
+						$html .= $after_question_group_questions;
+						$html .= "\n\t" . '</' . $group_wrapper . '>';
+					}
+				}
+			}
+		}
+		return $html;
+	}
+
+
+	/**
+	 * generate_form_input
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 * @return string HTML
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_form_input(EE_Question_Form_Input $QFI)
+	{
+		if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
+			return '';
+		}
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+
+		$QFI = self::_load_system_dropdowns($QFI);
+		$QFI = self::_load_specialized_dropdowns($QFI);
+
+		// we also need to verify
+
+		$display_text = $QFI->get('QST_display_text');
+		$input_name   = $QFI->get('QST_input_name');
+		$answer       = $request->getRequestParam($input_name, $QFI->get('ANS_value'));
+		$input_id     = $QFI->get('QST_input_id');
+		$input_class  = $QFI->get('QST_input_class');
+		//      $disabled = $QFI->get('QST_disabled') ? ' disabled="disabled"' : '';
+		$disabled          = $QFI->get('QST_disabled');
+		$required_label    = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
+		$QST_required      = $QFI->get('QST_required');
+		$required          =
+			$QST_required
+				? ['label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required]
+				: [];
+		$use_html_entities = $QFI->get_meta('htmlentities');
+		$required_text     =
+			$QFI->get('QST_required_text') != ''
+				? $QFI->get('QST_required_text')
+				: esc_html__('This field is required', 'event_espresso');
+		$required_text     = $QST_required
+			? "\n\t\t\t"
+			  . '<div class="required-text hidden">'
+			  . self::prep_answer($required_text, $use_html_entities)
+			  . '</div>'
+			: '';
+		$label_class       = 'espresso-form-input-lbl';
+		$QST_options       = $QFI->options(true, $answer);
+		$options           = is_array($QST_options) ? self::prep_answer_options($QST_options) : [];
+		$system_ID         = $QFI->get('QST_system');
+		$label_b4          = $QFI->get_meta('label_b4');
+		$use_desc_4_label  = $QFI->get_meta('use_desc_4_label');
+
+
+		switch ($QFI->get('QST_type')) {
+			case 'TEXTAREA':
+				return EEH_Form_Fields::textarea(
+					$display_text,
+					$answer,
+					$input_name,
+					$input_id,
+					$input_class,
+					[],
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities
+				);
+
+			case 'DROPDOWN':
+				return EEH_Form_Fields::select(
+					$display_text,
+					$answer,
+					$options,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities,
+					true
+				);
+
+
+			case 'RADIO_BTN':
+				return EEH_Form_Fields::radio(
+					$display_text,
+					$answer,
+					$options,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities,
+					$label_b4,
+					$use_desc_4_label
+				);
+
+			case 'CHECKBOX':
+				return EEH_Form_Fields::checkbox(
+					$display_text,
+					$answer,
+					$options,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$label_b4,
+					$system_ID,
+					$use_html_entities
+				);
+
+			case 'DATE':
+				return EEH_Form_Fields::datepicker(
+					$display_text,
+					$answer,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities
+				);
+
+			case 'TEXT':
+			default:
+				return EEH_Form_Fields::text(
+					$display_text,
+					$answer,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities
+				);
+		}
+	}
+
+
+	/**
+	 * generates HTML for a form text input
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function text(
+		$question = false,
+		$answer = null,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<input type="text" name="' . $name . '" id="' . $id . '" '
+			. 'class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  '
+			. 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for a form textarea
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $dimensions  array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function textarea(
+		$question = false,
+		$answer = null,
+		$name = false,
+		$id = '',
+		$class = '',
+		$dimensions = false,
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// make sure $dimensions is an array
+		$dimensions = is_array($dimensions) ? $dimensions : [];
+		// and set some defaults
+		$dimensions = array_merge(['rows' => 3, 'cols' => 40], $dimensions);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
+			. 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
+			. 'title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+			. $answer
+			. '</textarea>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for a form select input
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param array  $options     array of answer options where array key = option value and array value = option
+	 *                            display text
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function select(
+		$question = false,
+		$answer = null,
+		$options = false,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true,
+		$add_please_select_option = false
+	) {
+
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer =
+			is_array($answer)
+				? self::prep_answer(array_shift($answer), $use_html_entities)
+				: self::prep_answer(
+					$answer,
+					$use_html_entities
+				);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
+			. 'title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+		// recursively count array elements, to determine total number of options
+		$only_option = count($options, 1) == 1;
+		if (! $only_option) {
+			// if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
+			$selected   = $answer === null ? ' selected="selected"' : '';
+			$input_html .= $add_please_select_option
+				? "\n\t\t\t\t"
+				  . '<option value=""' . $selected . '>'
+				  . esc_html__(' - please select - ', 'event_espresso')
+				  . '</option>'
+				: '';
+		}
+		foreach ($options as $key => $value) {
+			// if value is an array, then create option groups, else create regular ol' options
+			$input_html .= is_array($value)
+				? self::_generate_select_option_group(
+					$key,
+					$value,
+					$answer,
+					$use_html_entities
+				)
+				: self::_generate_select_option(
+					$value->value(),
+					$value->desc(),
+					$answer,
+					$only_option,
+					$use_html_entities
+				);
+		}
+
+		$input_html .= "\n\t\t\t" . '</select>';
+
+		$input_html =
+			apply_filters(
+				'FHEE__EEH_Form_Fields__select__before_end_wrapper',
+				$input_html,
+				$question,
+				$answer,
+				$name,
+				$id,
+				$class,
+				$system_ID
+			);
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 *  _generate_select_option_group
+	 *
+	 *  if  $value for a select box is an array, then the key will be used as the optgroup label
+	 *  and the value array will be looped thru and the elements sent to _generate_select_option
+	 *
+	 * @param mixed   $opt_group
+	 * @param mixed   $QSOs
+	 * @param mixed   $answer
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
+	{
+		$html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+		foreach ($QSOs as $QSO) {
+			$html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
+		}
+		$html .= "\n\t\t\t\t" . '</optgroup>';
+		return $html;
+	}
+
+
+	/**
+	 *  _generate_select_option
+	 *
+	 * @param mixed   $key
+	 * @param mixed   $value
+	 * @param mixed   $answer
+	 * @param int     $only_option
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option(
+		$key,
+		$value,
+		$answer,
+		$only_option = false,
+		$use_html_entities = true
+	) {
+		$key      = self::prep_answer($key, $use_html_entities);
+		$value    = self::prep_answer($value, $use_html_entities);
+		$value    = ! empty($value) ? $value : $key;
+		$selected = ($answer == $key || $only_option) ? 'selected="selected"' : '';
+		return "\n\t\t\t\t"
+			   . '<option value="' . self::prep_option_value($key) . '" ' . $selected . '> '
+			   . $value
+			   . '&nbsp;&nbsp;&nbsp;</option>';
+	}
+
+
+	/**
+	 * generates HTML for form radio button inputs
+	 *
+	 * @param bool|string $question    label content
+	 * @param string      $answer      form input value attribute
+	 * @param array|bool  $options     array of answer options where array key = option value and array value = option
+	 *                                 display text
+	 * @param bool|string $name        form input name attribute
+	 * @param string      $id          form input css id attribute
+	 * @param string      $class       form input css class attribute
+	 * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                                 required 'class', and required 'msg' attribute
+	 * @param string      $required_text
+	 * @param string      $label_class css class attribute for the label
+	 * @param bool|string $disabled    disabled="disabled" or null
+	 * @param bool        $system_ID
+	 * @param bool        $use_html_entities
+	 * @param bool        $label_b4
+	 * @param bool        $use_desc_4_label
+	 * @return string HTML
+	 */
+	public static function radio(
+		$question = false,
+		$answer = null,
+		$options = false,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true,
+		$label_b4 = false,
+		$use_desc_4_label = false
+	) {
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class       = ! empty($class) ? $class : 'espresso-radio-btn-inp';
+		$extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			if ($OPT instanceof EE_Question_Option) {
+				$value   = self::prep_option_value($OPT->value());
+				$label   = $use_desc_4_label ? $OPT->desc() : $OPT->value();
+				$size    = $use_desc_4_label
+					? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc())
+					: self::get_label_size_class($OPT->value());
+				$desc    = $OPT->desc();// no self::prep_answer
+				$answer  = is_numeric($value) && empty($answer) ? 0 : $answer;
+				$checked = (string) $value == (string) $answer ? ' checked="checked"' : '';
+				$opt     = '-' . sanitize_key($value);
+
+				$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+				$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
+				$input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
+				$input_html .= "\n\t\t\t\t\t\t"
+							   . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
+							   . 'class="' . $class . '" value="' . $value . '" '
+							   . 'title="' . esc_attr($required['msg']) . '" ' . $disabled
+							   . $checked . ' ' . $extra . '/>';
+				$input_html .= ! $label_b4
+					? "\n\t\t\t\t\t\t"
+					  . '<span class="espresso-radio-btn-desc">'
+					  . $label
+					  . '</span>'
+					: '';
+				$input_html .= "\n\t\t\t\t\t" . '</label>';
+				$input_html .= $use_desc_4_label
+					? ''
+					: '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
+				$input_html .= "\n\t\t\t\t" . '</li>';
+			}
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for form checkbox inputs
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param array  $options     array of options where array key = option value and array value = option display text
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function checkbox(
+		$question = false,
+		$answer = null,
+		$options = false,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$label_b4 = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		$answer = maybe_unserialize($answer);
+
+		// prep the answer(s)
+		$answer = is_array($answer) ? $answer : [sanitize_key($answer) => $answer];
+
+		foreach ($answer as $key => $value) {
+			$key            = self::prep_option_value($key);
+			$answer[ $key ] = self::prep_answer($value, $use_html_entities);
+		}
+
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class       = empty($class) ? 'espresso-radio-btn-inp' : $class;
+		$extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			$value = $OPT->value();// self::prep_option_value( $OPT->value() );
+			$size  = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+			$text  = self::prep_answer($OPT->value());
+			$desc  = $OPT->desc();
+			$opt   = '-' . sanitize_key($value);
+
+			$checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : '';
+
+			$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+			$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
+			$input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t\t"
+						   . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
+						   . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
+						   . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+			$input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t" . '</label>';
+			if (! empty($desc) && $desc != $text) {
+				$input_html .= "\n\t\t\t\t\t"
+							   . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'
+							   . $desc
+							   . '</div>';
+			}
+			$input_html .= "\n\t\t\t\t" . '</li>';
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for a form datepicker input
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function datepicker(
+		$question = false,
+		$answer = null,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<input type="text" name="' . $name . '" id="' . $id . '" '
+			. 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
+			. 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+
+		// enqueue scripts
+		wp_register_style(
+			'espresso-ui-theme',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('jquery-ui-datepicker');
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 *  remove_label_keep_required_msg
+	 *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
+	 *
+	 * @access public
+	 * @return     string
+	 */
+	public static function remove_label_keep_required_msg($label_html, $required_text)
+	{
+		return $required_text;
+	}
+
+
+	/**
+	 * Simply returns the HTML for a hidden input of the given name and value.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @return string HTML
+	 */
+	public static function hidden_input($name, $value, $id = '')
+	{
+		$id = ! empty($id) ? $id : $name;
+		return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' . $value . '"/>';
+	}
+
+
+	/**
+	 * prep_question
+	 *
+	 * @param string $question
+	 * @return string
+	 */
+	public static function prep_question($question)
+	{
+		return $question;
+	}
+
+
+	/**
+	 *  prep_answer
+	 *
+	 * @param mixed $answer
+	 * @return string
+	 */
+	public static function prep_answer($answer, $use_html_entities = true)
+	{
+		// make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired,
+		// we want "0".
+		if (is_bool($answer)) {
+			$answer = $answer ? 1 : 0;
+		}
+		$answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
+		return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
+	}
+
+
+	/**
+	 *  prep_answer_options
+	 *
+	 * @param array $QSOs array of EE_Question_Option objects
+	 * @return array
+	 */
+	public static function prep_answer_options($QSOs = [])
+	{
+		$prepped_answer_options = [];
+		if (is_array($QSOs) && ! empty($QSOs)) {
+			foreach ($QSOs as $key => $QSO) {
+				if (! $QSO instanceof EE_Question_Option) {
+					$QSO = EE_Question_Option::new_instance(
+						[
+							'QSO_value' => is_array($QSO) && isset($QSO['id'])
+								? (string) $QSO['id']
+								: (string) $key,
+							'QSO_desc'  => is_array($QSO) && isset($QSO['text'])
+								? (string) $QSO['text']
+								: (string) $QSO,
+						]
+					);
+				}
+				if ($QSO->opt_group()) {
+					$prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+				} else {
+					$prepped_answer_options[] = $QSO;
+				}
+			}
+		}
+		//      d( $prepped_answer_options );
+		return $prepped_answer_options;
+	}
+
+
+	/**
+	 *  prep_option_value
+	 *
+	 * @param string $option_value
+	 * @return string
+	 */
+	public static function prep_option_value($option_value)
+	{
+		return esc_attr(trim(stripslashes($option_value)));
+	}
+
+
+	/**
+	 *  prep_required
+	 *
+	 * @param string|array $required
+	 * @return array
+	 */
+	public static function prep_required($required = [])
+	{
+		// make sure required is an array
+		$required = is_array($required) ? $required : [];
+		// and set some defaults
+		return array_merge(['label' => '', 'class' => '', 'msg' => ''], $required);
+	}
+
+
+	/**
+	 *  get_label_size_class
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public static function get_label_size_class($value = false)
+	{
+		if ($value === false || $value === '') {
+			return ' class="medium-lbl"';
+		}
+		// determine length of option value
+		$val_size = strlen($value);
+		switch ($val_size) {
+			case $val_size < 3:
+				$size = ' class="nano-lbl"';
+				break;
+			case $val_size < 6:
+				$size = ' class="micro-lbl"';
+				break;
+			case $val_size < 12:
+				$size = ' class="tiny-lbl"';
+				break;
+			case $val_size < 25:
+				$size = ' class="small-lbl"';
+				break;
+			case $val_size > 100:
+				$size = ' class="big-lbl"';
+				break;
+			default:
+				$size = ' class="medium-lbl"';
+				break;
+		}
+		return $size;
+	}
+
+
+	/**
+	 *  _load_system_dropdowns
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private static function _load_system_dropdowns($QFI)
+	{
+		$QST_system = $QFI->get('QST_system');
+		switch ($QST_system) {
+			case 'state':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'country':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+			case 'admin-state':
+				$QFI = self::generate_state_dropdown($QFI, true);
+				break;
+			case 'admin-country':
+				$QFI = self::generate_country_dropdown($QFI, true);
+				break;
+		}
+		return $QFI;
+	}
+
+
+	/**
+	 * This preps dropdowns that are specialized.
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 *
+	 * @return EE_Question_Form_Input
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since  4.6.0
+	 */
+	protected static function _load_specialized_dropdowns($QFI)
+	{
+		switch ($QFI->get('QST_type')) {
+			case 'STATE':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'COUNTRY':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+		}
+		return $QFI;
+	}
+
+
+	/**
+	 *    generate_state_dropdown
+	 *
+	 * @param EE_Question_Form_Input $QST
+	 * @param bool                   $get_all
+	 * @return EE_Question_Form_Input
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_state_dropdown($QST, $get_all = false)
+	{
+		$states = $get_all
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_states_of_active_countries();
+		if ($states && count($states) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// if multiple countries, we'll create option groups within the dropdown
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$QSO = EE_Question_Option::new_instance(
+						[
+							'QSO_value'   => $state->ID(),
+							'QSO_desc'    => $state->name(),
+							'QST_ID'      => $QST->get('QST_ID'),
+							'QSO_deleted' => false,
+						]
+					);
+					// set option group
+					$QSO->set_opt_group($state->country()->name());
+					// add option to question
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+	/**
+	 *    generate_country_dropdown
+	 *
+	 * @param      $QST
+	 * @param bool $get_all
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @internal param array $question
+	 */
+	public static function generate_country_dropdown($QST, $get_all = false)
+	{
+		$countries = $get_all
+			? EEM_Country::instance()->get_all_countries()
+			: EEM_Country::instance()->get_all_active_countries();
+		if ($countries && count($countries) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// now add countries
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$QSO = EE_Question_Option::new_instance(
+						[
+							'QSO_value'   => $country->ID(),
+							'QSO_desc'    => $country->name(),
+							'QST_ID'      => $QST->get('QST_ID'),
+							'QSO_deleted' => false,
+						]
+					);
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+	/**
+	 *  generates options for a month dropdown selector with numbers from 01 to 12
+	 *
+	 * @return array()
+	 */
+	public static function two_digit_months_dropdown_options()
+	{
+		$options = [];
+		for ($x = 1; $x <= 12; $x++) {
+			$mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ $mm ] = $mm;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+	/**
+	 *  generates a year dropdown selector with numbers for the next ten years
+	 *
+	 * @return array
+	 */
+	public static function next_decade_two_digit_year_dropdown_options()
+	{
+		$options      = [];
+		$current_year = date('y');
+		$next_decade  = $current_year + 10;
+		for ($x = $current_year; $x <= $next_decade; $x++) {
+			$yy             = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ $yy ] = $yy;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+	/**
+	 * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for
+	 * list table filter.
+	 *
+	 * @param string  $cur_date     any currently selected date can be entered here.
+	 * @param string  $status       Registration status
+	 * @param integer $evt_category Event Category ID if the Event Category filter is selected
+	 * @return string                html
+	 * @throws EE_Error
+	 */
+	public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
+	{
+		$_where = [];
+		if (! empty($status)) {
+			$_where['STS_ID'] = $status;
+		}
+
+		if ($evt_category > 0) {
+			$_where['Event.Term_Taxonomy.term_id'] = $evt_category;
+		}
+
+		$regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
+
+		// setup vals for select input helper
+		$options = [
+			0 => [
+				'text' => esc_html__('Select a Month/Year', 'event_espresso'),
+				'id'   => '',
+			],
+		];
+
+		foreach ($regdtts as $regdtt) {
+			$date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+			$options[] = [
+				'text' => $date,
+				'id'   => $date,
+			];
+		}
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+	/**
+	 * generates a month/year dropdown selector for all events matching the given criteria
+	 * Typically used for list table filter
+	 *
+	 * @param string $cur_date          any currently selected date can be entered here.
+	 * @param string $status            "view" (i.e. all, today, month, draft)
+	 * @param int    $evt_category      category event belongs to
+	 * @param string $evt_active_status "upcoming", "expired", "active", or "inactive"
+	 * @return string                    html
+	 * @throws EE_Error
+	 */
+	public static function generate_event_months_dropdown(
+		$cur_date = '',
+		$status = null,
+		$evt_category = null,
+		$evt_active_status = null
+	) {
+		// determine what post_status our condition will have for the query.
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				$where['Event.status'] = ['NOT IN', ['trash']];
+				break;
+			case 'draft':
+				$where['Event.status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['Event.status'] = $status;
+		}
+
+		// phpcs:enable
+
+		// categories?
+
+
+		if (! empty($evt_category)) {
+			$where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Event.Term_Taxonomy.term_id']  = $evt_category;
+		}
+
+
+		//      $where['DTT_is_primary'] = 1;
+
+		$DTTS = EEM_Datetime::instance()->get_dtt_months_and_years($where, $evt_active_status);
+
+		// let's setup vals for select input helper
+		$options = [
+			0 => [
+				'text' => esc_html__('Select a Month/Year', 'event_espresso'),
+				'id'   => "",
+			],
+		];
+
+
+		// translate month and date
+		global $wp_locale;
+
+		foreach ($DTTS as $DTT) {
+			$localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
+			$id             = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+			$options[]      = [
+				'text' => $localized_date,
+				'id'   => $id,
+			];
+		}
+
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+	/**
+	 * generates the dropdown selector for event categories
+	 * typically used as a filter on list tables.
+	 *
+	 * @param integer $current_cat currently selected category
+	 * @return string               html for dropdown
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_event_category_dropdown($current_cat = -1)
+	{
+		$categories = EEM_Term::instance()->get_all_ee_categories(true);
+		$options    = [
+			'0' => [
+				'text' => esc_html__('All Categories', 'event_espresso'),
+				'id'   => -1,
+			],
+		];
+
+		// setup categories for dropdown
+		foreach ($categories as $category) {
+			$options[] = [
+				'text' => $category->get('name'),
+				'id'   => $category->ID(),
+			];
+		}
+
+		return self::select_input('EVT_CAT', $options, $current_cat);
+	}
+
+
+	/**
+	 *    generate a submit button with or without it's own microform
+	 *    this is the only way to create buttons that are compatible across all themes
+	 *
+	 * @access    public
+	 * @param string      $url              - the form action
+	 * @param string      $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm"
+	 *                                      for the form
+	 * @param string      $class            - css classes (separated by spaces if more than one)
+	 * @param string      $text             - what appears on the button
+	 * @param string      $nonce_action     - if using nonces
+	 * @param bool|string $input_only       - whether to print form header and footer. TRUE returns the input without
+	 *                                      the form
+	 * @param string      $extra_attributes - any extra attributes that need to be attached to the form input
+	 * @return    string
+	 */
+	public static function submit_button(
+		$url = '',
+		$ID = '',
+		$class = '',
+		$text = '',
+		$nonce_action = '',
+		$input_only = false,
+		$extra_attributes = ''
+	) {
+		$btn = '';
+		if (empty($url) || empty($ID)) {
+			return $btn;
+		}
+		$text = ! empty($text) ? $text : esc_html__('Submit', 'event_espresso');
+		$btn  .= '<input id="' . $ID . '-btn" class="' . $class . '" '
+				 . 'type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
+		if (! $input_only) {
+			$btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
+			$btn_frm .= ! empty($nonce_action)
+				? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false)
+				: '';
+			$btn_frm .= $btn;
+			$btn_frm .= '</form>';
+			$btn     = $btn_frm;
+			unset($btn_frm);
+		}
+		return $btn;
+	}
 }

core/helpers/EEH_MSG_Template.helper.php

Indentation +1249 added lines, -1249 removed lines

@@ -15,1253 +15,1253 @@
 {
 
 
-    /**
-     * Holds a collection of EE_Message_Template_Pack objects.
-     * @type EE_Messages_Template_Pack_Collection
-     */
-    protected static $_template_pack_collection;
-
-
-    /**
-     * @throws EE_Error
-     */
-    private static function _set_autoloader()
-    {
-        EED_Messages::set_autoloaders();
-    }
-
-
-    /**
-     * generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     * @access protected
-     * @param string $messenger     the messenger we are generating templates for
-     * @param array  $message_types array of message types that the templates are generated for.
-     * @param int    $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID
-     *                              to use as the base for the new generated template.
-     * @param bool   $global        true indicates generating templates on messenger activation. false requires GRP_ID
-     *                              for event specific template generation.
-     * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array
-     *                for templates that are generated.  If this is an empty array then it means no templates were
-     *                generated which usually means there was an error.  Anything in the array with an empty value for
-     *                `MTP_context` means that it was not a new generated template but just reactivated (which only
-     *                happens for global templates that already exist in the database.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        // make sure message_type is an array.
-        $message_types = (array) $message_types;
-        $templates = array();
-
-        if (empty($messenger)) {
-            throw new EE_Error(esc_html__('We need a messenger to generate templates!', 'event_espresso'));
-        }
-
-        // if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
-        if (empty($message_types)) {
-            throw new EE_Error(esc_html__('We need at least one message type to generate templates!', 'event_espresso'));
-        }
-
-        EEH_MSG_Template::_set_autoloader();
-        foreach ($message_types as $message_type) {
-            // if this is global template generation.
-            if ($global) {
-                // let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
-                if (empty($GRP_ID)) {
-                    $GRP_ID = EEM_Message_Template_Group::instance()->get_one(
-                        array(
-                            array(
-                                'MTP_messenger'    => $messenger,
-                                'MTP_message_type' => $message_type,
-                                'MTP_is_global'    => true,
-                            ),
-                        )
-                    );
-                    $GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
-                }
-                // First let's determine if we already HAVE global templates for this messenger and message_type combination.
-                //  If we do then NO generation!!
-                if (EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
-                    $templates[] = array(
-                        'GRP_ID' => $GRP_ID,
-                        'MTP_context' => '',
-                    );
-                    // we already have generated templates for this so let's go to the next message type.
-                    continue;
-                }
-            }
-            $new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
-
-            if (! $new_message_template_group) {
-                continue;
-            }
-            $templates[] = $new_message_template_group;
-        }
-
-        return $templates;
-    }
-
-
-    /**
-     * The purpose of this method is to determine if there are already generated templates in the database for the
-     * given variables.
-     *
-     * @param string $messenger    messenger
-     * @param string $message_type message type
-     * @param int    $GRP_ID       GRP ID ( if a custom template) (if not provided then we're just doing global
-     *                             template check)
-     * @return bool                true = generated, false = hasn't been generated.
-     * @throws EE_Error
-     */
-    public static function already_generated($messenger, $message_type, $GRP_ID = 0)
-    {
-        EEH_MSG_Template::_set_autoloader();
-        // what method we use depends on whether we have an GRP_ID or not
-        $count = empty($GRP_ID)
-            ? EEM_Message_Template::instance()->count(
-                array(
-                    array(
-                        'Message_Template_Group.MTP_messenger'    => $messenger,
-                        'Message_Template_Group.MTP_message_type' => $message_type,
-                        'Message_Template_Group.MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
-
-        return $count > 0;
-    }
-
-
-    /**
-     * Updates all message templates matching the incoming messengers and message types to active status.
-     *
-     * @static
-     * @param array $messenger_names    Messenger slug
-     * @param array $message_type_names Message type slug
-     * @return  int                         count of updated records.
-     * @throws EE_Error
-     */
-    public static function update_to_active($messenger_names, $message_type_names)
-    {
-        $messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
-        $message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
-        return EEM_Message_Template_Group::instance()->update(
-            array( 'MTP_is_active' => 1 ),
-            array(
-                array(
-                    'MTP_messenger'     => array( 'IN', $messenger_names ),
-                    'MTP_message_type'  => array( 'IN', $message_type_names )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @static
-     * @param array $messenger_names    The messenger slugs.
-     *                                  If empty then all templates matching the message types are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names The message type slugs.
-     *                                  If empty then all templates matching the messengers are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     * @throws EE_Error
-     */
-    public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
-    {
-        return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
-            $messenger_names,
-            $message_type_names
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to return all installed message objects
-     * (messengers and message type regardless of whether they are ACTIVE or not)
-     *
-     * @param string $type
-     * @return array array consisting of installed messenger objects and installed message type objects.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.9.0
-     * @static
-     */
-    public static function get_installed_message_objects($type = 'all')
-    {
-        self::_set_autoloader();
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return array(
-            'messenger' => $message_resource_manager->installed_messengers(),
-            'message_type' => $message_resource_manager->installed_message_types()
-        );
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the
-     * messenger and message_type objects associated with this
-     * template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param array  $fields                        What fields we're returning valid shortcodes for.
-     *                                              If empty then we assume all fields are to be returned. Optional.
-     * @param string $context                       What context we're going to return shortcodes for. Optional.
-     * @param bool   $merged                        If TRUE then we don't return shortcodes indexed by field,
-     *                                              but instead an array of the unique shortcodes for all the given (
-     *                                              or all) fields. Optional.
-     * @return array                                an array of shortcodes in the format
-     *                                              array( '[shortcode] => 'label')
-     *                                              OR
-     *                                              FALSE if no shortcodes found.
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     *
-     */
-    public static function get_shortcodes(
-        $message_type,
-        $messenger,
-        $fields = array(),
-        $context = 'admin',
-        $merged = false
-    ) {
-        $messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
-        $mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        // convert slug to object
-        $messenger = $message_resource_manager->get_messenger($messenger);
-
-        // if messenger isn't a EE_messenger resource then bail.
-        if (! $messenger instanceof EE_messenger) {
-            return array();
-        }
-
-        // validate class for getting our list of shortcodes
-        $classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-        if (! class_exists($classname)) {
-            $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        /** @type EE_Messages_Validator $_VLD */
-        $_VLD = new $classname(array(), $context);
-        $valid_shortcodes = $_VLD->get_validators();
-
-        // let's make sure we're only getting the shortcode part of the validators
-        $shortcodes = array();
-        foreach ($valid_shortcodes as $field => $validators) {
-            $shortcodes[ $field ] = $validators['shortcodes'];
-        }
-        $valid_shortcodes = $shortcodes;
-
-        // if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-        if (! empty($fields)) {
-            $specified_shortcodes = array();
-            foreach ($fields as $field) {
-                if (isset($valid_shortcodes[ $field ])) {
-                    $specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
-                }
-            }
-            $valid_shortcodes = $specified_shortcodes;
-        }
-
-        // if not merged then let's replace the fields with the localized fields
-        if (! $merged) {
-            // let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
-            $field_settings = $messenger->get_template_fields();
-            $localized = array();
-            foreach ($valid_shortcodes as $field => $shortcodes) {
-                // get localized field label
-                if (isset($field_settings[ $field ])) {
-                    // possible that this is used as a main field.
-                    if (empty($field_settings[ $field ])) {
-                        if (isset($field_settings['extra'][ $field ])) {
-                            $_field = $field_settings['extra'][ $field ]['main']['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    } else {
-                        $_field = $field_settings[ $field ]['label'];
-                    }
-                } elseif (isset($field_settings['extra'])) {
-                    // loop through extra "main fields" and see if any of their children have our field
-                    foreach ($field_settings['extra'] as $fields) {
-                        if (isset($fields[ $field ])) {
-                            $_field = $fields[ $field ]['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    }
-                } else {
-                    $_field = $field;
-                }
-                if (isset($_field)) {
-                    $localized[ (string) $_field ] = $shortcodes;
-                }
-            }
-            $valid_shortcodes = $localized;
-        }
-
-        // if $merged then let's merge all the shortcodes into one list NOT indexed by field.
-        if ($merged) {
-            $merged_codes = array();
-            foreach ($valid_shortcodes as $shortcode) {
-                foreach ($shortcode as $code => $label) {
-                    if (isset($merged_codes[ $code ])) {
-                        continue;
-                    } else {
-                        $merged_codes[ $code ] = $label;
-                    }
-                }
-            }
-            $valid_shortcodes = $merged_codes;
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    /**
-     * Get Messenger object.
-     *
-     * @param string $messenger messenger slug for the messenger object we want to retrieve.
-     * @return EE_messenger
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     * @deprecated 4.9.0
-     */
-    public static function messenger_obj($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_messenger($messenger);
-    }
-
-
-    /**
-     * get Message type object
-     *
-     * @param string $message_type the slug for the message type object to retrieve
-     * @return EE_message_type
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     * @deprecated 4.9.0
-     */
-    public static function message_type_obj($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_message_type($message_type);
-    }
-
-
-    /**
-     * Given a message_type slug, will return whether that message type is active in the system or not.
-     *
-     * @since    4.3.0
-     * @param string $message_type message type to check for.
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_mt_active($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts = $Message_Resource_Manager->list_of_active_message_types();
-        return in_array($message_type, $active_mts);
-    }
-
-
-    /**
-     * Given a messenger slug, will return whether that messenger is active in the system or not.
-     *
-     * @since    4.3.0
-     *
-     * @param string $messenger slug for messenger to check.
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_messenger_active($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
-        return $active_messenger instanceof EE_messenger;
-    }
-
-
-    /**
-     * Used to return active messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     *
-     * @deprecated 4.9
-     * @since      4.3.1
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_active_messengers_in_db()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_active_messengers_option();
-    }
-
-
-    /**
-     * Used to update the active messengers array stored in the wp options table.
-     *
-     * @since      4.3.1
-     * @deprecated 4.9.0
-     *
-     * @param array $data_to_save Incoming data to save.
-     *
-     * @return bool FALSE if not updated, TRUE if updated.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function update_active_messengers_in_db($data_to_save)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
-    }
-
-
-    /**
-     * This does some validation of incoming params, determines what type of url is being prepped and returns the
-     * appropriate url trigger
-     *
-     * @param EE_message_type $message_type
-     * @param EE_Message $message
-     * @param EE_Registration | null $registration  The registration object must be included if this
-     *                                              is going to be a registration trigger url.
-     * @param string $sending_messenger             The (optional) sending messenger for the url.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_url_trigger(
-        EE_message_type $message_type,
-        EE_Message $message,
-        $registration = null,
-        $sending_messenger = ''
-    ) {
-        // first determine if the url can be to the EE_Message object.
-        if (! $message_type->always_generate()) {
-            return EEH_MSG_Template::generate_browser_trigger($message);
-        }
-
-        // if $registration object is not valid then exit early because there's nothing that can be generated.
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                esc_html__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
-            );
-        }
-
-        // validate given context
-        $contexts = $message_type->get_contexts();
-        if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $message->context(),
-                    get_class($message_type)
-                )
-            );
-        }
-
-        // valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-        if (! empty($sending_messenger)) {
-            $with_messengers = $message_type->with_messengers();
-            if (
-                ! isset($with_messengers[ $message->messenger() ])
-                 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ])
-            ) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                            'event_espresso'
-                        ),
-                        $sending_messenger,
-                        get_class($message_type)
-                    )
-                );
-            }
-        } else {
-            $sending_messenger = $message->messenger();
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $message->messenger(),
-            $message->context(),
-            $message->message_type(),
-            $registration,
-            $message->GRP_ID()
-        );
-    }
-
-
-    /**
-     * This returns the url for triggering a in browser view of a specific EE_Message object.
-     * @param EE_Message $message
-     * @return string.
-     */
-    public static function generate_browser_trigger(EE_Message $message)
-    {
-        $query_args = array(
-            'ee' => 'msg_browser_trigger',
-            'token' => $message->MSG_token()
-        );
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_browser_trigger',
-            add_query_arg($query_args, site_url()),
-            $message
-        );
-    }
-
-
-
-
-
-
-    /**
-     * This returns the url for triggering an in browser view of the error saved on the incoming message object.
-     * @param EE_Message $message
-     * @return string
-     */
-    public static function generate_error_display_trigger(EE_Message $message)
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_error_display_trigger',
-            add_query_arg(
-                array(
-                    'ee' => 'msg_browser_error_trigger',
-                    'token' => $message->MSG_token()
-                ),
-                site_url()
-            ),
-            $message
-        );
-    }
-
-
-    /**
-     * This generates a url trigger for the msg_url_trigger route using the given arguments
-     *
-     * @param string          $sending_messenger      The sending messenger slug.
-     * @param string          $generating_messenger   The generating messenger slug.
-     * @param string          $context                The context for the template.
-     * @param string          $message_type           The message type slug
-     * @param EE_Registration $registration
-     * @param integer         $message_template_group id   The EE_Message_Template_Group ID for the template.
-     * @param integer         $data_id                The id to the EE_Base_Class for getting the data used by the
-     *                                                trigger.
-     * @return string          The generated url.
-     * @throws EE_Error
-     */
-    public static function generate_url_trigger(
-        $sending_messenger,
-        $generating_messenger,
-        $context,
-        $message_type,
-        EE_Registration $registration,
-        $message_template_group,
-        $data_id = 0
-    ) {
-        $query_args = array(
-            'ee' => 'msg_url_trigger',
-            'snd_msgr' => $sending_messenger,
-            'gen_msgr' => $generating_messenger,
-            'message_type' => $message_type,
-            'context' => $context,
-            'token' => $registration->reg_url_link(),
-            'GRP_ID' => $message_template_group,
-            'id' => $data_id
-            );
-        $url = add_query_arg($query_args, get_home_url());
-
-        // made it here so now we can just get the url and filter it.  Filtered globally and by message type.
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_url_trigger',
-            $url,
-            $sending_messenger,
-            $generating_messenger,
-            $context,
-            $message_type,
-            $registration,
-            $message_template_group,
-            $data_id
-        );
-    }
-
-
-
-
-    /**
-     * Return the specific css for the action icon given.
-     *
-     * @param string $type  What action to return.
-     * @return string[]
-     * @since 4.9.0
-     */
-    public static function get_message_action_icon($type)
-    {
-        $action_icons = self::get_message_action_icons();
-        return isset($action_icons[ $type ]) ? $action_icons[ $type ] : [];
-    }
-
-
-    /**
-     * This is used for retrieving the css classes used for the icons representing message actions.
-     *
-     * @since 4.9.0
-     *
-     * @return array
-     */
-    public static function get_message_action_icons()
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__message_action_icons',
-            array(
-                'view' => array(
-                    'label' => esc_html__('View Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-welcome-view-site',
-                ),
-                'error' => array(
-                    'label' => esc_html__('View Error Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-info',
-                ),
-                'see_notifications_for' => array(
-                    'label' => esc_html__('View Related Messages', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-megaphone',
-                ),
-                'generate_now' => array(
-                    'label' => esc_html__('Generate the message now.', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-admin-tools',
-                ),
-                'send_now' => array(
-                    'label' => esc_html__('Send Immediately', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-forward',
-                ),
-                'queue_for_resending' => array(
-                    'label' => esc_html__('Queue for Resending', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-repeat',
-                ),
-                'view_transaction' => array(
-                    'label' => esc_html__('View related Transaction', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-cart',
-                )
-            )
-        );
-    }
-
-
-    /**
-     * This returns the url for a given action related to EE_Message.
-     *
-     * @param string     $type         What type of action to return the url for.
-     * @param EE_Message $message      Required for generating the correct url for some types.
-     * @param array      $query_params Any additional query params to be included with the generated url.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.0
-     *
-     */
-    public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
-    {
-        $action_urls = self::get_message_action_urls($message, $query_params);
-        return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
-    }
-
-
-    /**
-     * This returns all the current urls for EE_Message actions.
-     *
-     * @since 4.9.0
-     *
-     * @param EE_Message $message      The EE_Message object required to generate correct urls for some types.
-     * @param array      $query_params Any additional query_params to be included with the generated url.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
-    {
-        EE_Registry::instance()->load_helper('URL');
-        // if $message is not an instance of EE_Message then let's just do a dummy.
-        $message = empty($message) ? EE_Message_Factory::create() : $message;
-        $action_urls =  apply_filters(
-            'FHEE__EEH_MSG_Template__get_message_action_url',
-            array(
-                'view' => EEH_MSG_Template::generate_browser_trigger($message),
-                'error' => EEH_MSG_Template::generate_error_display_trigger($message),
-                'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
-                    array_merge(
-                        array(
-                            'page' => 'espresso_messages',
-                            'action' => 'default',
-                            'filterby' => 1,
-                        ),
-                        $query_params
-                    ),
-                    admin_url('admin.php')
-                ),
-                'generate_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'generate_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'send_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'send_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'queue_for_resending',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-            )
-        );
-        if (
-            $message->TXN_ID() > 0
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_default',
-                $message->TXN_ID()
-            )
-        ) {
-            $action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
-                array(
-                    'page' => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $message->TXN_ID()
-                ),
-                admin_url('admin.php')
-            );
-        } else {
-            $action_urls['view_transaction'] = '';
-        }
-        return $action_urls;
-    }
-
-
-    /**
-     * This returns a generated link html including the icon used for the action link for EE_Message actions.
-     *
-     * @param string          $type         What type of action the link is for (if invalid type is passed in then an
-     *                                      empty string is returned)
-     * @param EE_Message|null $message      The EE_Message object (required for some actions to generate correctly)
-     * @param array           $query_params Any extra query params to include in the generated link.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.0
-     *
-     */
-    public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
-    {
-        $url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
-        $icon_css = EEH_MSG_Template::get_message_action_icon($type);
-        $title = isset($icon_css['label']) ? 'title="' . $icon_css['label'] . '"' : '';
-
-        if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
-            return '';
-        }
-
-        $icon_css['css_class'] .= esc_attr(
-            apply_filters(
-                'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-                ' js-ee-message-action-link ee-message-action-link-' . $type,
-                $type,
-                $message,
-                $query_params
-            )
-        );
-
-        return '<a href="' . $url . '" ' . $title . '><span class="' . esc_attr($icon_css['css_class']) . '"></span></a>';
-    }
-
-
-
-
-
-    /**
-     * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function reg_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
-            array(
-                EEM_Registration::status_id_approved => 'registration',
-                EEM_Registration::status_id_pending_payment => 'pending_approval',
-                EEM_Registration::status_id_not_approved => 'not_approved_registration',
-                EEM_Registration::status_id_cancelled => 'cancelled_registration',
-                EEM_Registration::status_id_declined => 'declined_registration'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding registration message type slug to the given reg status. If there isn't a
-     * match, then returns an empty string.
-     *
-     * @since 4.9.0
-     * @param $reg_status
-     * @return string
-     */
-    public static function convert_reg_status_to_message_type($reg_status)
-    {
-        $reg_status_array = self::reg_status_to_message_type_array();
-        return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
-    }
-
-
-    /**
-     * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function payment_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
-            array(
-                EEM_Payment::status_id_approved => 'payment',
-                EEM_Payment::status_id_pending => 'payment_pending',
-                EEM_Payment::status_id_cancelled => 'payment_cancelled',
-                EEM_Payment::status_id_declined => 'payment_declined',
-                EEM_Payment::status_id_failed => 'payment_failed'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
-     * an empty string is returned
-     *
-     * @since 4.9.0
-     * @param $payment_status
-     * @return string
-     */
-    public static function convert_payment_status_to_message_type($payment_status)
-    {
-        $payment_status_array = self::payment_status_to_message_type_array();
-        return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     *
-     * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
-     *
-     * @return EE_Messages_Template_Pack
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-        }
-
-        // first see if in collection already
-        $template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
-
-        if ($template_pack instanceof EE_Messages_Template_Pack) {
-            return $template_pack;
-        }
-
-        // nope...let's get it.
-        // not set yet so let's attempt to get it.
-        $pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-            ' ',
-            '_',
-            ucwords(
-                str_replace('_', ' ', $template_pack_name)
-            )
-        );
-        if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
-            return self::get_template_pack('default');
-        } else {
-            $template_pack = new $pack_class_name();
-            self::$_template_pack_collection->add($template_pack);
-            return $template_pack;
-        }
-    }
-
-
-
-
-    /**
-     * Globs template packs installed in core and returns the template pack collection with all installed template packs
-     * in it.
-     *
-     * @since 4.9.0
-     *
-     * @return EE_Messages_Template_Pack_Collection
-     */
-    public static function get_template_pack_collection()
-    {
-        $new_collection = false;
-        if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-            $new_collection = true;
-        }
-
-        // glob the defaults directory for messages
-        $templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
-        foreach ($templates as $template_path) {
-            // grab folder name
-            $template = basename($template_path);
-
-            if (! $new_collection) {
-                // already have it?
-                if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
-                    continue;
-                }
-            }
-
-            // setup classname.
-            $template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-                ' ',
-                '_',
-                ucwords(
-                    str_replace(
-                        '_',
-                        ' ',
-                        $template
-                    )
-                )
-            );
-            if (! class_exists($template_pack_class_name)) {
-                continue;
-            }
-            self::$_template_pack_collection->add(new $template_pack_class_name());
-        }
-
-        /**
-         * Filter for plugins to add in any additional template packs
-         * Note the filter name here is for backward compat, this used to be found in EED_Messages.
-         */
-        $additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
-        foreach ((array) $additional_template_packs as $template_pack) {
-            if (
-                self::$_template_pack_collection->get_by_name(
-                    $template_pack->dbref
-                ) instanceof EE_Messages_Template_Pack
-            ) {
-                continue;
-            }
-            self::$_template_pack_collection->add($template_pack);
-        }
-        return self::$_template_pack_collection;
-    }
-
-
-    /**
-     * This is a wrapper for the protected _create_new_templates function
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name message type that the templates are being created for
-     * @param int    $GRP_ID
-     * @param bool   $global
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
-            return array();
-        }
-        // whew made it this far!  Okay, let's go ahead and create the templates then
-        return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
-    }
-
-
-    /**
-     * @param EE_messenger     $messenger
-     * @param EE_message_type  $message_type
-     * @param                  $GRP_ID
-     * @param                  $global
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
-    {
-        // if we're creating a custom template then we don't need to use the defaults class
-        if (! $global) {
-            return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
-        }
-        /** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
-        $Message_Template_Defaults = EE_Registry::factory(
-            'EE_Messages_Template_Defaults',
-            array( $messenger, $message_type, $GRP_ID )
-        );
-        // generate templates
-        $success = $Message_Template_Defaults->create_new_templates();
-
-        // if creating the template failed.  Then we should deactivate the related message_type for the messenger because
-        // its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
-        // attempts.
-        if (! $success) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
-        }
-
-        /**
-         * $success is in an array in the following format
-         * array(
-         *    'GRP_ID' => $new_grp_id,
-         *    'MTP_context' => $first_context_in_new_templates,
-         * )
-         */
-        return $success;
-    }
-
-
-    /**
-     * This creates a custom template using the incoming GRP_ID
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param int             $GRP_ID           GRP_ID for the template_group being used as the base
-     * @return  array $success              This will be an array in the format:
-     *                                          array(
-     *                                          'GRP_ID' => $new_grp_id,
-     *                                          'MTP_context' => $first_context_in_created_template
-     *                                          )
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @access private
-     */
-    private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
-    {
-        // defaults
-        $success = array( 'GRP_ID' => null, 'MTP_context' => '' );
-        // get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
-        $Message_Template_Group = empty($GRP_ID)
-            ? EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $messenger->name,
-                        'MTP_message_type' => $message_type->name,
-                        'MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-        // if we don't have a mtg at this point then we need to bail.
-        if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
-                        'event_espresso'
-                    ),
-                    $GRP_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return $success;
-        }
-        // let's get all the related message_template objects for this group.
-        $message_templates = $Message_Template_Group->message_templates();
-        // now we have what we need to setup the new template
-        $new_mtg = clone $Message_Template_Group;
-        $new_mtg->set('GRP_ID', 0);
-        $new_mtg->set('MTP_is_global', false);
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $template_name = $request->isAjax() && $request->requestParamIsSet('templateName')
-            ? $request->getRequestParam('templateName')
-            : esc_html__('New Custom Template', 'event_espresso');
-        $template_description = $request->isAjax() && $request->requestParamIsSet('templateDescription')
-            ? $request->getRequestParam('templateDescription')
-            : sprintf(
-                esc_html__(
-                    'This is a custom template that was created for the %s messenger and %s message type.',
-                    'event_espresso'
-                ),
-                $new_mtg->messenger_obj()->label['singular'],
-                $new_mtg->message_type_obj()->label['singular']
-            );
-        $new_mtg->set('MTP_name', $template_name);
-        $new_mtg->set('MTP_description', $template_description);
-        // remove ALL relations on this template group so they don't get saved!
-        $new_mtg->_remove_relations('Message_Template');
-        $new_mtg->save();
-        $success['GRP_ID'] = $new_mtg->ID();
-        $success['template_name'] = $template_name;
-        // add new message templates and add relation to.
-        foreach ($message_templates as $message_template) {
-            if (! $message_template instanceof EE_Message_Template) {
-                continue;
-            }
-            $new_message_template = clone $message_template;
-            $new_message_template->set('MTP_ID', 0);
-            $new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
-            $new_message_template->save();
-            if (empty($success['MTP_context'])) {
-                $success['MTP_context'] = $new_message_template->get('MTP_context');
-            }
-        }
-        return $success;
-    }
-
-
-    /**
-     * message_type_has_active_templates_for_messenger
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param bool            $global
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function message_type_has_active_templates_for_messenger(
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $global = false
-    ) {
-        // is given message_type valid for given messenger (if this is not a global save)
-        if ($global) {
-            return true;
-        }
-        $active_templates = EEM_Message_Template_Group::instance()->count(
-            array(
-                array(
-                    'MTP_is_active'    => true,
-                    'MTP_messenger'    => $messenger->name,
-                    'MTP_message_type' => $message_type->name
-                )
-            )
-        );
-        if ($active_templates > 0) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
-                    'event_espresso'
-                ),
-                $message_type->name,
-                $messenger->name
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * get_fields
-     * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
-     *
-     * @param string $messenger_name    name of EE_messenger
-     * @param string $message_type_name name of EE_message_type
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_fields($messenger_name, $message_type_name)
-    {
-        $template_fields = array();
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
-            return array();
-        }
-
-        $excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
-
-        // okay now let's assemble an array with the messenger template fields added to the message_type contexts.
-        foreach ($message_type->get_contexts() as $context => $details) {
-            foreach ($messenger->get_template_fields() as $field => $value) {
-                if (in_array($field, $excluded_fields_for_messenger, true)) {
-                    continue;
-                }
-                $template_fields[ $context ][ $field ] = $value;
-            }
-        }
-        if (empty($template_fields)) {
-            EE_Error::add_error(
-                esc_html__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return array();
-        }
-        return $template_fields;
-    }
+	/**
+	 * Holds a collection of EE_Message_Template_Pack objects.
+	 * @type EE_Messages_Template_Pack_Collection
+	 */
+	protected static $_template_pack_collection;
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private static function _set_autoloader()
+	{
+		EED_Messages::set_autoloaders();
+	}
+
+
+	/**
+	 * generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 * @access protected
+	 * @param string $messenger     the messenger we are generating templates for
+	 * @param array  $message_types array of message types that the templates are generated for.
+	 * @param int    $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID
+	 *                              to use as the base for the new generated template.
+	 * @param bool   $global        true indicates generating templates on messenger activation. false requires GRP_ID
+	 *                              for event specific template generation.
+	 * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array
+	 *                for templates that are generated.  If this is an empty array then it means no templates were
+	 *                generated which usually means there was an error.  Anything in the array with an empty value for
+	 *                `MTP_context` means that it was not a new generated template but just reactivated (which only
+	 *                happens for global templates that already exist in the database.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+		// make sure message_type is an array.
+		$message_types = (array) $message_types;
+		$templates = array();
+
+		if (empty($messenger)) {
+			throw new EE_Error(esc_html__('We need a messenger to generate templates!', 'event_espresso'));
+		}
+
+		// if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
+		if (empty($message_types)) {
+			throw new EE_Error(esc_html__('We need at least one message type to generate templates!', 'event_espresso'));
+		}
+
+		EEH_MSG_Template::_set_autoloader();
+		foreach ($message_types as $message_type) {
+			// if this is global template generation.
+			if ($global) {
+				// let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
+				if (empty($GRP_ID)) {
+					$GRP_ID = EEM_Message_Template_Group::instance()->get_one(
+						array(
+							array(
+								'MTP_messenger'    => $messenger,
+								'MTP_message_type' => $message_type,
+								'MTP_is_global'    => true,
+							),
+						)
+					);
+					$GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
+				}
+				// First let's determine if we already HAVE global templates for this messenger and message_type combination.
+				//  If we do then NO generation!!
+				if (EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
+					$templates[] = array(
+						'GRP_ID' => $GRP_ID,
+						'MTP_context' => '',
+					);
+					// we already have generated templates for this so let's go to the next message type.
+					continue;
+				}
+			}
+			$new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
+
+			if (! $new_message_template_group) {
+				continue;
+			}
+			$templates[] = $new_message_template_group;
+		}
+
+		return $templates;
+	}
+
+
+	/**
+	 * The purpose of this method is to determine if there are already generated templates in the database for the
+	 * given variables.
+	 *
+	 * @param string $messenger    messenger
+	 * @param string $message_type message type
+	 * @param int    $GRP_ID       GRP ID ( if a custom template) (if not provided then we're just doing global
+	 *                             template check)
+	 * @return bool                true = generated, false = hasn't been generated.
+	 * @throws EE_Error
+	 */
+	public static function already_generated($messenger, $message_type, $GRP_ID = 0)
+	{
+		EEH_MSG_Template::_set_autoloader();
+		// what method we use depends on whether we have an GRP_ID or not
+		$count = empty($GRP_ID)
+			? EEM_Message_Template::instance()->count(
+				array(
+					array(
+						'Message_Template_Group.MTP_messenger'    => $messenger,
+						'Message_Template_Group.MTP_message_type' => $message_type,
+						'Message_Template_Group.MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
+
+		return $count > 0;
+	}
+
+
+	/**
+	 * Updates all message templates matching the incoming messengers and message types to active status.
+	 *
+	 * @static
+	 * @param array $messenger_names    Messenger slug
+	 * @param array $message_type_names Message type slug
+	 * @return  int                         count of updated records.
+	 * @throws EE_Error
+	 */
+	public static function update_to_active($messenger_names, $message_type_names)
+	{
+		$messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
+		$message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
+		return EEM_Message_Template_Group::instance()->update(
+			array( 'MTP_is_active' => 1 ),
+			array(
+				array(
+					'MTP_messenger'     => array( 'IN', $messenger_names ),
+					'MTP_message_type'  => array( 'IN', $message_type_names )
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @static
+	 * @param array $messenger_names    The messenger slugs.
+	 *                                  If empty then all templates matching the message types are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names The message type slugs.
+	 *                                  If empty then all templates matching the messengers are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 * @throws EE_Error
+	 */
+	public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
+	{
+		return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
+			$messenger_names,
+			$message_type_names
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to return all installed message objects
+	 * (messengers and message type regardless of whether they are ACTIVE or not)
+	 *
+	 * @param string $type
+	 * @return array array consisting of installed messenger objects and installed message type objects.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.9.0
+	 * @static
+	 */
+	public static function get_installed_message_objects($type = 'all')
+	{
+		self::_set_autoloader();
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return array(
+			'messenger' => $message_resource_manager->installed_messengers(),
+			'message_type' => $message_resource_manager->installed_message_types()
+		);
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the
+	 * messenger and message_type objects associated with this
+	 * template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param array  $fields                        What fields we're returning valid shortcodes for.
+	 *                                              If empty then we assume all fields are to be returned. Optional.
+	 * @param string $context                       What context we're going to return shortcodes for. Optional.
+	 * @param bool   $merged                        If TRUE then we don't return shortcodes indexed by field,
+	 *                                              but instead an array of the unique shortcodes for all the given (
+	 *                                              or all) fields. Optional.
+	 * @return array                                an array of shortcodes in the format
+	 *                                              array( '[shortcode] => 'label')
+	 *                                              OR
+	 *                                              FALSE if no shortcodes found.
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 *
+	 */
+	public static function get_shortcodes(
+		$message_type,
+		$messenger,
+		$fields = array(),
+		$context = 'admin',
+		$merged = false
+	) {
+		$messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
+		$mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		// convert slug to object
+		$messenger = $message_resource_manager->get_messenger($messenger);
+
+		// if messenger isn't a EE_messenger resource then bail.
+		if (! $messenger instanceof EE_messenger) {
+			return array();
+		}
+
+		// validate class for getting our list of shortcodes
+		$classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
+		if (! class_exists($classname)) {
+			$msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		/** @type EE_Messages_Validator $_VLD */
+		$_VLD = new $classname(array(), $context);
+		$valid_shortcodes = $_VLD->get_validators();
+
+		// let's make sure we're only getting the shortcode part of the validators
+		$shortcodes = array();
+		foreach ($valid_shortcodes as $field => $validators) {
+			$shortcodes[ $field ] = $validators['shortcodes'];
+		}
+		$valid_shortcodes = $shortcodes;
+
+		// if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
+		if (! empty($fields)) {
+			$specified_shortcodes = array();
+			foreach ($fields as $field) {
+				if (isset($valid_shortcodes[ $field ])) {
+					$specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+				}
+			}
+			$valid_shortcodes = $specified_shortcodes;
+		}
+
+		// if not merged then let's replace the fields with the localized fields
+		if (! $merged) {
+			// let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
+			$field_settings = $messenger->get_template_fields();
+			$localized = array();
+			foreach ($valid_shortcodes as $field => $shortcodes) {
+				// get localized field label
+				if (isset($field_settings[ $field ])) {
+					// possible that this is used as a main field.
+					if (empty($field_settings[ $field ])) {
+						if (isset($field_settings['extra'][ $field ])) {
+							$_field = $field_settings['extra'][ $field ]['main']['label'];
+						} else {
+							$_field = $field;
+						}
+					} else {
+						$_field = $field_settings[ $field ]['label'];
+					}
+				} elseif (isset($field_settings['extra'])) {
+					// loop through extra "main fields" and see if any of their children have our field
+					foreach ($field_settings['extra'] as $fields) {
+						if (isset($fields[ $field ])) {
+							$_field = $fields[ $field ]['label'];
+						} else {
+							$_field = $field;
+						}
+					}
+				} else {
+					$_field = $field;
+				}
+				if (isset($_field)) {
+					$localized[ (string) $_field ] = $shortcodes;
+				}
+			}
+			$valid_shortcodes = $localized;
+		}
+
+		// if $merged then let's merge all the shortcodes into one list NOT indexed by field.
+		if ($merged) {
+			$merged_codes = array();
+			foreach ($valid_shortcodes as $shortcode) {
+				foreach ($shortcode as $code => $label) {
+					if (isset($merged_codes[ $code ])) {
+						continue;
+					} else {
+						$merged_codes[ $code ] = $label;
+					}
+				}
+			}
+			$valid_shortcodes = $merged_codes;
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	/**
+	 * Get Messenger object.
+	 *
+	 * @param string $messenger messenger slug for the messenger object we want to retrieve.
+	 * @return EE_messenger
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 * @deprecated 4.9.0
+	 */
+	public static function messenger_obj($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_messenger($messenger);
+	}
+
+
+	/**
+	 * get Message type object
+	 *
+	 * @param string $message_type the slug for the message type object to retrieve
+	 * @return EE_message_type
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 * @deprecated 4.9.0
+	 */
+	public static function message_type_obj($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_message_type($message_type);
+	}
+
+
+	/**
+	 * Given a message_type slug, will return whether that message type is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 * @param string $message_type message type to check for.
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_mt_active($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts = $Message_Resource_Manager->list_of_active_message_types();
+		return in_array($message_type, $active_mts);
+	}
+
+
+	/**
+	 * Given a messenger slug, will return whether that messenger is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param string $messenger slug for messenger to check.
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_messenger_active($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
+		return $active_messenger instanceof EE_messenger;
+	}
+
+
+	/**
+	 * Used to return active messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 *
+	 * @deprecated 4.9
+	 * @since      4.3.1
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_active_messengers_in_db()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_active_messengers_option();
+	}
+
+
+	/**
+	 * Used to update the active messengers array stored in the wp options table.
+	 *
+	 * @since      4.3.1
+	 * @deprecated 4.9.0
+	 *
+	 * @param array $data_to_save Incoming data to save.
+	 *
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function update_active_messengers_in_db($data_to_save)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
+	}
+
+
+	/**
+	 * This does some validation of incoming params, determines what type of url is being prepped and returns the
+	 * appropriate url trigger
+	 *
+	 * @param EE_message_type $message_type
+	 * @param EE_Message $message
+	 * @param EE_Registration | null $registration  The registration object must be included if this
+	 *                                              is going to be a registration trigger url.
+	 * @param string $sending_messenger             The (optional) sending messenger for the url.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_url_trigger(
+		EE_message_type $message_type,
+		EE_Message $message,
+		$registration = null,
+		$sending_messenger = ''
+	) {
+		// first determine if the url can be to the EE_Message object.
+		if (! $message_type->always_generate()) {
+			return EEH_MSG_Template::generate_browser_trigger($message);
+		}
+
+		// if $registration object is not valid then exit early because there's nothing that can be generated.
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				esc_html__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
+			);
+		}
+
+		// validate given context
+		$contexts = $message_type->get_contexts();
+		if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$message->context(),
+					get_class($message_type)
+				)
+			);
+		}
+
+		// valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
+		if (! empty($sending_messenger)) {
+			$with_messengers = $message_type->with_messengers();
+			if (
+				! isset($with_messengers[ $message->messenger() ])
+				 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ])
+			) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+							'event_espresso'
+						),
+						$sending_messenger,
+						get_class($message_type)
+					)
+				);
+			}
+		} else {
+			$sending_messenger = $message->messenger();
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$message->messenger(),
+			$message->context(),
+			$message->message_type(),
+			$registration,
+			$message->GRP_ID()
+		);
+	}
+
+
+	/**
+	 * This returns the url for triggering a in browser view of a specific EE_Message object.
+	 * @param EE_Message $message
+	 * @return string.
+	 */
+	public static function generate_browser_trigger(EE_Message $message)
+	{
+		$query_args = array(
+			'ee' => 'msg_browser_trigger',
+			'token' => $message->MSG_token()
+		);
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_browser_trigger',
+			add_query_arg($query_args, site_url()),
+			$message
+		);
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the url for triggering an in browser view of the error saved on the incoming message object.
+	 * @param EE_Message $message
+	 * @return string
+	 */
+	public static function generate_error_display_trigger(EE_Message $message)
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_error_display_trigger',
+			add_query_arg(
+				array(
+					'ee' => 'msg_browser_error_trigger',
+					'token' => $message->MSG_token()
+				),
+				site_url()
+			),
+			$message
+		);
+	}
+
+
+	/**
+	 * This generates a url trigger for the msg_url_trigger route using the given arguments
+	 *
+	 * @param string          $sending_messenger      The sending messenger slug.
+	 * @param string          $generating_messenger   The generating messenger slug.
+	 * @param string          $context                The context for the template.
+	 * @param string          $message_type           The message type slug
+	 * @param EE_Registration $registration
+	 * @param integer         $message_template_group id   The EE_Message_Template_Group ID for the template.
+	 * @param integer         $data_id                The id to the EE_Base_Class for getting the data used by the
+	 *                                                trigger.
+	 * @return string          The generated url.
+	 * @throws EE_Error
+	 */
+	public static function generate_url_trigger(
+		$sending_messenger,
+		$generating_messenger,
+		$context,
+		$message_type,
+		EE_Registration $registration,
+		$message_template_group,
+		$data_id = 0
+	) {
+		$query_args = array(
+			'ee' => 'msg_url_trigger',
+			'snd_msgr' => $sending_messenger,
+			'gen_msgr' => $generating_messenger,
+			'message_type' => $message_type,
+			'context' => $context,
+			'token' => $registration->reg_url_link(),
+			'GRP_ID' => $message_template_group,
+			'id' => $data_id
+			);
+		$url = add_query_arg($query_args, get_home_url());
+
+		// made it here so now we can just get the url and filter it.  Filtered globally and by message type.
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_url_trigger',
+			$url,
+			$sending_messenger,
+			$generating_messenger,
+			$context,
+			$message_type,
+			$registration,
+			$message_template_group,
+			$data_id
+		);
+	}
+
+
+
+
+	/**
+	 * Return the specific css for the action icon given.
+	 *
+	 * @param string $type  What action to return.
+	 * @return string[]
+	 * @since 4.9.0
+	 */
+	public static function get_message_action_icon($type)
+	{
+		$action_icons = self::get_message_action_icons();
+		return isset($action_icons[ $type ]) ? $action_icons[ $type ] : [];
+	}
+
+
+	/**
+	 * This is used for retrieving the css classes used for the icons representing message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return array
+	 */
+	public static function get_message_action_icons()
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__message_action_icons',
+			array(
+				'view' => array(
+					'label' => esc_html__('View Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-welcome-view-site',
+				),
+				'error' => array(
+					'label' => esc_html__('View Error Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-info',
+				),
+				'see_notifications_for' => array(
+					'label' => esc_html__('View Related Messages', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-megaphone',
+				),
+				'generate_now' => array(
+					'label' => esc_html__('Generate the message now.', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-admin-tools',
+				),
+				'send_now' => array(
+					'label' => esc_html__('Send Immediately', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-forward',
+				),
+				'queue_for_resending' => array(
+					'label' => esc_html__('Queue for Resending', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-repeat',
+				),
+				'view_transaction' => array(
+					'label' => esc_html__('View related Transaction', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-cart',
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns the url for a given action related to EE_Message.
+	 *
+	 * @param string     $type         What type of action to return the url for.
+	 * @param EE_Message $message      Required for generating the correct url for some types.
+	 * @param array      $query_params Any additional query params to be included with the generated url.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 *
+	 */
+	public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
+	{
+		$action_urls = self::get_message_action_urls($message, $query_params);
+		return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
+	}
+
+
+	/**
+	 * This returns all the current urls for EE_Message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param EE_Message $message      The EE_Message object required to generate correct urls for some types.
+	 * @param array      $query_params Any additional query_params to be included with the generated url.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
+	{
+		EE_Registry::instance()->load_helper('URL');
+		// if $message is not an instance of EE_Message then let's just do a dummy.
+		$message = empty($message) ? EE_Message_Factory::create() : $message;
+		$action_urls =  apply_filters(
+			'FHEE__EEH_MSG_Template__get_message_action_url',
+			array(
+				'view' => EEH_MSG_Template::generate_browser_trigger($message),
+				'error' => EEH_MSG_Template::generate_error_display_trigger($message),
+				'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
+					array_merge(
+						array(
+							'page' => 'espresso_messages',
+							'action' => 'default',
+							'filterby' => 1,
+						),
+						$query_params
+					),
+					admin_url('admin.php')
+				),
+				'generate_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'generate_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'send_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'send_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'queue_for_resending',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+			)
+		);
+		if (
+			$message->TXN_ID() > 0
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_default',
+				$message->TXN_ID()
+			)
+		) {
+			$action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
+				array(
+					'page' => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $message->TXN_ID()
+				),
+				admin_url('admin.php')
+			);
+		} else {
+			$action_urls['view_transaction'] = '';
+		}
+		return $action_urls;
+	}
+
+
+	/**
+	 * This returns a generated link html including the icon used for the action link for EE_Message actions.
+	 *
+	 * @param string          $type         What type of action the link is for (if invalid type is passed in then an
+	 *                                      empty string is returned)
+	 * @param EE_Message|null $message      The EE_Message object (required for some actions to generate correctly)
+	 * @param array           $query_params Any extra query params to include in the generated link.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 *
+	 */
+	public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
+	{
+		$url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
+		$icon_css = EEH_MSG_Template::get_message_action_icon($type);
+		$title = isset($icon_css['label']) ? 'title="' . $icon_css['label'] . '"' : '';
+
+		if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
+			return '';
+		}
+
+		$icon_css['css_class'] .= esc_attr(
+			apply_filters(
+				'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
+				' js-ee-message-action-link ee-message-action-link-' . $type,
+				$type,
+				$message,
+				$query_params
+			)
+		);
+
+		return '<a href="' . $url . '" ' . $title . '><span class="' . esc_attr($icon_css['css_class']) . '"></span></a>';
+	}
+
+
+
+
+
+	/**
+	 * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function reg_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
+			array(
+				EEM_Registration::status_id_approved => 'registration',
+				EEM_Registration::status_id_pending_payment => 'pending_approval',
+				EEM_Registration::status_id_not_approved => 'not_approved_registration',
+				EEM_Registration::status_id_cancelled => 'cancelled_registration',
+				EEM_Registration::status_id_declined => 'declined_registration'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding registration message type slug to the given reg status. If there isn't a
+	 * match, then returns an empty string.
+	 *
+	 * @since 4.9.0
+	 * @param $reg_status
+	 * @return string
+	 */
+	public static function convert_reg_status_to_message_type($reg_status)
+	{
+		$reg_status_array = self::reg_status_to_message_type_array();
+		return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
+	}
+
+
+	/**
+	 * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function payment_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
+			array(
+				EEM_Payment::status_id_approved => 'payment',
+				EEM_Payment::status_id_pending => 'payment_pending',
+				EEM_Payment::status_id_cancelled => 'payment_cancelled',
+				EEM_Payment::status_id_declined => 'payment_declined',
+				EEM_Payment::status_id_failed => 'payment_failed'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
+	 * an empty string is returned
+	 *
+	 * @since 4.9.0
+	 * @param $payment_status
+	 * @return string
+	 */
+	public static function convert_payment_status_to_message_type($payment_status)
+	{
+		$payment_status_array = self::payment_status_to_message_type_array();
+		return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 *
+	 * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
+	 *
+	 * @return EE_Messages_Template_Pack
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+		}
+
+		// first see if in collection already
+		$template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
+
+		if ($template_pack instanceof EE_Messages_Template_Pack) {
+			return $template_pack;
+		}
+
+		// nope...let's get it.
+		// not set yet so let's attempt to get it.
+		$pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+			' ',
+			'_',
+			ucwords(
+				str_replace('_', ' ', $template_pack_name)
+			)
+		);
+		if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+			return self::get_template_pack('default');
+		} else {
+			$template_pack = new $pack_class_name();
+			self::$_template_pack_collection->add($template_pack);
+			return $template_pack;
+		}
+	}
+
+
+
+
+	/**
+	 * Globs template packs installed in core and returns the template pack collection with all installed template packs
+	 * in it.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return EE_Messages_Template_Pack_Collection
+	 */
+	public static function get_template_pack_collection()
+	{
+		$new_collection = false;
+		if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+			$new_collection = true;
+		}
+
+		// glob the defaults directory for messages
+		$templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
+		foreach ($templates as $template_path) {
+			// grab folder name
+			$template = basename($template_path);
+
+			if (! $new_collection) {
+				// already have it?
+				if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
+					continue;
+				}
+			}
+
+			// setup classname.
+			$template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+				' ',
+				'_',
+				ucwords(
+					str_replace(
+						'_',
+						' ',
+						$template
+					)
+				)
+			);
+			if (! class_exists($template_pack_class_name)) {
+				continue;
+			}
+			self::$_template_pack_collection->add(new $template_pack_class_name());
+		}
+
+		/**
+		 * Filter for plugins to add in any additional template packs
+		 * Note the filter name here is for backward compat, this used to be found in EED_Messages.
+		 */
+		$additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
+		foreach ((array) $additional_template_packs as $template_pack) {
+			if (
+				self::$_template_pack_collection->get_by_name(
+					$template_pack->dbref
+				) instanceof EE_Messages_Template_Pack
+			) {
+				continue;
+			}
+			self::$_template_pack_collection->add($template_pack);
+		}
+		return self::$_template_pack_collection;
+	}
+
+
+	/**
+	 * This is a wrapper for the protected _create_new_templates function
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name message type that the templates are being created for
+	 * @param int    $GRP_ID
+	 * @param bool   $global
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
+			return array();
+		}
+		// whew made it this far!  Okay, let's go ahead and create the templates then
+		return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
+	}
+
+
+	/**
+	 * @param EE_messenger     $messenger
+	 * @param EE_message_type  $message_type
+	 * @param                  $GRP_ID
+	 * @param                  $global
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
+	{
+		// if we're creating a custom template then we don't need to use the defaults class
+		if (! $global) {
+			return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
+		}
+		/** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
+		$Message_Template_Defaults = EE_Registry::factory(
+			'EE_Messages_Template_Defaults',
+			array( $messenger, $message_type, $GRP_ID )
+		);
+		// generate templates
+		$success = $Message_Template_Defaults->create_new_templates();
+
+		// if creating the template failed.  Then we should deactivate the related message_type for the messenger because
+		// its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
+		// attempts.
+		if (! $success) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
+		}
+
+		/**
+		 * $success is in an array in the following format
+		 * array(
+		 *    'GRP_ID' => $new_grp_id,
+		 *    'MTP_context' => $first_context_in_new_templates,
+		 * )
+		 */
+		return $success;
+	}
+
+
+	/**
+	 * This creates a custom template using the incoming GRP_ID
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param int             $GRP_ID           GRP_ID for the template_group being used as the base
+	 * @return  array $success              This will be an array in the format:
+	 *                                          array(
+	 *                                          'GRP_ID' => $new_grp_id,
+	 *                                          'MTP_context' => $first_context_in_created_template
+	 *                                          )
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @access private
+	 */
+	private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
+	{
+		// defaults
+		$success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+		// get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
+		$Message_Template_Group = empty($GRP_ID)
+			? EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $messenger->name,
+						'MTP_message_type' => $message_type->name,
+						'MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+		// if we don't have a mtg at this point then we need to bail.
+		if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
+						'event_espresso'
+					),
+					$GRP_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return $success;
+		}
+		// let's get all the related message_template objects for this group.
+		$message_templates = $Message_Template_Group->message_templates();
+		// now we have what we need to setup the new template
+		$new_mtg = clone $Message_Template_Group;
+		$new_mtg->set('GRP_ID', 0);
+		$new_mtg->set('MTP_is_global', false);
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$template_name = $request->isAjax() && $request->requestParamIsSet('templateName')
+			? $request->getRequestParam('templateName')
+			: esc_html__('New Custom Template', 'event_espresso');
+		$template_description = $request->isAjax() && $request->requestParamIsSet('templateDescription')
+			? $request->getRequestParam('templateDescription')
+			: sprintf(
+				esc_html__(
+					'This is a custom template that was created for the %s messenger and %s message type.',
+					'event_espresso'
+				),
+				$new_mtg->messenger_obj()->label['singular'],
+				$new_mtg->message_type_obj()->label['singular']
+			);
+		$new_mtg->set('MTP_name', $template_name);
+		$new_mtg->set('MTP_description', $template_description);
+		// remove ALL relations on this template group so they don't get saved!
+		$new_mtg->_remove_relations('Message_Template');
+		$new_mtg->save();
+		$success['GRP_ID'] = $new_mtg->ID();
+		$success['template_name'] = $template_name;
+		// add new message templates and add relation to.
+		foreach ($message_templates as $message_template) {
+			if (! $message_template instanceof EE_Message_Template) {
+				continue;
+			}
+			$new_message_template = clone $message_template;
+			$new_message_template->set('MTP_ID', 0);
+			$new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
+			$new_message_template->save();
+			if (empty($success['MTP_context'])) {
+				$success['MTP_context'] = $new_message_template->get('MTP_context');
+			}
+		}
+		return $success;
+	}
+
+
+	/**
+	 * message_type_has_active_templates_for_messenger
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param bool            $global
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function message_type_has_active_templates_for_messenger(
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$global = false
+	) {
+		// is given message_type valid for given messenger (if this is not a global save)
+		if ($global) {
+			return true;
+		}
+		$active_templates = EEM_Message_Template_Group::instance()->count(
+			array(
+				array(
+					'MTP_is_active'    => true,
+					'MTP_messenger'    => $messenger->name,
+					'MTP_message_type' => $message_type->name
+				)
+			)
+		);
+		if ($active_templates > 0) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
+					'event_espresso'
+				),
+				$message_type->name,
+				$messenger->name
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * get_fields
+	 * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
+	 *
+	 * @param string $messenger_name    name of EE_messenger
+	 * @param string $message_type_name name of EE_message_type
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_fields($messenger_name, $message_type_name)
+	{
+		$template_fields = array();
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
+			return array();
+		}
+
+		$excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
+
+		// okay now let's assemble an array with the messenger template fields added to the message_type contexts.
+		foreach ($message_type->get_contexts() as $context => $details) {
+			foreach ($messenger->get_template_fields() as $field => $value) {
+				if (in_array($field, $excluded_fields_for_messenger, true)) {
+					continue;
+				}
+				$template_fields[ $context ][ $field ] = $value;
+			}
+		}
+		if (empty($template_fields)) {
+			EE_Error::add_error(
+				esc_html__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return array();
+		}
+		return $template_fields;
+	}
 }

admin_pages/messages/templates/shortcode_selector_skeleton.template.php

Indentation +5 added lines, -5 removed lines

@@ -28,14 +28,14 @@
         </h6>
         <h4>
             <?php
-            printf(
-                esc_html__('"%1$s" field', 'event_espresso'),
-                esc_attr($fieldname)
-            ); ?>
+			printf(
+				esc_html__('"%1$s" field', 'event_espresso'),
+				esc_attr($fieldname)
+			); ?>
         </h4>
         <ul>
         <?php
-        foreach (array_keys($shortcodes) as $shortcode) : ?>
+		foreach (array_keys($shortcodes) as $shortcode) : ?>
             <li>
                 <span class="js-shortcode-selection"
                       data-linked-input-id="<?php echo esc_attr($linked_input_id); ?>"

Spacing +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
  * @type    string $linked_input_id The name of the input that the shortcode gets inserted to.
  */
 
-if (! empty($shortcodes)) : ?>
+if ( ! empty($shortcodes)) : ?>
 <div class="ee-messages-shortcodes-chooser-wrap">
     <button class="ee-messages-shortcodes-chooser js-open-list-trigger button button-secondary"
             aria-label="<?php echo esc_html__('open shortcode selector', 'event_espresso'); ?>"