eventespresso / event-espresso-core

admin_pages/events/Events_Admin_Page.core.php

Indentation +2907 added lines, -2907 removed lines

@@ -16,2914 +16,2914 @@
  */
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * This will hold the event object for event_details screen.
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
+
+	/**
+	 * @var AdvancedEditorAdminFormSection
+	 */
+	protected $advanced_editor_admin_form;
+
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EVENTS_PG_SLUG;
+		$this->page_label       = EVENTS_LABEL;
+		$this->_admin_base_url  = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_events' => 'edit',
+		];
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			[$this, 'verify_event_edit'],
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		// load formatter helper
+		// load field generator helper
+		// is there a evt_id in the request?
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
+
+		$this->_page_routes = [
+			'default'                       => [
+				'func'       => '_events_overview_list_table',
+				'capability' => 'ee_read_events',
+			],
+			'create_new'                    => [
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_events',
+			],
+			'edit'                          => [
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+			],
+			'copy_event'                    => [
+				'func'       => '_copy_events',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_event'                   => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_events'                  => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'restore_event'                 => [
+				'func'       => '_trash_or_restore_event',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'restore_events'                => [
+				'func'       => '_trash_or_restore_events',
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'delete_event'                  => [
+				'func'       => '_delete_event',
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'delete_events'                 => [
+				'func'       => '_delete_events',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'view_report'                   => [
+				'func'       => '_view_report',
+				'capability' => 'ee_edit_events',
+			],
+			'default_event_settings'        => [
+				'func'       => '_default_event_settings',
+				'capability' => 'manage_options',
+			],
+			'update_default_event_settings' => [
+				'func'       => '_update_default_event_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'template_settings'             => [
+				'func'       => '_template_settings',
+				'capability' => 'manage_options',
+			],
+			// event category tab related
+			'add_category'                  => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['add'],
+			],
+			'edit_category'                 => [
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['edit'],
+			],
+			'delete_categories'             => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'delete_category'               => [
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'insert_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => true],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'update_category'               => [
+				'func'       => '_insert_or_update_category',
+				'args'       => ['new_category' => false],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'category_list'                 => [
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_event_categories',
+			],
+			'preview_deletion'              => [
+				'func'       => 'previewDeletion',
+				'capability' => 'ee_delete_events',
+			],
+			'confirm_deletion'              => [
+				'func'       => 'confirmDeletion',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$post_id            = $this->request->getRequestParam('post', 0, 'int');
+		$EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		$this->_page_config = [
+			'default'                => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				],
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => [
+					'events_overview_help_tab'                       => [
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					],
+					'events_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					],
+					'events_overview_filters_help_tab'               => [
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					],
+					'events_overview_view_help_tab'                  => [
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					],
+					'events_overview_other_help_tab'                 => [
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'create_new'             => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
+				'require_nonce' => false,
+			],
+			'edit'                   => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => $post_id
+						? EE_Admin_Page::add_query_args_and_nonce(
+							['post' => $post_id, 'action' => 'edit'],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'default_event_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'labels'        => [
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				],
+				'help_tabs'     => [
+					'default_settings_help_tab'        => [
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					],
+					'default_settings_status_help_tab' => [
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					],
+					'default_maximum_tickets_help_tab' => [
+						'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// template settings
+			'template_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Templates', 'event_espresso'),
+					'order' => 30,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'general_settings_templates_help_tab' => [
+						'title'    => esc_html__('Templates', 'event_espresso'),
+						'filename' => 'general_settings_templates',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// event category stuff
+			'add_category'           => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_category_help_tab' => [
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'edit_category'          => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(
+							['EVT_CAT_ID' => $EVT_CAT_ID],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => [
+					'edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'category_list'          => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'order' => 20,
+				],
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'events_categories_help_tab'                       => [
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					],
+					'events_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					],
+					'events_categories_view_help_tab'                  => [
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					],
+					'events_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+			'preview_deletion'       => [
+				'nav'           => [
+					'label'      => esc_html__('Preview Deletion', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style(
+			'ee-cat-admin',
+			EVENTS_ASSETS_URL . 'ee-cat-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		// scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		// scripts
+		if (! $this->admin_config->useAdvancedEditor()) {
+			wp_register_script(
+				'event-datetime-metabox',
+				EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+				['event_editor_js', 'ee-datepicker'],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_script('event-datetime-metabox');
+		}
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
+	 * group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param EE_Event $event Event object
+	 * @param string   $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_event_edit($event = null, $req_type = '')
+	{
+		// don't need to do this when processing
+		if (! empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (! $event instanceof EE_Event) {
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		// made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		}
+		if ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		// now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if (! $event->tickets_on_sale()) {
+			return;
+		}
+		// made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if ($this->request->getRequestParam('action') === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			sprintf(
+				esc_html__(
+					'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
+					'event_espresso'
+				),
+				'<a class="espresso-help-tab-lnk ee-help-tab-link">',
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		// only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button--secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all'   => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'draft' => [
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _event_legend_items()
+	{
+		$items    = [
+			'view_details'   => [
+				'class' => 'dashicons dashicons-visibility',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			],
+			'edit_event'     => [
+				'class' => 'dashicons dashicons-calendar-alt',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			],
+			'view_attendees' => [
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			],
+		];
+		$items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = [
+			'sold_out_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			],
+			'active_status'    => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			],
+			'upcoming_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			],
+			'postponed_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			],
+			'cancelled_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			],
+			'expired_status'   => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			],
+			'inactive_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			],
+		];
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+	/**
+	 * @return EEM_Event
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _event_model()
+	{
+		if (! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param string $return    the current html
+	 * @param int    $id        the post id for the page
+	 * @param string $new_title What the title is
+	 * @param string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$post = get_post($id);
+			$return .= '<a class="button button--small button--secondary" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
+					   . esc_html__('Shortcode', 'event_espresso')
+					   . '</a> ';
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
+					   . $post->ID
+					   . ']">';
+		}
+		return $return;
+	}
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _events_overview_list_table()
+	{
+		$after_list_table                           = [];
+		$links_html = EEH_HTML::div('', '', 'ee-admin-section ee-layout-stack');
+		$links_html .= EEH_HTML::h3(esc_html__('Links', 'event_espresso'));
+		$links_html .= EEH_HTML::div(
+			EEH_Template::get_button_or_link(
+				get_post_type_archive_link('espresso_events'),
+				esc_html__('View Event Archive Page', 'event_espresso'),
+				'button button--small button--secondary'
+			),
+			'',
+			'ee-admin-button-row ee-admin-button-row--align-start'
+		);
+		$links_html .= EEH_HTML::divx();
+
+		$after_list_table['view_event_list_button'] = $links_html;
+
+		$after_list_table['legend'] = $this->_display_legend($this->_event_legend_items());
+		$this->_admin_page_title                    .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+
+		$this->_template_args['after_list_table']   = array_merge(
+			(array) $this->_template_args['after_list_table'],
+			$after_list_table
+		);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.
+	 * Typically you would use this to save any additional data.
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
+	 * ALSO very important.  When a post transitions from scheduled to published,
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
+	 * other meta saves. So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param WP_Post $post    The post object of the cpt that was saved.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			// get out we're not processing an event save.
+			return;
+		}
+		$event_values = [
+			'EVT_member_only'     => $this->request->getRequestParam('member_only', false, 'bool'),
+			'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, 'bool'),
+			'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
+		];
+		// check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
+		if (! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
+			$event_values['EVT_display_ticket_selector']     = $this->request->getRequestParam(
+				'display_ticket_selector',
+				false,
+				'bool'
+			);
+			$event_values['EVT_additional_limit']            = min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				$this->request->getRequestParam('additional_limit', null, 'int')
+			);
+			$event_values['EVT_default_registration_status'] = $this->request->getRequestParam(
+				'EVT_default_registration_status',
+				EE_Registry::instance()->CFG->registration->default_STS_ID
+			);
+
+			$event_values['EVT_external_URL'] = $this->request->getRequestParam('externalURL');
+			$event_values['EVT_phone']        = $this->request->getRequestParam('event_phone');
+			$event_values['EVT_display_desc'] = $this->request->getRequestParam('display_desc', false, 'bool');
+		}
+		// update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		// get event_object for other metaboxes...
+		// though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id )..
+		// i have to setup where conditions to override the filters in the model
+		// that filter out autodraft and inherit statuses so we GET the inherit id!
+		$event = $this->_event_model()->get_one(
+			[
+				[
+					$this->_event_model()->primary_key_name() => $post_id,
+					'OR'                                      => [
+						'status'   => $post->post_status,
+						// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+						// but the returned object here has a status of "publish", so use the original post status as well
+						'status*1' => $this->request->getRequestParam('original_post_status'),
+					],
+				],
+			]
+		);
+
+		// the following are default callbacks for event attachment updates
+		// that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = [];
+		if (! $this->admin_config->useAdvancedEditor()) {
+			$event_update_callbacks['_default_venue_update']   = [$this, '_default_venue_update'];
+			$event_update_callbacks['_default_tickets_update'] = [$this, '_default_tickets_update'];
+		}
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			$event_update_callbacks
+		);
+
+		$att_success = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = is_callable($e_callback)
+				? $e_callback($event, $this->request->requestParams())
+				: false;
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = $_success !== false ? $att_success : false;
+		}
+		// any errors?
+		if ($success && $att_success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @param int $revision_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see parent::restore_item()
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		// copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			// meta revision restore
+			$post_evt->restore_revision($revision_id);
+			// related objs restore
+			$post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
+		}
+	}
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param EE_Event $event Event Object to add the venue to
+	 * @param array    $data  The request data from the form
+	 * @return bool           Success or fail.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _default_venue_update(EE_Event $event, $data)
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = [
+			'VNU_wp_user'         => $event->get('EVT_wp_user'),
+			'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description'])
+				? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		];
+		// if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if (! empty($venue_id)) {
+			$update_where  = [$venue_model->primary_key_name() => $venue_id];
+			$rows_affected = $venue_model->update($venue_array, [$update_where]);
+			// we've gotta make sure that the venue is always attached to a revision..
+			// add_relation_to should take care of making sure that the relation is already present.
+			$event->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0;
+		}
+		// we insert the venue
+		$venue_id = $venue_model->insert($venue_array);
+		$event->_add_relation_to($venue_id, 'Venue');
+		return ! empty($venue_id);
+		// when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param EE_Event $event The Event object we're attaching data to
+	 * @param array    $data  The request data from the form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _default_tickets_update(EE_Event $event, $data)
+	{
+		if ($this->admin_config->useAdvancedEditor()) {
+			return [];
+		}
+		$datetime       = null;
+		$saved_tickets  = [];
+		$event_timezone = $event->get_timezone();
+		$date_formats   = ['Y-m-d', 'h:i a'];
+		foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
+			// trim all values to ensure any excess whitespace is removed.
+			$datetime_data                = array_map('trim', $datetime_data);
+			$datetime_data['DTT_EVT_end'] =
+				isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
+					? $datetime_data['DTT_EVT_end']
+					: $datetime_data['DTT_EVT_start'];
+			$datetime_values              = [
+				'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
+				'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
+				'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			];
+			// if we have an id then let's get existing object first and then set the new values.
+			//  Otherwise we instantiate a new object for save.
+			if (! empty($datetime_data['DTT_ID'])) {
+				$datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
+				if (! $datetime instanceof EE_Datetime) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$datetime_data['DTT_ID']
+						)
+					);
+				}
+				$datetime->set_date_format($date_formats[0]);
+				$datetime->set_time_format($date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+			} else {
+				$datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
+			}
+			if (! $datetime instanceof EE_Datetime) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($datetime_values, true)
+					)
+				);
+			}
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
+				$datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
+				$datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
+			}
+			$datetime->save();
+			$event->_add_relation_to($datetime, 'Datetime');
+		}
+		// no datetimes get deleted so we don't do any of that logic here.
+		// update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
+
+		// set up some default start and end dates in case those are not present in the incoming data
+		$default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
+		$default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
+		// use the start date of the first datetime for the end date
+		$first_datetime   = $event->first_datetime();
+		$default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
+
+		// now process the incoming data
+		foreach ($data['edit_tickets'] as $row => $ticket_data) {
+			$update_prices = false;
+			$ticket_price  = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
+				? $data['edit_prices'][ $row ][1]['PRC_amount']
+				: 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$ticket_data   = array_map('trim', $ticket_data);
+			$ticket_values = [
+				'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
+				'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
+				'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
+					? $ticket_data['TKT_start_date']
+					: $default_start_date,
+				'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
+					? $ticket_data['TKT_end_date']
+					: $default_end_date,
+				'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
+									 || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
+					? $ticket_data['TKT_qty']
+					: EE_INF,
+				'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
+									 || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
+					? $ticket_data['TKT_uses']
+					: EE_INF,
+				'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
+				'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
+				'TKT_order'       => isset($ticket_data['TKT_order']) ? $ticket_data['TKT_order'] : $row,
+				'TKT_price'       => $ticket_price,
+				'TKT_row'         => $row,
+			];
+			// if this is a default ticket, then we need to set the TKT_ID to 0 and update accordingly,
+			// which means in turn that the prices will become new prices as well.
+			if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
+				$ticket_values['TKT_ID']         = 0;
+				$ticket_values['TKT_is_default'] = 0;
+				$update_prices                   = true;
+			}
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves ahead of adding any relations because its entirely possible that this
+			// ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
+			// keep in mind that if the ticket has been sold (and we have changed pricing information),
+			// then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if (! empty($ticket_data['TKT_ID'])) {
+				$existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
+				if (! $existing_ticket instanceof EE_Ticket) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$ticket_data['TKT_ID']
+						)
+					);
+				}
+				$ticket_sold = $existing_ticket->count_related(
+					'Registration',
+					[
+							[
+								'STS_ID' => [
+									'NOT IN',
+									[EEM_Registration::status_id_incomplete],
+								],
+							],
+						]
+				) > 0;
+				// let's just check the total price for the existing ticket and determine if it matches the new total price.
+				// if they are different then we create a new ticket (if $ticket_sold)
+				// if they aren't different then we go ahead and modify existing ticket.
+				$create_new_ticket = $ticket_sold
+									 && $ticket_price !== $existing_ticket->price()
+									 && ! $existing_ticket->deleted();
+				$existing_ticket->set_date_format($date_formats[0]);
+				$existing_ticket->set_time_format($date_formats[1]);
+				// set new values
+				foreach ($ticket_values as $field => $value) {
+					if ($field == 'TKT_qty') {
+						$existing_ticket->set_qty($value);
+					} elseif ($field == 'TKT_price') {
+						$existing_ticket->set('TKT_price', $ticket_price);
+					} else {
+						$existing_ticket->set($field, $value);
+					}
+				}
+				$ticket = $existing_ticket;
+				// if $create_new_ticket is false then we can safely update the existing ticket.
+				//  Otherwise we have to create a new ticket.
+				if ($create_new_ticket) {
+					// archive the old ticket first
+					$existing_ticket->set('TKT_deleted', 1);
+					$existing_ticket->save();
+					// make sure this ticket is still recorded in our $saved_tickets
+					// so we don't run it through the regular trash routine.
+					$saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
+					// create new ticket that's a copy of the existing except,
+					// (a new id of course and not archived) AND has the new TKT_price associated with it.
+					$new_ticket = clone $existing_ticket;
+					$new_ticket->set('TKT_ID', 0);
+					$new_ticket->set('TKT_deleted', 0);
+					$new_ticket->set('TKT_sold', 0);
+					// now we need to make sure that $new prices are created as well and attached to new ticket.
+					$update_prices = true;
+					$ticket        = $new_ticket;
+				}
+			} else {
+				// no TKT_id so a new ticket
+				$ticket_values['TKT_price'] = $ticket_price;
+				$ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
+				$update_prices              = true;
+			}
+			if (! $ticket instanceof EE_Ticket) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($ticket_values, true)
+					)
+				);
+			}
+			// cap ticket qty by datetime reg limits
+			$ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
+			// update ticket.
+			$ticket->save();
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
+				$ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
+				$ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
+				$ticket->save();
+			}
+			// initially let's add the ticket to the datetime
+			$datetime->_add_relation_to($ticket, 'Ticket');
+			$saved_tickets[ $ticket->ID() ] = $ticket;
+			// add prices to ticket
+			$prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
+				? $data['edit_prices'][ $row ]
+				: [];
+			$this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
+		}
+		// however now we need to handle permanently deleting tickets via the ui.
+		// Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.
+		// However, it does allow for deleting tickets that have no tickets sold,
+		// in which case we want to get rid of permanently because there is no need to save in db.
+		$old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			// get the ticket for this id
+			$ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
+			if (! $ticket_to_remove instanceof EE_Ticket) {
+				continue;
+			}
+			// need to get all the related datetimes on this ticket and remove from every single one of them
+			// (remember this process can ONLY kick off if there are NO tickets sold)
+			$related_datetimes = $ticket_to_remove->get_many_related('Datetime');
+			foreach ($related_datetimes as $related_datetime) {
+				$ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
+			}
+			// need to do the same for prices (except these prices can also be deleted because again,
+			// tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$ticket_to_remove->delete_related_permanently('Price');
+			// finally let's delete this ticket
+			// (which should not be blocked at this point b/c we've removed all our relationships)
+			$ticket_to_remove->delete_permanently();
+		}
+		return [$datetime, $saved_tickets];
+	}
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices)
+	 * because if there is a change in price information on a ticket, a new ticket is created anyways
+	 * so the archived ticket will retain the old price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices_data Array of prices from the form.
+	 * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _add_prices_to_ticket($prices_data, EE_Ticket $ticket, $new_prices = false)
+	{
+		$timezone = $ticket->get_timezone();
+		foreach ($prices_data as $row => $price_data) {
+			$price_values = [
+				'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
+				'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
+				'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			];
+			if ($new_prices || empty($price_values['PRC_ID'])) {
+				$price_values['PRC_ID'] = 0;
+				$price                  = EE_Price::new_instance($price_values, $timezone);
+			} else {
+				$price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
+				// update this price with new values
+				foreach ($price_values as $field => $new_price) {
+					$price->set($field, $new_price);
+				}
+			}
+			if (! $price instanceof EE_Price) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($price_values, true)
+					)
+				);
+			}
+			$price->save();
+			$ticket->_add_relation_to($price, 'Price');
+		}
+	}
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		// load formatter helper
+		// args for getting related registrations
+		$approved_query_args        = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			],
+		];
+		$not_approved_query_args    = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			],
+		];
+		$pending_payment_query_args = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			],
+		];
+		// publish box
+		$publish_box_extra_args = [
+			'view_approved_reg_url'        => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+				],
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				],
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				],
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		];
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		$use_advanced_editor = $this->admin_config->useAdvancedEditor();
+		// check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
+		if (! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
+			$this->addMetaBox(
+				'espresso_event_editor_event_options',
+				esc_html__('Event Registration Options', 'event_espresso'),
+				[$this, 'registration_options_meta_box'],
+				$this->page_slug,
+				'side'
+			);
+		}
+		if (! $use_advanced_editor) {
+			$this->addMetaBox(
+				'espresso_event_editor_tickets',
+				esc_html__('Event Datetime & Ticket', 'event_espresso'),
+				[$this, 'ticket_metabox'],
+				$this->page_slug,
+				'normal',
+				'high'
+			);
+		} elseif ($this->feature->allowed('use_reg_options_meta_box')) {
+			add_action(
+				'add_meta_boxes_espresso_events',
+				function () {
+					global $current_screen;
+					remove_meta_box('authordiv', $current_screen, 'normal');
+				},
+				99
+			);
+		}
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = [];
+		// defaults for template args
+		$template_args = [
+			'existing_datetime_ids'    => '',
+			'event_datetime_help_link' => '',
+			'ticket_options_help_link' => '',
+			'time'                     => null,
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'trash_icon'               => 'dashicons dashicons-lock',
+			'disabled'                 => '',
+		];
+		$event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		/** @var EEM_Datetime $datetime_model */
+		$datetime_model = EE_Registry::instance()->load_model('Datetime');
+		/** @var EEM_Ticket $datetime_model */
+		$ticket_model = EE_Registry::instance()->load_model('Ticket');
+		$times        = $datetime_model->get_all_event_dates($event_id);
+		/** @type EE_Datetime $first_datetime */
+		$first_datetime = reset($times);
+		// do we get related tickets?
+		if (
+			$first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time']   = $first_datetime;
+			$related_tickets         = $first_datetime->tickets(
+				[
+					['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
+					'default_where_conditions' => 'none',
+				]
+			);
+			if (! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row                                = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[]        = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket                       = $ticket_model->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time'] = $times[0];
+			/** @type EE_Ticket[] $tickets */
+			$tickets                      = $ticket_model->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure']      = $this->_get_ticket_row(
+			$ticket_model->create_default_object(),
+			true
+		);
+		$template                                  = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param EE_Ticket $ticket   the ticket object
+	 * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int       $row
+	 * @return string generated html for the ticket row.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
+	{
+		$template_args = [
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'dashicons dashicons-lock',
+			'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		];
+		$price         = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
+			: null;
+		$price         = $price instanceof EE_Price
+			? $price
+			: EEM_Price::instance()->create_default_object();
+		$price_args    = [
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		];
+		// make sure we have default start and end dates if skeleton
+		// handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			// if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			// get the earliest datetime (if present);
+			$earliest_datetime             = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					['order_by' => ['DTT_EVT_start' => 'ASC']]
+				)
+				: null;
+			$template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
+				? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
+				: date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template      = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values             = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+			],
+			true
+		);
+		// $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event']                          = $this->_cpt_model_obj;
+		$template_args['event']                           = $this->_cpt_model_obj;
+		$template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status']     = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description']             = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array|int         an array of event objects or a count of them.
+	 * @throws Exception
+	 */
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
+	{
+		$EEM_Event   = $this->_event_model();
+		$offset      = ($current_page - 1) * $per_page;
+		$limit       = $count ? null : $offset . ',' . $per_page;
+		$orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$month_range = $this->request->getRequestParam('month_range');
+		if ($month_range) {
+			$pieces = explode(' ', $month_range, 3);
+			// simulate the FIRST day of the month, that fixes issues for months like February
+			// where PHP doesn't know what to assume for date.
+			// @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where  = [];
+		$status = $this->request->getRequestParam('status');
+		// determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				break;
+			case 'draft':
+				$where['status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['status'] = $status;
+		}
+		// categories? The default for all categories is -1
+		$category = $this->request->getRequestParam('EVT_CAT', -1, 'int');
+		if ($category !== -1) {
+			$where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+		// date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if ($month_range) {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone('UTC')
+			);
+			$start    = $DateTime->getTimestamp();
+			// set the datetime to be the end of the month
+			$DateTime->setDate(
+				$year_r,
+				$month_r,
+				$DateTime->format('t')
+			)->setTime(23, 59, 59);
+			$end                             = $DateTime->getTimestamp();
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'today') {
+			$DateTime                        =
+				new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'month') {
+			$now                             = date('Y-m-01');
+			$DateTime                        =
+				new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+														->setTime(23, 59, 59)
+														->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		}
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} else {
+			if (! isset($where['status'])) {
+				if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+					$where['OR'] = [
+						'status*restrict_private' => ['!=', 'private'],
+						'AND'                     => [
+							'status*inclusive' => ['=', 'private'],
+							'EVT_wp_user'      => get_current_user_id(),
+						],
+					];
+				}
+			}
+		}
+		$wp_user = $this->request->getRequestParam('EVT_wp_user', 0, 'int');
+		if (
+			$wp_user
+			&& $wp_user !== get_current_user_id()
+			&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+		) {
+			$where['EVT_wp_user'] = $wp_user;
+		}
+		// search query handling
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'EVT_name'       => ['LIKE', $search_term],
+				'EVT_desc'       => ['LIKE', $search_term],
+				'EVT_short_desc' => ['LIKE', $search_term],
+			];
+		}
+		// filter events by venue.
+		$venue = $this->request->getRequestParam('venue', 0, 'int');
+		if ($venue) {
+			$where['Venue.VNU_ID'] = $venue;
+		}
+		$request_params = $this->request->requestParams();
+		$where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
+		$query_params   = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			[
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			],
+			$request_params
+		);
+
+		// let's first check if we have special requests coming in.
+		$active_status = $this->request->getRequestParam('active_status');
+		if ($active_status) {
+			switch ($active_status) {
+				case 'upcoming':
+					return $EEM_Event->get_upcoming_events($query_params, $count);
+				case 'expired':
+					return $EEM_Event->get_expired_events($query_params, $count);
+				case 'active':
+					return $EEM_Event->get_active_events($query_params, $count);
+				case 'inactive':
+					return $EEM_Event->get_inactive_events($query_params, $count);
+			}
+		}
+
+		return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
+	}
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		throw new EE_Error(
+			esc_html__(
+				'Please contact Event Espresso support with the details of the steps taken to produce this error.',
+				'event_espresso'
+			)
+		);
+		// $this->request->setRequestParam('EVT_ID', $post_id);
+		// $this->_delete_event();
+	}
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @param bool   $redirect_after
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
+	{
+		// determine the event id and set to array.
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if (! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_events($event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (! empty($event_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action  = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * @param int    $EVT_ID
+	 * @param string $event_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
+	{
+		// grab event id
+		if (! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_event_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if (! $success) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function cleanEventIds(array $event_ids)
+	{
+		return array_map('absint', $event_ids);
+	}
+
+
+	/**
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function getEventIdsFromRequest()
+	{
+		if ($this->request->requestParamIsSet('EVT_IDs')) {
+			return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+		} else {
+			return $this->request->getRequestParam('EVT_ID', [], 'int', true);
+		}
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @throws EE_Error
+	 */
+	protected function _delete_event($preview_delete = true)
+	{
+		$this->_delete_events($preview_delete);
+	}
+
+
+	/**
+	 * Gets the tree traversal batch persister.
+	 *
+	 * @return NodeGroupDao
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.12.p
+	 */
+	protected function getModelObjNodeGroupPersister()
+	{
+		if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
+			$this->model_obj_node_group_persister =
+				$this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
+		}
+		return $this->model_obj_node_group_persister;
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _delete_events($preview_delete = true)
+	{
+		$event_ids = $this->getEventIdsFromRequest();
+		if ($preview_delete) {
+			$this->generateDeletionPreview($event_ids);
+		} else {
+			EEM_Event::instance()->delete_permanently([['EVT_ID' => ['IN', $event_ids]]]);
+		}
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 */
+	protected function generateDeletionPreview(array $event_ids)
+	{
+		$event_ids = $this->cleanEventIds($event_ids);
+		// Set a code we can use to reference this deletion task in the batch jobs and preview page.
+		$deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
+		$return_url        = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'            => 'preview_deletion',
+				'deletion_job_code' => $deletion_job_code,
+			],
+			$this->_admin_base_url
+		);
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'              => EED_Batch::PAGE_SLUG,
+					'batch'             => EED_Batch::batch_job,
+					'EVT_IDs'           => $event_ids,
+					'deletion_job_code' => $deletion_job_code,
+					'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
+					'return_url'        => urlencode($return_url),
+				],
+				admin_url()
+			)
+		);
+	}
+
+
+	/**
+	 * Checks for a POST submission
+	 *
+	 * @since 4.10.12.p
+	 */
+	protected function confirmDeletion()
+	{
+		$deletion_redirect_logic =
+			$this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
+		$deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
+	}
+
+
+	/**
+	 * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
+	 *
+	 * @throws EE_Error
+	 * @since 4.10.12.p
+	 */
+	protected function previewDeletion()
+	{
+		$preview_deletion_logic =
+			$this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
+		$this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_events()
+	{
+		return EEM_Event::instance()->count(
+			['caps' => 'read_admin'],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_events_draft()
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => ['IN', ['draft', 'auto-draft']]],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function total_trashed_events()
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => 'trash'],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_HTML::div(
+			$this->_default_event_settings_form()->get_html(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings_form()
+	{
+		$registration_config              = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		// exclude
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			],
+			true
+		);
+		// setup Advanced Editor ???
+		if (
+			$this->raw_req_action === 'default_event_settings'
+			|| $this->raw_req_action === 'update_default_event_settings'
+		) {
+			$this->advanced_editor_admin_form = $this->loader->getShared(AdvancedEditorAdminFormSection::class);
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'update_default_event_settings',
+				'html_id'         => 'update_default_event_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					[
+						'defaults_section_header' => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('Default Settings', 'event_espresso'),
+								'',
+								'ee-admin-settings-hdr'
+							)
+						),
+						'default_reg_status'  => new EE_Select_Input(
+							$registration_stati_for_selection,
+							[
+								'default'         => isset($registration_config->default_STS_ID)
+													 && array_key_exists(
+														 $registration_config->default_STS_ID,
+														 $registration_stati_for_selection
+													 )
+									? sanitize_text_field($registration_config->default_STS_ID)
+									: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													 . EEH_Template::get_help_tab_link(
+														 'default_settings_status_help_tab'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
+									'event_espresso'
+								),
+							]
+						),
+						'default_max_tickets' => new EE_Integer_Input(
+							[
+								'default'         => isset($registration_config->default_maximum_number_of_tickets)
+									? $registration_config->default_maximum_number_of_tickets
+									: EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								)
+													 . EEH_Template::get_help_tab_link(
+														 'default_maximum_tickets_help_tab"'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_default_event_settings()
+	{
+		$form = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$registration_config = EE_Registry::instance()->CFG->registration;
+				$valid_data          = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				do_action(
+					'AHEE__Events_Admin_Page___update_default_event_settings',
+					$valid_data,
+					EE_Registry::instance()->CFG,
+					$this
+				);
+				// update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					esc_html__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
+	}
+
+
+	/*************        Templates        *************
      *
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
-
-    /**
-     * @var AdvancedEditorAdminFormSection
-     */
-    protected $advanced_editor_admin_form;
-
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EVENTS_PG_SLUG;
-        $this->page_label       = EVENTS_LABEL;
-        $this->_admin_base_url  = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_events' => 'edit',
-        ];
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            [$this, 'verify_event_edit'],
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        // load formatter helper
-        // load field generator helper
-        // is there a evt_id in the request?
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
-
-        $this->_page_routes = [
-            'default'                       => [
-                'func'       => '_events_overview_list_table',
-                'capability' => 'ee_read_events',
-            ],
-            'create_new'                    => [
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_events',
-            ],
-            'edit'                          => [
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-            ],
-            'copy_event'                    => [
-                'func'       => '_copy_events',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_event'                   => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_events'                  => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'restore_event'                 => [
-                'func'       => '_trash_or_restore_event',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'restore_events'                => [
-                'func'       => '_trash_or_restore_events',
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'delete_event'                  => [
-                'func'       => '_delete_event',
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'delete_events'                 => [
-                'func'       => '_delete_events',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'view_report'                   => [
-                'func'       => '_view_report',
-                'capability' => 'ee_edit_events',
-            ],
-            'default_event_settings'        => [
-                'func'       => '_default_event_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_default_event_settings' => [
-                'func'       => '_update_default_event_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'template_settings'             => [
-                'func'       => '_template_settings',
-                'capability' => 'manage_options',
-            ],
-            // event category tab related
-            'add_category'                  => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['add'],
-            ],
-            'edit_category'                 => [
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['edit'],
-            ],
-            'delete_categories'             => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'delete_category'               => [
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'insert_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => true],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'update_category'               => [
-                'func'       => '_insert_or_update_category',
-                'args'       => ['new_category' => false],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'category_list'                 => [
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_event_categories',
-            ],
-            'preview_deletion'              => [
-                'func'       => 'previewDeletion',
-                'capability' => 'ee_delete_events',
-            ],
-            'confirm_deletion'              => [
-                'func'       => 'confirmDeletion',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $post_id            = $this->request->getRequestParam('post', 0, 'int');
-        $EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        $this->_page_config = [
-            'default'                => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ],
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_overview_help_tab'                       => [
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ],
-                    'events_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ],
-                    'events_overview_filters_help_tab'               => [
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ],
-                    'events_overview_view_help_tab'                  => [
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ],
-                    'events_overview_other_help_tab'                 => [
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'create_new'             => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
-                'require_nonce' => false,
-            ],
-            'edit'                   => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => $post_id
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            ['post' => $post_id, 'action' => 'edit'],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'default_event_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'labels'        => [
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ],
-                'help_tabs'     => [
-                    'default_settings_help_tab'        => [
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ],
-                    'default_settings_status_help_tab' => [
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ],
-                    'default_maximum_tickets_help_tab' => [
-                        'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // template settings
-            'template_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Templates', 'event_espresso'),
-                    'order' => 30,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'general_settings_templates_help_tab' => [
-                        'title'    => esc_html__('Templates', 'event_espresso'),
-                        'filename' => 'general_settings_templates',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // event category stuff
-            'add_category'           => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'edit_category'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(
-                            ['EVT_CAT_ID' => $EVT_CAT_ID],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => [
-                    'edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'category_list'          => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_categories_help_tab'                       => [
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ],
-                    'events_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ],
-                    'events_categories_view_help_tab'                  => [
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ],
-                    'events_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-            'preview_deletion'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Preview Deletion', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style(
-            'ee-cat-admin',
-            EVENTS_ASSETS_URL . 'ee-cat-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        // scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            ['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        // scripts
-        if (! $this->admin_config->useAdvancedEditor()) {
-            wp_register_script(
-                'event-datetime-metabox',
-                EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-                ['event_editor_js', 'ee-datepicker'],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_script('event-datetime-metabox');
-        }
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
-     * group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param EE_Event $event Event object
-     * @param string   $req_type
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_event_edit($event = null, $req_type = '')
-    {
-        // don't need to do this when processing
-        if (! empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (! $event instanceof EE_Event) {
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        // made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        }
-        if ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        // now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if (! $event->tickets_on_sale()) {
-            return;
-        }
-        // made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if ($this->request->getRequestParam('action') === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            sprintf(
-                esc_html__(
-                    'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
-                    'event_espresso'
-                ),
-                '<a class="espresso-help-tab-lnk ee-help-tab-link">',
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        // only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button--secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all'   => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'draft' => [
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _event_legend_items()
-    {
-        $items    = [
-            'view_details'   => [
-                'class' => 'dashicons dashicons-visibility',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ],
-            'edit_event'     => [
-                'class' => 'dashicons dashicons-calendar-alt',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ],
-            'view_attendees' => [
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ],
-        ];
-        $items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = [
-            'sold_out_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ],
-            'active_status'    => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ],
-            'upcoming_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ],
-            'postponed_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ],
-            'cancelled_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ],
-            'expired_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ],
-            'inactive_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ],
-        ];
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-    /**
-     * @return EEM_Event
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _event_model()
-    {
-        if (! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param string $return    the current html
-     * @param int    $id        the post id for the page
-     * @param string $new_title What the title is
-     * @param string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $post = get_post($id);
-            $return .= '<a class="button button--small button--secondary" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
-                       . esc_html__('Shortcode', 'event_espresso')
-                       . '</a> ';
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
-                       . $post->ID
-                       . ']">';
-        }
-        return $return;
-    }
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _events_overview_list_table()
-    {
-        $after_list_table                           = [];
-        $links_html = EEH_HTML::div('', '', 'ee-admin-section ee-layout-stack');
-        $links_html .= EEH_HTML::h3(esc_html__('Links', 'event_espresso'));
-        $links_html .= EEH_HTML::div(
-            EEH_Template::get_button_or_link(
-                get_post_type_archive_link('espresso_events'),
-                esc_html__('View Event Archive Page', 'event_espresso'),
-                'button button--small button--secondary'
-            ),
-            '',
-            'ee-admin-button-row ee-admin-button-row--align-start'
-        );
-        $links_html .= EEH_HTML::divx();
-
-        $after_list_table['view_event_list_button'] = $links_html;
-
-        $after_list_table['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title                    .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-
-        $this->_template_args['after_list_table']   = array_merge(
-            (array) $this->_template_args['after_list_table'],
-            $after_list_table
-        );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.
-     * Typically you would use this to save any additional data.
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
-     * ALSO very important.  When a post transitions from scheduled to published,
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
-     * other meta saves. So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param WP_Post $post    The post object of the cpt that was saved.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            // get out we're not processing an event save.
-            return;
-        }
-        $event_values = [
-            'EVT_member_only'     => $this->request->getRequestParam('member_only', false, 'bool'),
-            'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, 'bool'),
-            'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
-        ];
-        // check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
-        if (! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
-            $event_values['EVT_display_ticket_selector']     = $this->request->getRequestParam(
-                'display_ticket_selector',
-                false,
-                'bool'
-            );
-            $event_values['EVT_additional_limit']            = min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                $this->request->getRequestParam('additional_limit', null, 'int')
-            );
-            $event_values['EVT_default_registration_status'] = $this->request->getRequestParam(
-                'EVT_default_registration_status',
-                EE_Registry::instance()->CFG->registration->default_STS_ID
-            );
-
-            $event_values['EVT_external_URL'] = $this->request->getRequestParam('externalURL');
-            $event_values['EVT_phone']        = $this->request->getRequestParam('event_phone');
-            $event_values['EVT_display_desc'] = $this->request->getRequestParam('display_desc', false, 'bool');
-        }
-        // update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        // get event_object for other metaboxes...
-        // though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id )..
-        // i have to setup where conditions to override the filters in the model
-        // that filter out autodraft and inherit statuses so we GET the inherit id!
-        $event = $this->_event_model()->get_one(
-            [
-                [
-                    $this->_event_model()->primary_key_name() => $post_id,
-                    'OR'                                      => [
-                        'status'   => $post->post_status,
-                        // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                        // but the returned object here has a status of "publish", so use the original post status as well
-                        'status*1' => $this->request->getRequestParam('original_post_status'),
-                    ],
-                ],
-            ]
-        );
-
-        // the following are default callbacks for event attachment updates
-        // that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = [];
-        if (! $this->admin_config->useAdvancedEditor()) {
-            $event_update_callbacks['_default_venue_update']   = [$this, '_default_venue_update'];
-            $event_update_callbacks['_default_tickets_update'] = [$this, '_default_tickets_update'];
-        }
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            $event_update_callbacks
-        );
-
-        $att_success = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = is_callable($e_callback)
-                ? $e_callback($event, $this->request->requestParams())
-                : false;
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = $_success !== false ? $att_success : false;
-        }
-        // any errors?
-        if ($success && $att_success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @param int $revision_id
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see parent::restore_item()
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        // copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            // meta revision restore
-            $post_evt->restore_revision($revision_id);
-            // related objs restore
-            $post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
-        }
-    }
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param EE_Event $event Event Object to add the venue to
-     * @param array    $data  The request data from the form
-     * @return bool           Success or fail.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _default_venue_update(EE_Event $event, $data)
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = [
-            'VNU_wp_user'         => $event->get('EVT_wp_user'),
-            'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description'])
-                ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        ];
-        // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if (! empty($venue_id)) {
-            $update_where  = [$venue_model->primary_key_name() => $venue_id];
-            $rows_affected = $venue_model->update($venue_array, [$update_where]);
-            // we've gotta make sure that the venue is always attached to a revision..
-            // add_relation_to should take care of making sure that the relation is already present.
-            $event->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0;
-        }
-        // we insert the venue
-        $venue_id = $venue_model->insert($venue_array);
-        $event->_add_relation_to($venue_id, 'Venue');
-        return ! empty($venue_id);
-        // when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param EE_Event $event The Event object we're attaching data to
-     * @param array    $data  The request data from the form
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _default_tickets_update(EE_Event $event, $data)
-    {
-        if ($this->admin_config->useAdvancedEditor()) {
-            return [];
-        }
-        $datetime       = null;
-        $saved_tickets  = [];
-        $event_timezone = $event->get_timezone();
-        $date_formats   = ['Y-m-d', 'h:i a'];
-        foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
-            // trim all values to ensure any excess whitespace is removed.
-            $datetime_data                = array_map('trim', $datetime_data);
-            $datetime_data['DTT_EVT_end'] =
-                isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
-                    ? $datetime_data['DTT_EVT_end']
-                    : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = [
-                'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
-                'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
-                'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            ];
-            // if we have an id then let's get existing object first and then set the new values.
-            //  Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
-                $datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
-                if (! $datetime instanceof EE_Datetime) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $datetime_data['DTT_ID']
-                        )
-                    );
-                }
-                $datetime->set_date_format($date_formats[0]);
-                $datetime->set_time_format($date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-            } else {
-                $datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
-            }
-            if (! $datetime instanceof EE_Datetime) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($datetime_values, true)
-                    )
-                );
-            }
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
-                $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
-                $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
-            }
-            $datetime->save();
-            $event->_add_relation_to($datetime, 'Datetime');
-        }
-        // no datetimes get deleted so we don't do any of that logic here.
-        // update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
-
-        // set up some default start and end dates in case those are not present in the incoming data
-        $default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
-        $default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
-        // use the start date of the first datetime for the end date
-        $first_datetime   = $event->first_datetime();
-        $default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
-
-        // now process the incoming data
-        foreach ($data['edit_tickets'] as $row => $ticket_data) {
-            $update_prices = false;
-            $ticket_price  = isset($data['edit_prices'][ $row ][1]['PRC_amount'])
-                ? $data['edit_prices'][ $row ][1]['PRC_amount']
-                : 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $ticket_data   = array_map('trim', $ticket_data);
-            $ticket_values = [
-                'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
-                'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
-                'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
-                    ? $ticket_data['TKT_start_date']
-                    : $default_start_date,
-                'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
-                    ? $ticket_data['TKT_end_date']
-                    : $default_end_date,
-                'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
-                                     || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
-                    ? $ticket_data['TKT_qty']
-                    : EE_INF,
-                'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
-                                     || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
-                    ? $ticket_data['TKT_uses']
-                    : EE_INF,
-                'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
-                'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
-                'TKT_order'       => isset($ticket_data['TKT_order']) ? $ticket_data['TKT_order'] : $row,
-                'TKT_price'       => $ticket_price,
-                'TKT_row'         => $row,
-            ];
-            // if this is a default ticket, then we need to set the TKT_ID to 0 and update accordingly,
-            // which means in turn that the prices will become new prices as well.
-            if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
-                $ticket_values['TKT_ID']         = 0;
-                $ticket_values['TKT_is_default'] = 0;
-                $update_prices                   = true;
-            }
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves ahead of adding any relations because its entirely possible that this
-            // ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
-            // keep in mind that if the ticket has been sold (and we have changed pricing information),
-            // then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (! empty($ticket_data['TKT_ID'])) {
-                $existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
-                if (! $existing_ticket instanceof EE_Ticket) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $ticket_data['TKT_ID']
-                        )
-                    );
-                }
-                $ticket_sold = $existing_ticket->count_related(
-                    'Registration',
-                    [
-                            [
-                                'STS_ID' => [
-                                    'NOT IN',
-                                    [EEM_Registration::status_id_incomplete],
-                                ],
-                            ],
-                        ]
-                ) > 0;
-                // let's just check the total price for the existing ticket and determine if it matches the new total price.
-                // if they are different then we create a new ticket (if $ticket_sold)
-                // if they aren't different then we go ahead and modify existing ticket.
-                $create_new_ticket = $ticket_sold
-                                     && $ticket_price !== $existing_ticket->price()
-                                     && ! $existing_ticket->deleted();
-                $existing_ticket->set_date_format($date_formats[0]);
-                $existing_ticket->set_time_format($date_formats[1]);
-                // set new values
-                foreach ($ticket_values as $field => $value) {
-                    if ($field == 'TKT_qty') {
-                        $existing_ticket->set_qty($value);
-                    } elseif ($field == 'TKT_price') {
-                        $existing_ticket->set('TKT_price', $ticket_price);
-                    } else {
-                        $existing_ticket->set($field, $value);
-                    }
-                }
-                $ticket = $existing_ticket;
-                // if $create_new_ticket is false then we can safely update the existing ticket.
-                //  Otherwise we have to create a new ticket.
-                if ($create_new_ticket) {
-                    // archive the old ticket first
-                    $existing_ticket->set('TKT_deleted', 1);
-                    $existing_ticket->save();
-                    // make sure this ticket is still recorded in our $saved_tickets
-                    // so we don't run it through the regular trash routine.
-                    $saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
-                    // create new ticket that's a copy of the existing except,
-                    // (a new id of course and not archived) AND has the new TKT_price associated with it.
-                    $new_ticket = clone $existing_ticket;
-                    $new_ticket->set('TKT_ID', 0);
-                    $new_ticket->set('TKT_deleted', 0);
-                    $new_ticket->set('TKT_sold', 0);
-                    // now we need to make sure that $new prices are created as well and attached to new ticket.
-                    $update_prices = true;
-                    $ticket        = $new_ticket;
-                }
-            } else {
-                // no TKT_id so a new ticket
-                $ticket_values['TKT_price'] = $ticket_price;
-                $ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
-                $update_prices              = true;
-            }
-            if (! $ticket instanceof EE_Ticket) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($ticket_values, true)
-                    )
-                );
-            }
-            // cap ticket qty by datetime reg limits
-            $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
-            // update ticket.
-            $ticket->save();
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
-                $ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
-                $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
-                $ticket->save();
-            }
-            // initially let's add the ticket to the datetime
-            $datetime->_add_relation_to($ticket, 'Ticket');
-            $saved_tickets[ $ticket->ID() ] = $ticket;
-            // add prices to ticket
-            $prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
-                : [];
-            $this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
-        }
-        // however now we need to handle permanently deleting tickets via the ui.
-        // Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.
-        // However, it does allow for deleting tickets that have no tickets sold,
-        // in which case we want to get rid of permanently because there is no need to save in db.
-        $old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            // get the ticket for this id
-            $ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
-            if (! $ticket_to_remove instanceof EE_Ticket) {
-                continue;
-            }
-            // need to get all the related datetimes on this ticket and remove from every single one of them
-            // (remember this process can ONLY kick off if there are NO tickets sold)
-            $related_datetimes = $ticket_to_remove->get_many_related('Datetime');
-            foreach ($related_datetimes as $related_datetime) {
-                $ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
-            }
-            // need to do the same for prices (except these prices can also be deleted because again,
-            // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $ticket_to_remove->delete_related_permanently('Price');
-            // finally let's delete this ticket
-            // (which should not be blocked at this point b/c we've removed all our relationships)
-            $ticket_to_remove->delete_permanently();
-        }
-        return [$datetime, $saved_tickets];
-    }
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices)
-     * because if there is a change in price information on a ticket, a new ticket is created anyways
-     * so the archived ticket will retain the old price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices_data Array of prices from the form.
-     * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
-     * @return  void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _add_prices_to_ticket($prices_data, EE_Ticket $ticket, $new_prices = false)
-    {
-        $timezone = $ticket->get_timezone();
-        foreach ($prices_data as $row => $price_data) {
-            $price_values = [
-                'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
-                'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
-                'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            ];
-            if ($new_prices || empty($price_values['PRC_ID'])) {
-                $price_values['PRC_ID'] = 0;
-                $price                  = EE_Price::new_instance($price_values, $timezone);
-            } else {
-                $price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
-                // update this price with new values
-                foreach ($price_values as $field => $new_price) {
-                    $price->set($field, $new_price);
-                }
-            }
-            if (! $price instanceof EE_Price) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($price_values, true)
-                    )
-                );
-            }
-            $price->save();
-            $ticket->_add_relation_to($price, 'Price');
-        }
-    }
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        // load formatter helper
-        // args for getting related registrations
-        $approved_query_args        = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ],
-        ];
-        $not_approved_query_args    = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ],
-        ];
-        $pending_payment_query_args = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ],
-        ];
-        // publish box
-        $publish_box_extra_args = [
-            'view_approved_reg_url'        => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ],
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        ];
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        $use_advanced_editor = $this->admin_config->useAdvancedEditor();
-        // check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
-        if (! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
-            $this->addMetaBox(
-                'espresso_event_editor_event_options',
-                esc_html__('Event Registration Options', 'event_espresso'),
-                [$this, 'registration_options_meta_box'],
-                $this->page_slug,
-                'side'
-            );
-        }
-        if (! $use_advanced_editor) {
-            $this->addMetaBox(
-                'espresso_event_editor_tickets',
-                esc_html__('Event Datetime & Ticket', 'event_espresso'),
-                [$this, 'ticket_metabox'],
-                $this->page_slug,
-                'normal',
-                'high'
-            );
-        } elseif ($this->feature->allowed('use_reg_options_meta_box')) {
-            add_action(
-                'add_meta_boxes_espresso_events',
-                function () {
-                    global $current_screen;
-                    remove_meta_box('authordiv', $current_screen, 'normal');
-                },
-                99
-            );
-        }
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = [];
-        // defaults for template args
-        $template_args = [
-            'existing_datetime_ids'    => '',
-            'event_datetime_help_link' => '',
-            'ticket_options_help_link' => '',
-            'time'                     => null,
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'trash_icon'               => 'dashicons dashicons-lock',
-            'disabled'                 => '',
-        ];
-        $event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        /** @var EEM_Datetime $datetime_model */
-        $datetime_model = EE_Registry::instance()->load_model('Datetime');
-        /** @var EEM_Ticket $datetime_model */
-        $ticket_model = EE_Registry::instance()->load_model('Ticket');
-        $times        = $datetime_model->get_all_event_dates($event_id);
-        /** @type EE_Datetime $first_datetime */
-        $first_datetime = reset($times);
-        // do we get related tickets?
-        if (
-            $first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time']   = $first_datetime;
-            $related_tickets         = $first_datetime->tickets(
-                [
-                    ['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
-                    'default_where_conditions' => 'none',
-                ]
-            );
-            if (! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row                                = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[]        = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket                       = $ticket_model->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time'] = $times[0];
-            /** @type EE_Ticket[] $tickets */
-            $tickets                      = $ticket_model->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure']      = $this->_get_ticket_row(
-            $ticket_model->create_default_object(),
-            true
-        );
-        $template                                  = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param EE_Ticket $ticket   the ticket object
-     * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int       $row
-     * @return string generated html for the ticket row.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
-    {
-        $template_args = [
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'dashicons dashicons-lock',
-            'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        ];
-        $price         = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
-            : null;
-        $price         = $price instanceof EE_Price
-            ? $price
-            : EEM_Price::instance()->create_default_object();
-        $price_args    = [
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        ];
-        // make sure we have default start and end dates if skeleton
-        // handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            // if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            // get the earliest datetime (if present);
-            $earliest_datetime             = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    ['order_by' => ['DTT_EVT_start' => 'ASC']]
-                )
-                : null;
-            $template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
-                ? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
-                : date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template      = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values             = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-            ],
-            true
-        );
-        // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event']                          = $this->_cpt_model_obj;
-        $template_args['event']                           = $this->_cpt_model_obj;
-        $template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status']     = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array|int         an array of event objects or a count of them.
-     * @throws Exception
-     */
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
-    {
-        $EEM_Event   = $this->_event_model();
-        $offset      = ($current_page - 1) * $per_page;
-        $limit       = $count ? null : $offset . ',' . $per_page;
-        $orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $month_range = $this->request->getRequestParam('month_range');
-        if ($month_range) {
-            $pieces = explode(' ', $month_range, 3);
-            // simulate the FIRST day of the month, that fixes issues for months like February
-            // where PHP doesn't know what to assume for date.
-            // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where  = [];
-        $status = $this->request->getRequestParam('status');
-        // determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                break;
-            case 'draft':
-                $where['status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['status'] = $status;
-        }
-        // categories? The default for all categories is -1
-        $category = $this->request->getRequestParam('EVT_CAT', -1, 'int');
-        if ($category !== -1) {
-            $where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-        // date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if ($month_range) {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone('UTC')
-            );
-            $start    = $DateTime->getTimestamp();
-            // set the datetime to be the end of the month
-            $DateTime->setDate(
-                $year_r,
-                $month_r,
-                $DateTime->format('t')
-            )->setTime(23, 59, 59);
-            $end                             = $DateTime->getTimestamp();
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'today') {
-            $DateTime                        =
-                new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'month') {
-            $now                             = date('Y-m-01');
-            $DateTime                        =
-                new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                                                        ->setTime(23, 59, 59)
-                                                        ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        }
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } else {
-            if (! isset($where['status'])) {
-                if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                    $where['OR'] = [
-                        'status*restrict_private' => ['!=', 'private'],
-                        'AND'                     => [
-                            'status*inclusive' => ['=', 'private'],
-                            'EVT_wp_user'      => get_current_user_id(),
-                        ],
-                    ];
-                }
-            }
-        }
-        $wp_user = $this->request->getRequestParam('EVT_wp_user', 0, 'int');
-        if (
-            $wp_user
-            && $wp_user !== get_current_user_id()
-            && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-        ) {
-            $where['EVT_wp_user'] = $wp_user;
-        }
-        // search query handling
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'EVT_name'       => ['LIKE', $search_term],
-                'EVT_desc'       => ['LIKE', $search_term],
-                'EVT_short_desc' => ['LIKE', $search_term],
-            ];
-        }
-        // filter events by venue.
-        $venue = $this->request->getRequestParam('venue', 0, 'int');
-        if ($venue) {
-            $where['Venue.VNU_ID'] = $venue;
-        }
-        $request_params = $this->request->requestParams();
-        $where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
-        $query_params   = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            [
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ],
-            $request_params
-        );
-
-        // let's first check if we have special requests coming in.
-        $active_status = $this->request->getRequestParam('active_status');
-        if ($active_status) {
-            switch ($active_status) {
-                case 'upcoming':
-                    return $EEM_Event->get_upcoming_events($query_params, $count);
-                case 'expired':
-                    return $EEM_Event->get_expired_events($query_params, $count);
-                case 'active':
-                    return $EEM_Event->get_active_events($query_params, $count);
-                case 'inactive':
-                    return $EEM_Event->get_inactive_events($query_params, $count);
-            }
-        }
-
-        return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
-    }
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_cpt_item($post_id)
-    {
-        throw new EE_Error(
-            esc_html__(
-                'Please contact Event Espresso support with the details of the steps taken to produce this error.',
-                'event_espresso'
-            )
-        );
-        // $this->request->setRequestParam('EVT_ID', $post_id);
-        // $this->_delete_event();
-    }
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param string $event_status
-     * @param bool   $redirect_after
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
-    {
-        // determine the event id and set to array.
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if (! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param string $event_status
-     * @return void
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_events($event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (! empty($event_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action  = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * @param int    $EVT_ID
-     * @param string $event_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
-    {
-        // grab event id
-        if (! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_event_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if (! $success) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param array $event_ids
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function cleanEventIds(array $event_ids)
-    {
-        return array_map('absint', $event_ids);
-    }
-
-
-    /**
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function getEventIdsFromRequest()
-    {
-        if ($this->request->requestParamIsSet('EVT_IDs')) {
-            return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-        } else {
-            return $this->request->getRequestParam('EVT_ID', [], 'int', true);
-        }
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @throws EE_Error
-     */
-    protected function _delete_event($preview_delete = true)
-    {
-        $this->_delete_events($preview_delete);
-    }
-
-
-    /**
-     * Gets the tree traversal batch persister.
-     *
-     * @return NodeGroupDao
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.12.p
-     */
-    protected function getModelObjNodeGroupPersister()
-    {
-        if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
-            $this->model_obj_node_group_persister =
-                $this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
-        }
-        return $this->model_obj_node_group_persister;
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _delete_events($preview_delete = true)
-    {
-        $event_ids = $this->getEventIdsFromRequest();
-        if ($preview_delete) {
-            $this->generateDeletionPreview($event_ids);
-        } else {
-            EEM_Event::instance()->delete_permanently([['EVT_ID' => ['IN', $event_ids]]]);
-        }
-    }
-
-
-    /**
-     * @param array $event_ids
-     */
-    protected function generateDeletionPreview(array $event_ids)
-    {
-        $event_ids = $this->cleanEventIds($event_ids);
-        // Set a code we can use to reference this deletion task in the batch jobs and preview page.
-        $deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
-        $return_url        = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'            => 'preview_deletion',
-                'deletion_job_code' => $deletion_job_code,
-            ],
-            $this->_admin_base_url
-        );
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'              => EED_Batch::PAGE_SLUG,
-                    'batch'             => EED_Batch::batch_job,
-                    'EVT_IDs'           => $event_ids,
-                    'deletion_job_code' => $deletion_job_code,
-                    'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
-                    'return_url'        => urlencode($return_url),
-                ],
-                admin_url()
-            )
-        );
-    }
-
-
-    /**
-     * Checks for a POST submission
-     *
-     * @since 4.10.12.p
-     */
-    protected function confirmDeletion()
-    {
-        $deletion_redirect_logic =
-            $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion');
-        $deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
-    }
-
-
-    /**
-     * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
-     *
-     * @throws EE_Error
-     * @since 4.10.12.p
-     */
-    protected function previewDeletion()
-    {
-        $preview_deletion_logic =
-            $this->getLoader()->getShared('\EventEspresso\core\domain\services\admin\events\data\PreviewDeletion');
-        $this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_events()
-    {
-        return EEM_Event::instance()->count(
-            ['caps' => 'read_admin'],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_events_draft()
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => ['IN', ['draft', 'auto-draft']]],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function total_trashed_events()
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => 'trash'],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_HTML::div(
-            $this->_default_event_settings_form()->get_html(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _default_event_settings_form()
-    {
-        $registration_config              = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        // exclude
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ],
-            true
-        );
-        // setup Advanced Editor ???
-        if (
-            $this->raw_req_action === 'default_event_settings'
-            || $this->raw_req_action === 'update_default_event_settings'
-        ) {
-            $this->advanced_editor_admin_form = $this->loader->getShared(AdvancedEditorAdminFormSection::class);
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'update_default_event_settings',
-                'html_id'         => 'update_default_event_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    [
-                        'defaults_section_header' => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('Default Settings', 'event_espresso'),
-                                '',
-                                'ee-admin-settings-hdr'
-                            )
-                        ),
-                        'default_reg_status'  => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            [
-                                'default'         => isset($registration_config->default_STS_ID)
-                                                     && array_key_exists(
-                                                         $registration_config->default_STS_ID,
-                                                         $registration_stati_for_selection
-                                                     )
-                                    ? sanitize_text_field($registration_config->default_STS_ID)
-                                    : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_settings_status_help_tab'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'default_max_tickets' => new EE_Integer_Input(
-                            [
-                                'default'         => isset($registration_config->default_maximum_number_of_tickets)
-                                    ? $registration_config->default_maximum_number_of_tickets
-                                    : EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                )
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_maximum_tickets_help_tab"'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_default_event_settings()
-    {
-        $form = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $registration_config = EE_Registry::instance()->CFG->registration;
-                $valid_data          = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                do_action(
-                    'AHEE__Events_Admin_Page___update_default_event_settings',
-                    $valid_data,
-                    EE_Registry::instance()->CFG,
-                    $this
-                );
-                // update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    esc_html__('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
-    }
-
-
-    /*************        Templates        *************
-     *
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="'
-                                                . EVENTS_ASSETS_URL
-                                                . '/images/'
-                                                . 'caffeinated_template_features.jpg" alt="'
-                                                . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                                . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        // set default category object
-        $this->_set_empty_category_object();
-        // only set if we've got an id
-        $category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        if (! $category_ID) {
-            return;
-        }
-        $term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-        if (! empty($term)) {
-            $this->_category->category_name       = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc       = $term->description;
-            $this->_category->id                  = $term->term_id;
-            $this->_category->parent              = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category                = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id            = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ';
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details view.
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _category_details($view)
-    {
-        // load formatter helper
-        // load field generator helper
-        $route = $view === 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id            = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        // custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'category_list'],
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details content.
-     *
-     * @throws DomainException
-     */
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms                    = get_terms(
-            [EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args   = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     *
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
-        foreach ($category_IDs as $category_ID) {
-            $this->_delete_category($category_ID);
-        }
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    /**
-     * Handles deleting specific category.
-     *
-     * @param int $cat_id
-     */
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-    }
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     *
-     * @param bool $new_category true means we're triggering the insert of a new category.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    /**
-     * Inserts or updates category
-     *
-     * @param bool $update (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category($update = false)
-    {
-        $category_ID         = $update ? $this->request->getRequestParam('EVT_CAT_ID', 0, 'int') : 0;
-        $category_name       = $this->request->getRequestParam('category_name', '');
-        $category_desc       = $this->request->getRequestParam('category_desc', '');
-        $category_parent     = $this->request->getRequestParam('category_parent', 0, 'int');
-        $category_identifier = $this->request->getRequestParam('category_identifier', '');
-
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-        // was the category_identifier input disabled?
-        if ($category_identifier) {
-            $term_args['slug'] = $category_identifier;
-        }
-        $insert_ids = $update
-            ? wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
-            : wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
-        if (! is_array($insert_ids)) {
-            $msg = esc_html__(
-                'An error occurred and the category has not been saved to the database.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $category_ID = $insert_ids['term_id'];
-            $msg         = sprintf(
-                esc_html__('The category %s was successfully saved', 'event_espresso'),
-                $category_name
-            );
-            EE_Error::add_success($msg);
-        }
-        return $category_ID;
-    }
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     *
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Term_Taxonomy[]|int
-     * @throws EE_Error
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        // testing term stuff
-        $orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $limit       = ($current_page - 1) * $per_page;
-        $where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $search_term],
-                'description' => ['LIKE', $search_term],
-            ];
-        }
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-        return $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-    }
-
-    /* end category stuff */
-
-
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function saveTimezoneString()
-    {
-        $timezone_string = $this->request->getRequestParam('timezone_selected');
-        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
-            EE_Error::add_error(
-                esc_html__('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, ['action' => 'create_new']);
-    }
-
-
-    /**
      * @throws EE_Error
-     * @deprecated 4.10.25.p
      */
-    public function save_timezonestring_setting()
-    {
-        $this->saveTimezoneString();
-    }
+	protected function _template_settings()
+	{
+		$this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="'
+												. EVENTS_ASSETS_URL
+												. '/images/'
+												. 'caffeinated_template_features.jpg" alt="'
+												. esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+												. '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		// set default category object
+		$this->_set_empty_category_object();
+		// only set if we've got an id
+		$category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		if (! $category_ID) {
+			return;
+		}
+		$term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+		if (! empty($term)) {
+			$this->_category->category_name       = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc       = $term->description;
+			$this->_category->id                  = $term->term_id;
+			$this->_category->parent              = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category                = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id            = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ';
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details view.
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _category_details($view)
+	{
+		// load formatter helper
+		// load field generator helper
+		$route = $view === 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id            = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		// custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'category_list'],
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details content.
+	 *
+	 * @throws DomainException
+	 */
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms                    = get_terms(
+			[EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args   = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
+		foreach ($category_IDs as $category_ID) {
+			$this->_delete_category($category_ID);
+		}
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	/**
+	 * Handles deleting specific category.
+	 *
+	 * @param int $cat_id
+	 */
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+	}
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 *
+	 * @param bool $new_category true means we're triggering the insert of a new category.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id  = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Inserts or updates category
+	 *
+	 * @param bool $update (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category($update = false)
+	{
+		$category_ID         = $update ? $this->request->getRequestParam('EVT_CAT_ID', 0, 'int') : 0;
+		$category_name       = $this->request->getRequestParam('category_name', '');
+		$category_desc       = $this->request->getRequestParam('category_desc', '');
+		$category_parent     = $this->request->getRequestParam('category_parent', 0, 'int');
+		$category_identifier = $this->request->getRequestParam('category_identifier', '');
+
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+		// was the category_identifier input disabled?
+		if ($category_identifier) {
+			$term_args['slug'] = $category_identifier;
+		}
+		$insert_ids = $update
+			? wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
+			: wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
+		if (! is_array($insert_ids)) {
+			$msg = esc_html__(
+				'An error occurred and the category has not been saved to the database.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$category_ID = $insert_ids['term_id'];
+			$msg         = sprintf(
+				esc_html__('The category %s was successfully saved', 'event_espresso'),
+				$category_name
+			);
+			EE_Error::add_success($msg);
+		}
+		return $category_ID;
+	}
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 *
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Term_Taxonomy[]|int
+	 * @throws EE_Error
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		// testing term stuff
+		$orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$limit       = ($current_page - 1) * $per_page;
+		$where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $search_term],
+				'description' => ['LIKE', $search_term],
+			];
+		}
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+		return $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+	}
+
+	/* end category stuff */
+
+
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function saveTimezoneString()
+	{
+		$timezone_string = $this->request->getRequestParam('timezone_selected');
+		if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
+			EE_Error::add_error(
+				esc_html__('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, ['action' => 'create_new']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @deprecated 4.10.25.p
+	 */
+	public function save_timezonestring_setting()
+	{
+		$this->saveTimezoneString();
+	}
 }

core/domain/services/admin/events/data/ConfirmDeletion.php

Indentation +76 added lines, -76 removed lines

@@ -30,86 +30,86 @@
  */
 class ConfirmDeletion
 {
-    /**
-     * @var NodeGroupDao
-     */
-    private $dao;
+	/**
+	 * @var NodeGroupDao
+	 */
+	private $dao;
 
-    /**
-     * ConfirmDeletion constructor.
-     * @param NodeGroupDao $dao
-     */
-    public function __construct(
-        NodeGroupDao $dao
-    ) {
+	/**
+	 * ConfirmDeletion constructor.
+	 * @param NodeGroupDao $dao
+	 */
+	public function __construct(
+		NodeGroupDao $dao
+	) {
 
-        $this->dao = $dao;
-    }
+		$this->dao = $dao;
+	}
 
-    /**
-     * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
-     * preview page.
-     * @since 4.10.12.p
-     * @param $request_data
-     * @param $admin_base_url
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    public function handle($request_data, $admin_base_url)
-    {
-        $deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
-        $models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
-        $form = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
-        // Initialize the form from the request, and check if its valid.
-        $form->receive_form_submission($request_data);
-        if ($form->is_valid()) {
-            // Redirect the user to the deletion batch job.
-            EEH_URL::safeRedirectAndExit(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page' => EED_Batch::PAGE_SLUG,
-                        'batch' => EED_Batch::batch_job,
-                        'deletion_job_code' => $deletion_job_code,
-                        'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\ExecuteBatchDeletion'),
-                        'return_url' => urlencode(
-                            add_query_arg(
-                                [
-                                    'status' => 'trash'
-                                ],
-                                EVENTS_ADMIN_URL
-                            )
-                        )
-                    ),
-                    admin_url()
-                )
-            );
-        }
-        // Dont' use $form->submission_error_message() because it adds the form input's label in front
-        // of each validation error which ends up looking quite confusing.
-        $validation_errors = $form->get_validation_errors_accumulated();
-        foreach ($validation_errors as $validation_error) {
-            EE_Error::add_error(
-                $validation_error->getMessage(),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
+	/**
+	 * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
+	 * preview page.
+	 * @since 4.10.12.p
+	 * @param $request_data
+	 * @param $admin_base_url
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	public function handle($request_data, $admin_base_url)
+	{
+		$deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
+		$models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
+		$form = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
+		// Initialize the form from the request, and check if its valid.
+		$form->receive_form_submission($request_data);
+		if ($form->is_valid()) {
+			// Redirect the user to the deletion batch job.
+			EEH_URL::safeRedirectAndExit(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page' => EED_Batch::PAGE_SLUG,
+						'batch' => EED_Batch::batch_job,
+						'deletion_job_code' => $deletion_job_code,
+						'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\ExecuteBatchDeletion'),
+						'return_url' => urlencode(
+							add_query_arg(
+								[
+									'status' => 'trash'
+								],
+								EVENTS_ADMIN_URL
+							)
+						)
+					),
+					admin_url()
+				)
+			);
+		}
+		// Dont' use $form->submission_error_message() because it adds the form input's label in front
+		// of each validation error which ends up looking quite confusing.
+		$validation_errors = $form->get_validation_errors_accumulated();
+		foreach ($validation_errors as $validation_error) {
+			EE_Error::add_error(
+				$validation_error->getMessage(),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
 
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action' => 'preview_deletion',
-                    'deletion_job_code' => $deletion_job_code
-                ],
-                $admin_base_url
-            )
-        );
-    }
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action' => 'preview_deletion',
+					'deletion_job_code' => $deletion_job_code
+				],
+				$admin_base_url
+			)
+		);
+	}
 }
 // End of file ConfirmDeletion.php
 // Location: EventEspresso\core\domain\services\admin\events\data/ConfirmDeletion.php

core/libraries/form_sections/inputs/EE_Select_Input.input.php

Indentation +12 added lines, -12 removed lines

@@ -13,16 +13,16 @@
  */
 class EE_Select_Input extends EE_Form_Input_With_Options_Base
 {
-    /**
-     * @param array $answer_options
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Select_Display_Strategy($answer_options));
-        $this->_add_validation_strategy(
-            new EE_Enum_Validation_Strategy($input_settings['validation_error_message'] ?? null)
-        );
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $answer_options
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Select_Display_Strategy($answer_options));
+		$this->_add_validation_strategy(
+			new EE_Enum_Validation_Strategy($input_settings['validation_error_message'] ?? null)
+		);
+		parent::__construct($answer_options, $input_settings);
+	}
 }

core/libraries/form_sections/inputs/EE_Radio_Button_Input.input.php

Indentation +13 added lines, -13 removed lines

@@ -11,17 +11,17 @@
  */
 class EE_Radio_Button_Input extends EE_Form_Input_With_Options_Base
 {
-    /**
-     * @param array $answer_options
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Radio_Button_Display_Strategy());
-        $this->_add_validation_strategy(
-            new EE_Enum_Validation_Strategy($input_settings['validation_error_message'] ?? null)
-        );
-        $this->_multiple_selections = false;
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $answer_options
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Radio_Button_Display_Strategy());
+		$this->_add_validation_strategy(
+			new EE_Enum_Validation_Strategy($input_settings['validation_error_message'] ?? null)
+		);
+		$this->_multiple_selections = false;
+		parent::__construct($answer_options, $input_settings);
+	}
 }

core/libraries/batch/JobHandlers/DatetimeOffsetFix.php

Indentation +467 added lines, -467 removed lines

@@ -23,471 +23,471 @@
 
 class DatetimeOffsetFix extends JobHandler
 {
-    /**
-     * Key for the option used to track which models have been processed when doing the batches.
-     */
-    const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
-
-
-    const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
-
-    /**
-     * Key for the option used to track what the current offset is that will be applied when this tool is executed.
-     */
-    const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
-
-
-    const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
-
-
-    const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
-
-
-    /**
-     * String labelling the datetime offset fix type for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
-
-
-    /**
-     * String labelling a datetime offset fix error for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
-
-    /**
-     * @var EEM_Base[]
-     */
-    protected $models_with_datetime_fields = array();
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $models_with_datetime_fields = $this->getModelsWithDatetimeFields();
-        // we'll be doing each model as a batch.
-        $job_parameters->set_job_size(count($models_with_datetime_fields));
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Starting Datetime Offset Fix', 'event_espresso')
-        );
-    }
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        $models_to_process = $this->getModelsWithDatetimeFields();
-        // let's pop off the a model and do the query to apply the offset.
-        $model_to_process = array_pop($models_to_process);
-        // update our record
-        $this->setModelsToProcess($models_to_process);
-        $this->processModel($model_to_process);
-        $this->updateCountOfModelsProcessed();
-        $job_parameters->set_units_processed($this->getCountOfModelsProcessed());
-        if (count($models_to_process) > 0) {
-            $job_parameters->set_status(JobParameters::status_continue);
-        } else {
-            $job_parameters->set_status(JobParameters::status_complete);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
-                $model_to_process
-            )
-        );
-    }
-
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        // delete important saved options.
-        delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
-        delete_option(self::COUNT_OF_MODELS_PROCESSED);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
-        return new JobStepResponse($job_parameters, esc_html__(
-            'Offset has been applied to all affected fields.',
-            'event_espresso'
-        ));
-    }
-
-
-    /**
-     * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
-     *
-     * @param string $model_class_name
-     * @throws EE_Error
-     */
-    protected function processModel($model_class_name)
-    {
-        global $wpdb;
-        /** @var EEM_Base $model */
-        $model = $model_class_name::instance();
-        $original_offset = self::getOffset();
-        $start_date_range = self::getStartDateRange();
-        $end_date_range = self::getEndDateRange();
-        $sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
-        $offset = abs($original_offset) * 60;
-        $date_ranges = array();
-        // since some affected models might have two tables, we have to get our tables and set up a query for each table.
-        foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
-            $fields_affected = array();
-            $inner_query = array();
-            foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
-                if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
-                                                                       . $model_field->get_table_column()
-                                                                       . ", INTERVAL {$offset} MINUTE)";
-                    $fields_affected[] = $model_field;
-                }
-            }
-            if (! $fields_affected) {
-                continue;
-            }
-            // do we do one query per column/field or one query for all fields on the model? It all depends on whether
-            // there is a date range applied or not.
-            if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
-                $result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
-            } else {
-                $result = $this->doQueryForAllFields($query, $inner_query);
-            }
-
-            // record appropriate logs for the query
-            switch (true) {
-                case $result === false:
-                    // record error.
-                    $error_message = $wpdb->last_error;
-                    // handle the edge cases where last_error might be empty.
-                    if (! $error_message) {
-                        $error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
-                    }
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
-                    break;
-                case is_array($result) && ! empty($result):
-                    foreach ($result as $field_name => $error_message) {
-                        $this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
-                    }
-                    break;
-                default:
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected);
-            }
-        }
-    }
-
-
-    /**
-     * Does the query on each $inner_query individually.
-     *
-     * @param string              $query
-     * @param array               $inner_query
-     * @param DbSafeDateTime|null $start_date_range
-     * @param DbSafeDateTime|null $end_date_range
-     * @return array  An array of any errors encountered and the fields they were for.
-     */
-    private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
-    {
-        global $wpdb;
-        $errors = array();
-        foreach ($inner_query as $field_name => $field_query) {
-            $query_to_run = $query;
-            $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
-            if ($start_date_range instanceof DbSafeDateTime) {
-                $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} > '{$start_date}'";
-            }
-            if ($end_date_range instanceof DbSafeDateTime) {
-                $end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} < '{$end_date}'";
-            }
-            if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
-            }
-            $result = $wpdb->query($query_to_run);
-            if ($result === false) {
-                // record error.
-                $error_message = $wpdb->last_error;
-                // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
-                    $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
-                }
-                $errors[ $field_name ] = $error_message;
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * Performs the query for all fields within the inner_query
-     *
-     * @param string $query
-     * @param array  $inner_query
-     * @return false|int
-     */
-    private function doQueryForAllFields($query, array $inner_query)
-    {
-        global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * Records a changelog entry using the given information.
-     *
-     * @param EEM_Base              $model
-     * @param float                 $offset
-     * @param EE_Table_Base         $table
-     * @param EE_Model_Field_Base[] $model_fields_affected
-     * @param string                $error_message If present then there was an error so let's record that instead.
-     * @throws EE_Error
-     */
-    private function recordChangeLog(
-        EEM_Base $model,
-        $offset,
-        EE_Table_Base $table,
-        $model_fields_affected,
-        $error_message = ''
-    ) {
-        // setup $fields list.
-        $fields = array();
-        /** @var EE_Datetime_Field $model_field */
-        foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
-                continue;
-            }
-            $fields[] = $model_field->get_name();
-        }
-        // setup the message for the changelog entry.
-        $message = $error_message
-            ? sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields),
-                $error_message
-            )
-            : sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields)
-            );
-        // write to the log
-        $changelog = EE_Change_Log::new_instance(array(
-            'LOG_type'    => $error_message
-                ? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
-                : self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
-            'LOG_message' => $message,
-        ));
-        $changelog->save();
-    }
-
-
-    /**
-     * Returns an array of models that have datetime fields.
-     * This array is added to a short lived transient cache to keep having to build this list to a minimum.
-     *
-     * @return array an array of model class names.
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getModelsWithDatetimeFields()
-    {
-        $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
-            return $this->models_with_datetime_fields;
-        }
-
-        $all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
-        foreach ($all_non_abstract_models as $non_abstract_model) {
-            // get model instance
-            /** @var EEM_Base $non_abstract_model */
-            $non_abstract_model = $non_abstract_model::instance();
-            if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
-                $this->models_with_datetime_fields[] = get_class($non_abstract_model);
-            }
-        }
-        $this->setModelsToProcess($this->models_with_datetime_fields);
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * This simply records the models that have been processed with our tracking option.
-     *
-     * @param array $models_to_set array of model class names.
-     */
-    private function setModelsToProcess($models_to_set)
-    {
-        update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
-    }
-
-
-    /**
-     * Used to keep track of how many models have been processed for the batch
-     *
-     * @param $count
-     */
-    private function updateCountOfModelsProcessed($count = 1)
-    {
-        $count = $this->getCountOfModelsProcessed() + (int) $count;
-        update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
-    }
-
-
-    /**
-     * Retrieve the tracked number of models processed between requests.
-     *
-     * @return int
-     */
-    private function getCountOfModelsProcessed()
-    {
-        return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
-    }
-
-
-    /**
-     * Returns the models that are left to process.
-     *
-     * @return array  an array of model class names.
-     */
-    private function getModelsToProcess()
-    {
-        if (empty($this->models_with_datetime_fields)) {
-            $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
-        }
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @param float $offset
-     */
-    public static function updateOffset($offset)
-    {
-        update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
-    }
-
-
-    /**
-     * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @return float
-     */
-    public static function getOffset()
-    {
-        return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
-    }
-
-
-    /**
-     * Used to set the saved offset range start date.
-     *
-     * @param DbSafeDateTime|null $start_date
-     */
-    public static function updateStartDateRange(DbSafeDateTime $start_date = null)
-    {
-        $date_to_save = $start_date instanceof DbSafeDateTime
-            ? $start_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range start date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getStartDateRange()
-    {
-        $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
-        try {
-            $datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
-            $start_date = $datetime instanceof DateTime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $start_date = null;
-        }
-        return $start_date;
-    }
-
-
-    /**
-     * Used to set the saved offset range end date.
-     *
-     * @param DbSafeDateTime|null $end_date
-     */
-    public static function updateEndDateRange(DbSafeDateTime $end_date = null)
-    {
-        $date_to_save = $end_date instanceof DbSafeDateTime
-            ? $end_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range end date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getEndDateRange()
-    {
-        $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
-        try {
-            $datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
-            $end_date = $datetime instanceof Datetime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $end_date = null;
-        }
-        return $end_date;
-    }
+	/**
+	 * Key for the option used to track which models have been processed when doing the batches.
+	 */
+	const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
+
+
+	const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
+
+	/**
+	 * Key for the option used to track what the current offset is that will be applied when this tool is executed.
+	 */
+	const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
+
+
+	const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
+
+
+	const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
+
+
+	/**
+	 * String labelling the datetime offset fix type for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
+
+
+	/**
+	 * String labelling a datetime offset fix error for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
+
+	/**
+	 * @var EEM_Base[]
+	 */
+	protected $models_with_datetime_fields = array();
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$models_with_datetime_fields = $this->getModelsWithDatetimeFields();
+		// we'll be doing each model as a batch.
+		$job_parameters->set_job_size(count($models_with_datetime_fields));
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Starting Datetime Offset Fix', 'event_espresso')
+		);
+	}
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		$models_to_process = $this->getModelsWithDatetimeFields();
+		// let's pop off the a model and do the query to apply the offset.
+		$model_to_process = array_pop($models_to_process);
+		// update our record
+		$this->setModelsToProcess($models_to_process);
+		$this->processModel($model_to_process);
+		$this->updateCountOfModelsProcessed();
+		$job_parameters->set_units_processed($this->getCountOfModelsProcessed());
+		if (count($models_to_process) > 0) {
+			$job_parameters->set_status(JobParameters::status_continue);
+		} else {
+			$job_parameters->set_status(JobParameters::status_complete);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
+				$model_to_process
+			)
+		);
+	}
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		// delete important saved options.
+		delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
+		delete_option(self::COUNT_OF_MODELS_PROCESSED);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
+		return new JobStepResponse($job_parameters, esc_html__(
+			'Offset has been applied to all affected fields.',
+			'event_espresso'
+		));
+	}
+
+
+	/**
+	 * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
+	 *
+	 * @param string $model_class_name
+	 * @throws EE_Error
+	 */
+	protected function processModel($model_class_name)
+	{
+		global $wpdb;
+		/** @var EEM_Base $model */
+		$model = $model_class_name::instance();
+		$original_offset = self::getOffset();
+		$start_date_range = self::getStartDateRange();
+		$end_date_range = self::getEndDateRange();
+		$sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
+		$offset = abs($original_offset) * 60;
+		$date_ranges = array();
+		// since some affected models might have two tables, we have to get our tables and set up a query for each table.
+		foreach ($model->get_tables() as $table) {
+			$query = 'UPDATE ' . $table->get_table_name();
+			$fields_affected = array();
+			$inner_query = array();
+			foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
+				if ($model_field instanceof EE_Datetime_Field) {
+					$inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
+																	   . $sql_date_function . '('
+																	   . $model_field->get_table_column()
+																	   . ", INTERVAL {$offset} MINUTE)";
+					$fields_affected[] = $model_field;
+				}
+			}
+			if (! $fields_affected) {
+				continue;
+			}
+			// do we do one query per column/field or one query for all fields on the model? It all depends on whether
+			// there is a date range applied or not.
+			if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
+				$result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
+			} else {
+				$result = $this->doQueryForAllFields($query, $inner_query);
+			}
+
+			// record appropriate logs for the query
+			switch (true) {
+				case $result === false:
+					// record error.
+					$error_message = $wpdb->last_error;
+					// handle the edge cases where last_error might be empty.
+					if (! $error_message) {
+						$error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
+					}
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
+					break;
+				case is_array($result) && ! empty($result):
+					foreach ($result as $field_name => $error_message) {
+						$this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
+					}
+					break;
+				default:
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected);
+			}
+		}
+	}
+
+
+	/**
+	 * Does the query on each $inner_query individually.
+	 *
+	 * @param string              $query
+	 * @param array               $inner_query
+	 * @param DbSafeDateTime|null $start_date_range
+	 * @param DbSafeDateTime|null $end_date_range
+	 * @return array  An array of any errors encountered and the fields they were for.
+	 */
+	private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
+	{
+		global $wpdb;
+		$errors = array();
+		foreach ($inner_query as $field_name => $field_query) {
+			$query_to_run = $query;
+			$where_conditions = array();
+			$query_to_run .= ' SET ' . $field_query;
+			if ($start_date_range instanceof DbSafeDateTime) {
+				$start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} > '{$start_date}'";
+			}
+			if ($end_date_range instanceof DbSafeDateTime) {
+				$end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} < '{$end_date}'";
+			}
+			if ($where_conditions) {
+				$query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+			}
+			$result = $wpdb->query($query_to_run);
+			if ($result === false) {
+				// record error.
+				$error_message = $wpdb->last_error;
+				// handle the edgecases where last_error might be empty.
+				if (! $error_message) {
+					$error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
+				}
+				$errors[ $field_name ] = $error_message;
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * Performs the query for all fields within the inner_query
+	 *
+	 * @param string $query
+	 * @param array  $inner_query
+	 * @return false|int
+	 */
+	private function doQueryForAllFields($query, array $inner_query)
+	{
+		global $wpdb;
+		$query .= ' SET ' . implode(',', $inner_query);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * Records a changelog entry using the given information.
+	 *
+	 * @param EEM_Base              $model
+	 * @param float                 $offset
+	 * @param EE_Table_Base         $table
+	 * @param EE_Model_Field_Base[] $model_fields_affected
+	 * @param string                $error_message If present then there was an error so let's record that instead.
+	 * @throws EE_Error
+	 */
+	private function recordChangeLog(
+		EEM_Base $model,
+		$offset,
+		EE_Table_Base $table,
+		$model_fields_affected,
+		$error_message = ''
+	) {
+		// setup $fields list.
+		$fields = array();
+		/** @var EE_Datetime_Field $model_field */
+		foreach ($model_fields_affected as $model_field) {
+			if (! $model_field instanceof EE_Datetime_Field) {
+				continue;
+			}
+			$fields[] = $model_field->get_name();
+		}
+		// setup the message for the changelog entry.
+		$message = $error_message
+			? sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields),
+				$error_message
+			)
+			: sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields)
+			);
+		// write to the log
+		$changelog = EE_Change_Log::new_instance(array(
+			'LOG_type'    => $error_message
+				? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
+				: self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
+			'LOG_message' => $message,
+		));
+		$changelog->save();
+	}
+
+
+	/**
+	 * Returns an array of models that have datetime fields.
+	 * This array is added to a short lived transient cache to keep having to build this list to a minimum.
+	 *
+	 * @return array an array of model class names.
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getModelsWithDatetimeFields()
+	{
+		$this->getModelsToProcess();
+		if (! empty($this->models_with_datetime_fields)) {
+			return $this->models_with_datetime_fields;
+		}
+
+		$all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
+		foreach ($all_non_abstract_models as $non_abstract_model) {
+			// get model instance
+			/** @var EEM_Base $non_abstract_model */
+			$non_abstract_model = $non_abstract_model::instance();
+			if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
+				$this->models_with_datetime_fields[] = get_class($non_abstract_model);
+			}
+		}
+		$this->setModelsToProcess($this->models_with_datetime_fields);
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * This simply records the models that have been processed with our tracking option.
+	 *
+	 * @param array $models_to_set array of model class names.
+	 */
+	private function setModelsToProcess($models_to_set)
+	{
+		update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
+	}
+
+
+	/**
+	 * Used to keep track of how many models have been processed for the batch
+	 *
+	 * @param $count
+	 */
+	private function updateCountOfModelsProcessed($count = 1)
+	{
+		$count = $this->getCountOfModelsProcessed() + (int) $count;
+		update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
+	}
+
+
+	/**
+	 * Retrieve the tracked number of models processed between requests.
+	 *
+	 * @return int
+	 */
+	private function getCountOfModelsProcessed()
+	{
+		return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
+	}
+
+
+	/**
+	 * Returns the models that are left to process.
+	 *
+	 * @return array  an array of model class names.
+	 */
+	private function getModelsToProcess()
+	{
+		if (empty($this->models_with_datetime_fields)) {
+			$this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
+		}
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @param float $offset
+	 */
+	public static function updateOffset($offset)
+	{
+		update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
+	}
+
+
+	/**
+	 * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @return float
+	 */
+	public static function getOffset()
+	{
+		return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
+	}
+
+
+	/**
+	 * Used to set the saved offset range start date.
+	 *
+	 * @param DbSafeDateTime|null $start_date
+	 */
+	public static function updateStartDateRange(DbSafeDateTime $start_date = null)
+	{
+		$date_to_save = $start_date instanceof DbSafeDateTime
+			? $start_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range start date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getStartDateRange()
+	{
+		$start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
+		try {
+			$datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
+			$start_date = $datetime instanceof DateTime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$start_date = null;
+		}
+		return $start_date;
+	}
+
+
+	/**
+	 * Used to set the saved offset range end date.
+	 *
+	 * @param DbSafeDateTime|null $end_date
+	 */
+	public static function updateEndDateRange(DbSafeDateTime $end_date = null)
+	{
+		$date_to_save = $end_date instanceof DbSafeDateTime
+			? $end_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range end date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getEndDateRange()
+	{
+		$end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
+		try {
+			$datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
+			$end_date = $datetime instanceof Datetime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$end_date = null;
+		}
+		return $end_date;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -159,19 +159,19 @@ 
         $date_ranges = array();
         // since some affected models might have two tables, we have to get our tables and set up a query for each table.
         foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
+            $query = 'UPDATE '.$table->get_table_name();
             $fields_affected = array();
             $inner_query = array();
             foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
                 if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
+                    $inner_query[$model_field->get_table_column()] = $model_field->get_table_column().' = '
+                                                                       . $sql_date_function.'('
                                                                        . $model_field->get_table_column()
                                                                        . ", INTERVAL {$offset} MINUTE)";
                     $fields_affected[] = $model_field;
                 }
             }
-            if (! $fields_affected) {
+            if ( ! $fields_affected) {
                 continue;
             }
             // do we do one query per column/field or one query for all fields on the model? It all depends on whether
@@ -188,7 +188,7 @@ 
                     // record error.
                     $error_message = $wpdb->last_error;
                     // handle the edge cases where last_error might be empty.
-                    if (! $error_message) {
+                    if ( ! $error_message) {
                         $error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
                     }
                     $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
@@ -221,7 +221,7 @@ 
         foreach ($inner_query as $field_name => $field_query) {
             $query_to_run = $query;
             $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
+            $query_to_run .= ' SET '.$field_query;
             if ($start_date_range instanceof DbSafeDateTime) {
                 $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
                 $where_conditions[] = "{$field_name} > '{$start_date}'";
@@ -231,17 +231,17 @@ 
                 $where_conditions[] = "{$field_name} < '{$end_date}'";
             }
             if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+                $query_to_run .= ' WHERE '.implode(' AND ', $where_conditions);
             }
             $result = $wpdb->query($query_to_run);
             if ($result === false) {
                 // record error.
                 $error_message = $wpdb->last_error;
                 // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
+                if ( ! $error_message) {
                     $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
                 }
-                $errors[ $field_name ] = $error_message;
+                $errors[$field_name] = $error_message;
             }
         }
         return $errors;
@@ -258,7 +258,7 @@ 
     private function doQueryForAllFields($query, array $inner_query)
     {
         global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
+        $query .= ' SET '.implode(',', $inner_query);
         return $wpdb->query($query);
     }
 
@@ -284,7 +284,7 @@ 
         $fields = array();
         /** @var EE_Datetime_Field $model_field */
         foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
+            if ( ! $model_field instanceof EE_Datetime_Field) {
                 continue;
             }
             $fields[] = $model_field->get_name();
@@ -336,7 +336,7 @@ 
     private function getModelsWithDatetimeFields()
     {
         $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
+        if ( ! empty($this->models_with_datetime_fields)) {
             return $this->models_with_datetime_fields;
         }
 

core/helpers/EEH_Form_Fields.helper.php

Indentation +2064 added lines, -2064 removed lines

@@ -27,1057 +27,1057 @@ 
  */
 class EEH_Form_Fields
 {
-    /**
-     *  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 ' : '';
-        $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 ' : '';
+		$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);
-        $label_class = self::appendInputSizeClass('', $label);
-        $label_class = $label_class ? ' class="' . $label_class . '"' : '';
-        return "
+		if ($label === '') {
+			return $input;
+		}
+		$label = esc_html($label);
+		$label_class = self::appendInputSizeClass('', $label);
+		$label_class = $label_class ? ' class="' . $label_class . '"' : '';
+		return "
         <label for='$id'{$label_class}>
             {$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' : '';
-            $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' : '';
-
-        $class = self::appendInputSizeClass($class, $options);
-
-        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' : '';
+			$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' : '';
+
+		$class = self::appendInputSizeClass($class, $options);
+
+		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' : '';
-        $class     = self::appendInputSizeClass($class, $value);
-        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' : '';
+		$class     = self::appendInputSizeClass($class, $value);
+		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;
-        }
-        $class = $autosize ? self::appendInputSizeClass($class, $values) : '';
-
-        $field .= ' class="' . $class . '">';
-
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
-        }
-
-        $field .= self::selectInputOption($values, $default);
-        $field .= '</select>';
-
-        return $field;
-    }
-
-
-    private static function selectInputOption(array $values, $default): string
-    {
-        if (isset($values['id'], $values['text'])) {
-            $id = is_scalar($values['id']) ? $values['id'] : '';
-            $text = is_scalar($values['text']) ? $values['text'] : '';
-            $selected = $default == $values['id'] ? ' selected = "selected"' : '';
-            $html_class = isset($values['class']) ? ' class="' . $values['class'] . '"' : '';
-            return "<option value='{$id}'{$selected}{$html_class}>{$text}</option>";
-        }
-        $options = '';
-        foreach ($values as $value) {
-            $options .= self::selectInputOption($value, $default);
-        }
-        return $options;
-    }
-
-
-    /**
-     * @param mixed $value
-     * @return int
-     * @since   $VID:$
-     */
-    private static function getInputValueLength($value): int
-    {
-        if ($value instanceof EE_Question_Option) {
-            return self::getInputValueLength($value->desc());
-        }
-        if (is_array($value)) {
-            $chars = 0;
-            foreach ($value as $val) {
-                $length = self::getInputValueLength($val);
-                $chars = max($length, $chars);
-            }
-            return $chars;
-        }
-        // not a primitive? return something big
-        if (! is_scalar($value)) {
-            return 500;
-        }
-        return strlen((string) $value);
-    }
-
-
-    /**
-     * @param string $class
-     * @param mixed $value
-     * @return string
-     * @since   $VID:$
-     */
-    private static function appendInputSizeClass(string $class, $value): string
-    {
-        if (strpos($class, 'ee-input-width--') !== false) {
-            return $class;
-        }
-        $chars = self::getInputValueLength($value);
-        if ($chars && $chars < 5) {
-            return "{$class} ee-input-width--tiny";
-        }
-        if ($chars && $chars < 25) {
-            return "{$class} ee-input-width--small";
-        }
-        if ($chars && $chars > 100) {
-            return "{$class} ee-input-width--big";
-        }
-        return "{$class} ee-input-width--reg";
-    }
-
-
-    /**
-     * 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       = $QFI->get('label_class');
-        $label_class       = $label_class ? "{$label_class} espresso-form-input-lbl" : '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');
-        $add_mobile_label  = $QFI->get_meta('add_mobile_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,
-                    $add_mobile_label
-                );
-
-            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,
-                    $add_mobile_label
-                );
-
-
-            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,
-                    $add_mobile_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,
-                    $add_mobile_label
-                );
-
-            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,
-                    $add_mobile_label
-                );
-
-            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,
-                    $add_mobile_label
-                );
-        }
-    }
-
-
-    public static function label(
-        string $question,
-        string $required_text = '',
-        string $required_label = '',
-        string $name = '',
-        string $label_class = '',
-        bool $filter = true
-    ): string {
-        $for   = ! empty($name) ? " for='{$name}'" : '';
-        $class = ! empty($label_class) ? " class='{$label_class}'" : '';
-        $label = self::prep_question($question) . $required_label;
-        $label_html = "
+	}
+
+
+	/**
+	 * @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;
+		}
+		$class = $autosize ? self::appendInputSizeClass($class, $values) : '';
+
+		$field .= ' class="' . $class . '">';
+
+		if (empty($default) && isset($GLOBALS[ $name ])) {
+			$default = stripslashes($GLOBALS[ $name ]);
+		}
+
+		$field .= self::selectInputOption($values, $default);
+		$field .= '</select>';
+
+		return $field;
+	}
+
+
+	private static function selectInputOption(array $values, $default): string
+	{
+		if (isset($values['id'], $values['text'])) {
+			$id = is_scalar($values['id']) ? $values['id'] : '';
+			$text = is_scalar($values['text']) ? $values['text'] : '';
+			$selected = $default == $values['id'] ? ' selected = "selected"' : '';
+			$html_class = isset($values['class']) ? ' class="' . $values['class'] . '"' : '';
+			return "<option value='{$id}'{$selected}{$html_class}>{$text}</option>";
+		}
+		$options = '';
+		foreach ($values as $value) {
+			$options .= self::selectInputOption($value, $default);
+		}
+		return $options;
+	}
+
+
+	/**
+	 * @param mixed $value
+	 * @return int
+	 * @since   $VID:$
+	 */
+	private static function getInputValueLength($value): int
+	{
+		if ($value instanceof EE_Question_Option) {
+			return self::getInputValueLength($value->desc());
+		}
+		if (is_array($value)) {
+			$chars = 0;
+			foreach ($value as $val) {
+				$length = self::getInputValueLength($val);
+				$chars = max($length, $chars);
+			}
+			return $chars;
+		}
+		// not a primitive? return something big
+		if (! is_scalar($value)) {
+			return 500;
+		}
+		return strlen((string) $value);
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param mixed $value
+	 * @return string
+	 * @since   $VID:$
+	 */
+	private static function appendInputSizeClass(string $class, $value): string
+	{
+		if (strpos($class, 'ee-input-width--') !== false) {
+			return $class;
+		}
+		$chars = self::getInputValueLength($value);
+		if ($chars && $chars < 5) {
+			return "{$class} ee-input-width--tiny";
+		}
+		if ($chars && $chars < 25) {
+			return "{$class} ee-input-width--small";
+		}
+		if ($chars && $chars > 100) {
+			return "{$class} ee-input-width--big";
+		}
+		return "{$class} ee-input-width--reg";
+	}
+
+
+	/**
+	 * 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       = $QFI->get('label_class');
+		$label_class       = $label_class ? "{$label_class} espresso-form-input-lbl" : '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');
+		$add_mobile_label  = $QFI->get_meta('add_mobile_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,
+					$add_mobile_label
+				);
+
+			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,
+					$add_mobile_label
+				);
+
+
+			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,
+					$add_mobile_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,
+					$add_mobile_label
+				);
+
+			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,
+					$add_mobile_label
+				);
+
+			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,
+					$add_mobile_label
+				);
+		}
+	}
+
+
+	public static function label(
+		string $question,
+		string $required_text = '',
+		string $required_label = '',
+		string $name = '',
+		string $label_class = '',
+		bool $filter = true
+	): string {
+		$for   = ! empty($name) ? " for='{$name}'" : '';
+		$class = ! empty($label_class) ? " class='{$label_class}'" : '';
+		$label = self::prep_question($question) . $required_label;
+		$label_html = "
             {$required_text}
             <label{$for}{$class}>{$label}</label>";
-        // filter label but ensure required text comes before it
-        return $filter
-            ? apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text)
-            : $label_html;
-    }
-
-
-
-    public static function mobileLabel(
-        bool $add_mobile_label,
-        string $question,
-        string $required_text = '',
-        string $required_label = '',
-        string $label_class = '',
-        string $name = ''
-    ): string {
-        return $add_mobile_label
-            ? self::label($question, $required_text, $required_label, $name, $label_class, false)
-            : '';
-    }
-
-
-    /**
-     * 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,
-        $add_mobile_label = false,
-        $extra_attributes = ''
-    ) {
-        // 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 : '';
-        $class = self::appendInputSizeClass($class, $answer);
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-        $extra_attributes = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', $extra_attributes);
-
-        $label_html = self::label($question, $required_text, $required['label'], $name, $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label . '
+		// filter label but ensure required text comes before it
+		return $filter
+			? apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text)
+			: $label_html;
+	}
+
+
+
+	public static function mobileLabel(
+		bool $add_mobile_label,
+		string $question,
+		string $required_text = '',
+		string $required_label = '',
+		string $label_class = '',
+		string $name = ''
+	): string {
+		return $add_mobile_label
+			? self::label($question, $required_text, $required_label, $name, $label_class, false)
+			: '';
+	}
+
+
+	/**
+	 * 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,
+		$add_mobile_label = false,
+		$extra_attributes = ''
+	) {
+		// 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 : '';
+		$class = self::appendInputSizeClass($class, $answer);
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+		$extra_attributes = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', $extra_attributes);
+
+		$label_html = self::label($question, $required_text, $required['label'], $name, $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label . '
             <input  type="text"
                     name="' . $name . '"
                     id="' . $id . '"
@@ -1087,1039 +1087,1039 @@ 
                     ' . $disabled . ' ' . $extra_attributes . '
             />';
 
-        $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,
-        $add_mobile_label = false
-    ) {
-        // 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!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class     .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . trim($class) . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'aria-label="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
-             . esc_textarea($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,
-        $add_mobile_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(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!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class = self::appendInputSizeClass($class, $options);
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label
-            . '<select name="' . $name . '" id="' . $id . '" class="' . trim($class) . ' ' . $required['class'] . '" '
-            . 'aria-label="' . 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' : '';
-            $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' : '';
-        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,
-        $add_mobile_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 = self::label($question, $required_text, $required['label'], '', $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class
-        );
-
-        $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $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' : '';
-                $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>&nbsp;&nbsp;' : '';
-                $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4
-                    ? "\n\t\t\t\t\t\t"
-                      . '&nbsp;&nbsp;<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,
-        $add_mobile_label = false
-    ) {
-        // 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   = self::label($question, $required_text, $required['label'], '', $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class
-        );
-
-        $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $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' : '';
-
-            $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>&nbsp;&nbsp;' : '';
-            $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '&nbsp;&nbsp;<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,
-        $add_mobile_label = false
-    ) {
-        // 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 : '';
-        $class = self::appendInputSizeClass($class, $answer);
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html   = self::label($question, $required_text, $required['label'], '', $label_class);
-        $mobile_label = self::mobileLabel(
-            $add_mobile_label,
-            $question,
-            $required_text,
-            $required['label'],
-            $label_class,
-            $name
-        );
-
-        $input_html = $mobile_label
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'aria-label="' . 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);
-    }
-
-
-    /**
-     * 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);
-    }
-
-
-    /**
-     * 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;
-    }
+		$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,
+		$add_mobile_label = false
+	) {
+		// 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!!!
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class     .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label
+			. '<textarea name="' . $name . '" id="' . $id . '" class="' . trim($class) . '" '
+			. 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
+			. 'aria-label="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+			 . esc_textarea($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,
+		$add_mobile_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(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!!!
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class = self::appendInputSizeClass($class, $options);
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label
+			. '<select name="' . $name . '" id="' . $id . '" class="' . trim($class) . ' ' . $required['class'] . '" '
+			. 'aria-label="' . 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' : '';
+			$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' : '';
+		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,
+		$add_mobile_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 = self::label($question, $required_text, $required['label'], '', $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class
+		);
+
+		$input_html = $mobile_label
+			. '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $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' : '';
+				$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>&nbsp;&nbsp;' : '';
+				$input_html .= "\n\t\t\t\t\t\t"
+							   . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
+							   . 'class="' . $class . '" value="' . $value . '" '
+							   . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled
+							   . $checked . ' ' . $extra . '/>';
+				$input_html .= ! $label_b4
+					? "\n\t\t\t\t\t\t"
+					  . '&nbsp;&nbsp;<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,
+		$add_mobile_label = false
+	) {
+		// 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   = self::label($question, $required_text, $required['label'], '', $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class
+		);
+
+		$input_html = $mobile_label
+			. '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $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' : '';
+
+			$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>&nbsp;&nbsp;' : '';
+			$input_html .= "\n\t\t\t\t\t\t"
+						   . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
+						   . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
+						   . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+			$input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '&nbsp;&nbsp;<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,
+		$add_mobile_label = false
+	) {
+		// 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 : '';
+		$class = self::appendInputSizeClass($class, $answer);
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html   = self::label($question, $required_text, $required['label'], '', $label_class);
+		$mobile_label = self::mobileLabel(
+			$add_mobile_label,
+			$question,
+			$required_text,
+			$required['label'],
+			$label_class,
+			$name
+		);
+
+		$input_html = $mobile_label
+			. '<input type="text" name="' . $name . '" id="' . $id . '" '
+			. 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
+			. 'aria-label="' . 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);
+	}
+
+
+	/**
+	 * 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);
+	}
+
+
+	/**
+	 * 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;
+	}
 }

Spacing +135 added lines, -135 removed lines

@@ -108,8 +108,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) {
@@ -161,8 +161,8 @@ 
             }
         } // end foreach( $input_vars as $input_key => $input_value )
 
-        if (! empty($inputs)) {
-            $glue   = "
+        if ( ! empty($inputs)) {
+            $glue = "
                 </li>
                 <li>
                     ";
@@ -175,7 +175,7 @@ 
             </ul>
             ";
         }
-        return $output . implode("\n", $hidden_inputs);
+        return $output.implode("\n", $hidden_inputs);
     }
 
 
@@ -256,7 +256,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) {
@@ -267,14 +267,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;
@@ -300,7 +300,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;
@@ -326,7 +326,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;
@@ -395,7 +395,7 @@ 
         }
         $label = esc_html($label);
         $label_class = self::appendInputSizeClass('', $label);
-        $label_class = $label_class ? ' class="' . $label_class . '"' : '';
+        $label_class = $label_class ? ' class="'.$label_class.'"' : '';
         return "
         <label for='$id'{$label_class}>
             {$input}
@@ -544,7 +544,7 @@ 
         $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];
@@ -553,19 +553,19 @@ 
         }
 
         $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;
         }
         $class = $autosize ? self::appendInputSizeClass($class, $values) : '';
 
-        $field .= ' class="' . $class . '">';
+        $field .= ' class="'.$class.'">';
 
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
+        if (empty($default) && isset($GLOBALS[$name])) {
+            $default = stripslashes($GLOBALS[$name]);
         }
 
         $field .= self::selectInputOption($values, $default);
@@ -581,7 +581,7 @@ 
             $id = is_scalar($values['id']) ? $values['id'] : '';
             $text = is_scalar($values['text']) ? $values['text'] : '';
             $selected = $default == $values['id'] ? ' selected = "selected"' : '';
-            $html_class = isset($values['class']) ? ' class="' . $values['class'] . '"' : '';
+            $html_class = isset($values['class']) ? ' class="'.$values['class'].'"' : '';
             return "<option value='{$id}'{$selected}{$html_class}>{$text}</option>";
         }
         $options = '';
@@ -611,7 +611,7 @@ 
             return $chars;
         }
         // not a primitive? return something big
-        if (! is_scalar($value)) {
+        if ( ! is_scalar($value)) {
             return 500;
         }
         return strlen((string) $value);
@@ -661,11 +661,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"
                              . '<'
@@ -690,7 +690,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
@@ -698,7 +698,7 @@ 
                         $html .= self::generate_form_input($QFI);
                     }
                     $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
+                    $html .= "\n\t".'</'.$group_wrapper.'>';
                 }
             }
         }
@@ -738,25 +738,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"
@@ -781,21 +781,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(
                                     [
@@ -810,7 +810,7 @@ 
                             $html .= self::generate_form_input($QFI);
                         }
                         $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
+                        $html .= "\n\t".'</'.$group_wrapper.'>';
                     }
                 }
             }
@@ -858,7 +858,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)
@@ -994,7 +994,7 @@ 
     ): string {
         $for   = ! empty($name) ? " for='{$name}'" : '';
         $class = ! empty($label_class) ? " class='{$label_class}'" : '';
-        $label = self::prep_question($question) . $required_label;
+        $label = self::prep_question($question).$required_label;
         $label_html = "
             {$required_text}
             <label{$for}{$class}>{$label}</label>";
@@ -1050,7 +1050,7 @@ 
         $extra_attributes = ''
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1062,9 +1062,9 @@ 
         // 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 : '';
         $class = self::appendInputSizeClass($class, $answer);
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
         $extra_attributes = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', $extra_attributes);
 
         $label_html = self::label($question, $required_text, $required['label'], $name, $label_class);
@@ -1077,18 +1077,18 @@ 
             $name
         );
 
-        $input_html = $mobile_label . '
+        $input_html = $mobile_label.'
             <input  type="text"
-                    name="' . $name . '"
-                    id="' . $id . '"
-                    class="' . trim($class) . '"
-                    value="' . esc_attr($answer) . '"
-                    aria-label="' . esc_attr($required['msg']) . '"
-                    ' . $disabled . ' ' . $extra_attributes . '
+                    name="' . $name.'"
+                    id="' . $id.'"
+                    class="' . trim($class).'"
+                    value="' . esc_attr($answer).'"
+                    aria-label="' . esc_attr($required['msg']).'"
+                    ' . $disabled.' '.$extra_attributes.'
             />';
 
         $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;
     }
 
 
@@ -1123,7 +1123,7 @@ 
         $add_mobile_label = false
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1137,9 +1137,9 @@ 
         // set disabled tag
         $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class     .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class     .= ! empty($required['class']) ? ' '.$required['class'] : '';
+        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
         $mobile_label = self::mobileLabel(
@@ -1152,14 +1152,14 @@ 
         );
 
         $input_html = $mobile_label
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . trim($class) . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'aria-label="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+            . '<textarea name="'.$name.'" id="'.$id.'" class="'.trim($class).'" '
+            . 'rows="'.$dimensions['rows'].'" cols="'.$dimensions['cols'].'"  '
+            . 'aria-label="'.$required['msg'].'" '.$disabled.' '.$extra.'>'
              . esc_textarea($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;
     }
 
 
@@ -1197,7 +1197,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
@@ -1209,9 +1209,9 @@ 
         // set disabled tag
         $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $class = self::appendInputSizeClass($class, $options);
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
         $mobile_label = self::mobileLabel(
@@ -1224,16 +1224,16 @@ 
         );
 
         $input_html = $mobile_label
-            . '<select name="' . $name . '" id="' . $id . '" class="' . trim($class) . ' ' . $required['class'] . '" '
-            . 'aria-label="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+            . '<select name="'.$name.'" id="'.$id.'" class="'.trim($class).' '.$required['class'].'" '
+            . 'aria-label="'.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 = $answer === null ? ' 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>'
                 : '';
@@ -1256,7 +1256,7 @@ 
                 );
         }
 
-        $input_html .= "\n\t\t\t" . '</select>';
+        $input_html .= "\n\t\t\t".'</select>';
 
         $input_html =
             apply_filters(
@@ -1271,7 +1271,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;
     }
 
 
@@ -1289,11 +1289,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;
     }
 
@@ -1320,7 +1320,7 @@ 
         $value    = ! empty($value) ? $value : $key;
         $selected = ($answer == $key || $only_option) ? '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>';
     }
@@ -1365,7 +1365,7 @@ 
         $add_mobile_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
@@ -1389,49 +1389,49 @@ 
         );
 
         $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-radio-btn-options-ul '.$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' : '';
-                $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>&nbsp;&nbsp;' : '';
+                $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>&nbsp;&nbsp;' : '';
                 $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
+                               . '<input type="radio" name="'.$name.'" id="'.$id.$opt.'" '
+                               . 'class="'.$class.'" value="'.$value.'" '
+                               . 'aria-label="'.esc_attr($required['msg']).'" '.$disabled
+                               . $checked.' '.$extra.'/>';
                 $input_html .= ! $label_b4
                     ? "\n\t\t\t\t\t\t"
                       . '&nbsp;&nbsp;<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;
     }
 
 
@@ -1467,7 +1467,7 @@ 
         $add_mobile_label = false
     ) {
         // 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);
@@ -1477,7 +1477,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
@@ -1499,42 +1499,42 @@ 
         );
 
         $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-checkbox-options-ul '.$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' : '';
 
-            $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>&nbsp;&nbsp;' : '';
+            $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>&nbsp;&nbsp;' : '';
             $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '&nbsp;&nbsp;<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.'" '
+                           . 'aria-label="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'&nbsp;&nbsp;<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;
     }
 
 
@@ -1567,7 +1567,7 @@ 
         $add_mobile_label = false
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1579,7 +1579,7 @@ 
         // 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 : '';
         $class = self::appendInputSizeClass($class, $answer);
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
@@ -1594,14 +1594,14 @@ 
         );
 
         $input_html = $mobile_label
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+            . '<input type="text" name="'.$name.'" id="'.$id.'" '
+            . 'class="'.$class.' '.$required['class'].' datepicker" value="'.$answer.'"  '
+            . 'aria-label="'.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
         );
@@ -1609,7 +1609,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;
     }
 
 
@@ -1636,7 +1636,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.'"/>';
     }
 
 
@@ -1681,7 +1681,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'])
@@ -1694,7 +1694,7 @@ 
                     );
                 }
                 if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+                    $prepped_answer_options[$QSO->opt_group()][] = $QSO;
                 } else {
                     $prepped_answer_options[] = $QSO;
                 }
@@ -1906,7 +1906,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);
     }
@@ -1924,7 +1924,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);
     }
@@ -1943,7 +1943,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;
         }
 
@@ -1962,7 +1962,7 @@ 
         ];
 
         foreach ($regdtts as $regdtt) {
-            $date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+            $date      = $regdtt->reg_month.' '.$regdtt->reg_year;
             $options[] = [
                 'text' => $date,
                 'id'   => $date,
@@ -2011,7 +2011,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;
         }
@@ -2034,8 +2034,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,
@@ -2108,16 +2108,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;

core/helpers/EEH_Export.helper.php

Indentation +167 added lines, -167 removed lines

@@ -13,171 +13,171 @@
  */
 class EEH_Export
 {
-    /**
-     * Gets the 'normal' column named for fields
-     * @param EE_Model_Field_Base $field
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_column_name_for_field(EE_Model_Field_Base $field)
-    {
-        $column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
-        if (
-            apply_filters(
-                'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-                false,
-                $column_name,
-                $field
-            )
-        ) {
-            $column_name .= "["
-                . wp_specialchars_decode($field->get_name(), ENT_QUOTES)
-                . "]";
-        }
-        return $column_name;
-    }
-
-
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param string $filepath
-     * @param array  $data                  2D array,first numerically-indexed,
-     *                                      and next-level-down preferably indexed by string
-     * @param bool   $write_column_headers  whether or not we should add the keys in the bottom-most array
-     *                                      as a row for headers in the CSV.
-     *                                      Eg, if $data looked like:
-     *                                          array(
-     *                                              0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
-     *                                              1=>array(...,...)
-     *                                          )
-     * @param bool   $headers_only          if true then we won't print any data, just headers. defaults to false
-     * @return boolean                      if we successfully wrote to the CSV or not. If there's no $data,
-     *                                      we consider that a success (because we wrote everything there was...nothing)
-     * @throws EE_Error
-     */
-    public static function write_data_array_to_csv(
-        string $filepath,
-        array $data,
-        bool $write_column_headers = true,
-        bool $headers_only = false
-    ) {
-        // determine if $data is actually a 2d array
-        if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(sprintf(esc_html__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data))));
-            }
-            $new_file_contents = '';
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if ($write_column_headers && EEH_Array::is_associative_array($item_in_top_level_array)) {
-                // its associative, so we want to output its keys as column headers
-                $keys = array_keys($item_in_top_level_array);
-                $new_file_contents .=  EEH_Export::get_csv_row($keys);
-                if ($headers_only) {
-                    return EEH_File::write_to_file(
-                        $filepath,
-                        EEH_File::get_file_contents($filepath) . $new_file_contents
-                    );
-                }
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                $new_row = EEH_Export::get_csv_row($data_row);
-                $new_file_contents .= $new_row ?: '';
-            }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
-        }
-        // no data TO write... so we can assume that's a success
-        return true;
-    }
-
-
-
-     /**
-      *
-     *  Writes a row to the csv file
-     *  @param array $row - individual row of csv data
-     *  @param string $delimiter - csv delimiter
-     *  @param string $enclosure - csv enclosure
-     *  @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     *  @return string of text for teh csv file
-     */
-    public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
-    {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
-
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
-
-        $output = array();
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
-
-            $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
-        }
-
-        return  implode($delimiter, $output) . PHP_EOL;
-    }
-
-
-
-    /**
-     * Shortcut for preparing a database result for display
-     * @param EEM_Base $model
-     * @param string $field_name
-     * @param string $raw_db_value
-     * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty
-     * @return string
-     */
-    public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
-    {
-        $field_obj = $model->field_settings_for($field_name);
-        $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema);
-            $field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema);
-        }
-        if ($pretty_schema === true) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
-        } elseif (is_string($pretty_schema)) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
-        } else {
-            return $field_obj->prepare_for_get($value_on_model_obj);
-        }
-    }
-
-
-
-    /**
-     * Gets the date format to use in exports. filterable
-     * @param string $current_format
-     * @return string
-     */
-    public static function get_date_format_for_export($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
-
-
-
-    /**
-     * Gets the time format we want to use in exports. Filterable
-     * @param string $current_format
-     * @return string
-     */
-    public static function get_time_format_for_export($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	/**
+	 * Gets the 'normal' column named for fields
+	 * @param EE_Model_Field_Base $field
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_column_name_for_field(EE_Model_Field_Base $field)
+	{
+		$column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
+		if (
+			apply_filters(
+				'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+				false,
+				$column_name,
+				$field
+			)
+		) {
+			$column_name .= "["
+				. wp_specialchars_decode($field->get_name(), ENT_QUOTES)
+				. "]";
+		}
+		return $column_name;
+	}
+
+
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param string $filepath
+	 * @param array  $data                  2D array,first numerically-indexed,
+	 *                                      and next-level-down preferably indexed by string
+	 * @param bool   $write_column_headers  whether or not we should add the keys in the bottom-most array
+	 *                                      as a row for headers in the CSV.
+	 *                                      Eg, if $data looked like:
+	 *                                          array(
+	 *                                              0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
+	 *                                              1=>array(...,...)
+	 *                                          )
+	 * @param bool   $headers_only          if true then we won't print any data, just headers. defaults to false
+	 * @return boolean                      if we successfully wrote to the CSV or not. If there's no $data,
+	 *                                      we consider that a success (because we wrote everything there was...nothing)
+	 * @throws EE_Error
+	 */
+	public static function write_data_array_to_csv(
+		string $filepath,
+		array $data,
+		bool $write_column_headers = true,
+		bool $headers_only = false
+	) {
+		// determine if $data is actually a 2d array
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(sprintf(esc_html__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data))));
+			}
+			$new_file_contents = '';
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if ($write_column_headers && EEH_Array::is_associative_array($item_in_top_level_array)) {
+				// its associative, so we want to output its keys as column headers
+				$keys = array_keys($item_in_top_level_array);
+				$new_file_contents .=  EEH_Export::get_csv_row($keys);
+				if ($headers_only) {
+					return EEH_File::write_to_file(
+						$filepath,
+						EEH_File::get_file_contents($filepath) . $new_file_contents
+					);
+				}
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				$new_row = EEH_Export::get_csv_row($data_row);
+				$new_file_contents .= $new_row ?: '';
+			}
+			return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+		}
+		// no data TO write... so we can assume that's a success
+		return true;
+	}
+
+
+
+	 /**
+	  *
+	  *  Writes a row to the csv file
+	  *  @param array $row - individual row of csv data
+	  *  @param string $delimiter - csv delimiter
+	  *  @param string $enclosure - csv enclosure
+	  *  @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	  *  @return string of text for teh csv file
+	  */
+	public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
+	{
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
+
+		$output = array();
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
+
+			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
+				( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
+		}
+
+		return  implode($delimiter, $output) . PHP_EOL;
+	}
+
+
+
+	/**
+	 * Shortcut for preparing a database result for display
+	 * @param EEM_Base $model
+	 * @param string $field_name
+	 * @param string $raw_db_value
+	 * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty
+	 * @return string
+	 */
+	public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
+	{
+		$field_obj = $model->field_settings_for($field_name);
+		$value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema);
+			$field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema);
+		}
+		if ($pretty_schema === true) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
+		} elseif (is_string($pretty_schema)) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
+		} else {
+			return $field_obj->prepare_for_get($value_on_model_obj);
+		}
+	}
+
+
+
+	/**
+	 * Gets the date format to use in exports. filterable
+	 * @param string $current_format
+	 * @return string
+	 */
+	public static function get_date_format_for_export($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
+
+
+
+	/**
+	 * Gets the time format we want to use in exports. Filterable
+	 * @param string $current_format
+	 * @return string
+	 */
+	public static function get_time_format_for_export($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -74,11 +74,11 @@ 
             if ($write_column_headers && EEH_Array::is_associative_array($item_in_top_level_array)) {
                 // its associative, so we want to output its keys as column headers
                 $keys = array_keys($item_in_top_level_array);
-                $new_file_contents .=  EEH_Export::get_csv_row($keys);
+                $new_file_contents .= EEH_Export::get_csv_row($keys);
                 if ($headers_only) {
                     return EEH_File::write_to_file(
                         $filepath,
-                        EEH_File::get_file_contents($filepath) . $new_file_contents
+                        EEH_File::get_file_contents($filepath).$new_file_contents
                     );
                 }
             }
@@ -87,7 +87,7 @@ 
                 $new_row = EEH_Export::get_csv_row($data_row);
                 $new_file_contents .= $new_row ?: '';
             }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath).$new_file_contents);
         }
         // no data TO write... so we can assume that's a success
         return true;
@@ -124,10 +124,10 @@ 
             }
 
             $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
+                ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure) : $field_value;
         }
 
-        return  implode($delimiter, $output) . PHP_EOL;
+        return  implode($delimiter, $output).PHP_EOL;
     }
 
 

core/libraries/batch/JobHandlerBaseClasses/JobHandlerFile.php

Indentation +140 added lines, -140 removed lines

@@ -19,144 +19,144 @@
  */
 abstract class JobHandlerFile extends JobHandler
 {
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    const temp_folder_name = 'batch_temp_folder';
-
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-
-    /**
-     * @var EEHI_File
-     */
-    protected $_file_helper = null;
-
-
-    /**
-     * JobHandlerFile constructor.
-     *
-     * @param EEHI_File|null $file_helper
-     */
-    public function __construct(EEHI_File $file_helper = null)
-    {
-        if (! $file_helper) {
-            $this->_file_helper = new EEH_File();
-        }
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    /**
-     * Creates a file
-     *
-     * @param string $job_id
-     * @param string $filename
-     * @param string $filetype
-     * @param string $bom initial content to place in the file.
-     * @return string
-     * @throws BatchRequestException
-     */
-    public function create_file_from_job_with_name(
-        string $job_id,
-        string $filename,
-        string $filetype = 'application/ms-excel',
-        string $bom = "\xEF\xBB\xBF"
-    ): string {
-        $filepath = '';
-        try {
-            $base_folder = $this->get_base_folder();
-            $success     = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                $base_folder . JobHandlerFile::temp_folder_name
-            );
-            if ($success) {
-                $success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id
-                );
-            }
-            if ($success) {
-                $filepath = $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/' . $filename;
-                $success  = $this->_file_helper->ensure_file_exists_and_is_writable($filepath);
-            }
-            // let's add the .htaccess file so safari will open the file properly
-            if ($success) {
-                $extension = EEH_File::get_file_extension($filepath);
-                EEH_File::write_to_file(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/.htaccess',
-                    'AddType ' . $filetype . ' ' . $extension,
-                    '.htaccess'
-                );
-            }
-            /**
-             * Filters what initial content will be added to the file.
-             *
-             * @param string $return_value  By default it's whatever was passed into
-             *                              JobHandlerFile::create_file_from_job_with_name()
-             * @param string $filename
-             * @param string $filetype default 'application/ms-excel'
-             * @param string $filepath
-             */
-            EEH_File::write_to_file(
-                $filepath,
-                apply_filters(
-                    'FHEE__EE_CSV__begin_sending_csv__start_writing',
-                    $bom,
-                    $filename,
-                    $filetype,
-                    $filepath
-                )
-            );
-            // those methods normally fail with an exception, but if not, let's do it
-            if (! $success) {
-                throw new EE_Error(
-                    esc_html__('Could not create temporary file, an unknown error occurred', 'event_espresso')
-                );
-            }
-        } catch (EE_Error $e) {
-            throw new BatchRequestException(
-                sprintf(
-                // phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
-                    esc_html__('Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso'),
-                    $job_id,
-                    $e->getMessage()
-                ),
-                500,
-                $e
-            );
-        }
-        return $filepath;
-    }
-
-
-    /**
-     * Gets the URL to download the file
-     *
-     * @param string $filepath
-     * @return string url to file
-     */
-    public function get_url_to_file(string $filepath): string
-    {
-        return str_replace($this->get_base_folder(), $this->get_base_url(), $filepath);
-    }
-
-
-    /**
-     * Gets the folder which will contain the "batch_temp_folder"
-     *
-     * @return string
-     */
-    public function get_base_folder(): string
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_folder',
-            EVENT_ESPRESSO_UPLOAD_DIR
-        );
-    }
-
-
-    public function get_base_url(): string
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_url',
-            EVENT_ESPRESSO_UPLOAD_URL
-        );
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	const temp_folder_name = 'batch_temp_folder';
+
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+
+	/**
+	 * @var EEHI_File
+	 */
+	protected $_file_helper = null;
+
+
+	/**
+	 * JobHandlerFile constructor.
+	 *
+	 * @param EEHI_File|null $file_helper
+	 */
+	public function __construct(EEHI_File $file_helper = null)
+	{
+		if (! $file_helper) {
+			$this->_file_helper = new EEH_File();
+		}
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	/**
+	 * Creates a file
+	 *
+	 * @param string $job_id
+	 * @param string $filename
+	 * @param string $filetype
+	 * @param string $bom initial content to place in the file.
+	 * @return string
+	 * @throws BatchRequestException
+	 */
+	public function create_file_from_job_with_name(
+		string $job_id,
+		string $filename,
+		string $filetype = 'application/ms-excel',
+		string $bom = "\xEF\xBB\xBF"
+	): string {
+		$filepath = '';
+		try {
+			$base_folder = $this->get_base_folder();
+			$success     = $this->_file_helper->ensure_folder_exists_and_is_writable(
+				$base_folder . JobHandlerFile::temp_folder_name
+			);
+			if ($success) {
+				$success = $this->_file_helper->ensure_folder_exists_and_is_writable(
+					$base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id
+				);
+			}
+			if ($success) {
+				$filepath = $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/' . $filename;
+				$success  = $this->_file_helper->ensure_file_exists_and_is_writable($filepath);
+			}
+			// let's add the .htaccess file so safari will open the file properly
+			if ($success) {
+				$extension = EEH_File::get_file_extension($filepath);
+				EEH_File::write_to_file(
+					$base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/.htaccess',
+					'AddType ' . $filetype . ' ' . $extension,
+					'.htaccess'
+				);
+			}
+			/**
+			 * Filters what initial content will be added to the file.
+			 *
+			 * @param string $return_value  By default it's whatever was passed into
+			 *                              JobHandlerFile::create_file_from_job_with_name()
+			 * @param string $filename
+			 * @param string $filetype default 'application/ms-excel'
+			 * @param string $filepath
+			 */
+			EEH_File::write_to_file(
+				$filepath,
+				apply_filters(
+					'FHEE__EE_CSV__begin_sending_csv__start_writing',
+					$bom,
+					$filename,
+					$filetype,
+					$filepath
+				)
+			);
+			// those methods normally fail with an exception, but if not, let's do it
+			if (! $success) {
+				throw new EE_Error(
+					esc_html__('Could not create temporary file, an unknown error occurred', 'event_espresso')
+				);
+			}
+		} catch (EE_Error $e) {
+			throw new BatchRequestException(
+				sprintf(
+				// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
+					esc_html__('Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso'),
+					$job_id,
+					$e->getMessage()
+				),
+				500,
+				$e
+			);
+		}
+		return $filepath;
+	}
+
+
+	/**
+	 * Gets the URL to download the file
+	 *
+	 * @param string $filepath
+	 * @return string url to file
+	 */
+	public function get_url_to_file(string $filepath): string
+	{
+		return str_replace($this->get_base_folder(), $this->get_base_url(), $filepath);
+	}
+
+
+	/**
+	 * Gets the folder which will contain the "batch_temp_folder"
+	 *
+	 * @return string
+	 */
+	public function get_base_folder(): string
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_folder',
+			EVENT_ESPRESSO_UPLOAD_DIR
+		);
+	}
+
+
+	public function get_base_url(): string
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_url',
+			EVENT_ESPRESSO_UPLOAD_URL
+		);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -37,7 +37,7 @@ 
      */
     public function __construct(EEHI_File $file_helper = null)
     {
-        if (! $file_helper) {
+        if ( ! $file_helper) {
             $this->_file_helper = new EEH_File();
         }
     }
@@ -65,23 +65,23 @@ 
         try {
             $base_folder = $this->get_base_folder();
             $success     = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                $base_folder . JobHandlerFile::temp_folder_name
+                $base_folder.JobHandlerFile::temp_folder_name
             );
             if ($success) {
                 $success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id
+                    $base_folder.JobHandlerFile::temp_folder_name.'/'.$job_id
                 );
             }
             if ($success) {
-                $filepath = $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/' . $filename;
+                $filepath = $base_folder.JobHandlerFile::temp_folder_name.'/'.$job_id.'/'.$filename;
                 $success  = $this->_file_helper->ensure_file_exists_and_is_writable($filepath);
             }
             // let's add the .htaccess file so safari will open the file properly
             if ($success) {
                 $extension = EEH_File::get_file_extension($filepath);
                 EEH_File::write_to_file(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/.htaccess',
-                    'AddType ' . $filetype . ' ' . $extension,
+                    $base_folder.JobHandlerFile::temp_folder_name.'/'.$job_id.'/.htaccess',
+                    'AddType '.$filetype.' '.$extension,
                     '.htaccess'
                 );
             }
@@ -105,7 +105,7 @@ 
                 )
             );
             // those methods normally fail with an exception, but if not, let's do it
-            if (! $success) {
+            if ( ! $success) {
                 throw new EE_Error(
                     esc_html__('Could not create temporary file, an unknown error occurred', 'event_espresso')
                 );

modules/batch/EED_Batch.module.php

Indentation +443 added lines, -443 removed lines

@@ -28,447 +28,447 @@
  */
 class EED_Batch extends EED_Module
 {
-    public const PAGE_SLUG = 'espresso_batch';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * processes data only
-     */
-    const batch_job = 'job';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * produces a file for download
-     */
-    const batch_file_job = 'file';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
-     * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
-     * at all
-     */
-    const batch_not_job = 'none';
-
-    /**
-     *
-     * @var string 'file', or 'job', or false to indicate its not a batch request at all
-     */
-    protected $_batch_request_type = '';
-
-    /**
-     * Because we want to use the response in both the localized JS and in the body
-     * we need to make this response available between method calls
-     *
-     * @var JobStepResponse|null
-     */
-    protected $_job_step_response = null;
-
-    /**
-     * @var LoaderInterface|null
-     */
-    protected $loader = null;
-
-
-    /**
-     * Gets the batch instance
-     *
-     * @return  EED_Module|EED_Batch
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Batch
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Sets hooks to enable batch jobs on the frontend. Disabled by default
-     * because it's an attack vector and there are currently no implementations
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks()
-    {
-        // because this is a possible attack vector, let's have this disabled until
-        // we at least have a real use for it on the frontend
-        if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
-            add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-            add_filter('template_include', [self::instance(), 'override_template'], 99);
-        }
-    }
-
-
-    /**
-     * Initializes some hooks for the admin in order to run batch jobs
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('admin_menu', [self::instance(), 'register_admin_pages']);
-        add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-
-        // ajax
-        add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-        add_filter(
-            'admin_body_class',
-            function ($classes) {
-                if (strpos($classes, 'espresso-admin') === false) {
-                    $classes .= ' espresso-admin';
-                }
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    protected function getLoader(): LoaderInterface
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Enqueues batch scripts on the frontend or admin, and creates a job
-     */
-    public function enqueue_scripts()
-    {
-        $request = EED_Batch::getRequest();
-        if (
-            $request->getRequestParam(EED_Batch::PAGE_SLUG)
-            || $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
-        ) {
-            if (
-                ! $request->requestParamIsSet('default_nonce')
-                || ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
-            ) {
-                wp_die(
-                    esc_html__(
-                        'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
-                        'event_espresso'
-                    )
-                );
-            }
-            switch ($this->batch_request_type()) {
-                case self::batch_job:
-                    $this->enqueue_scripts_styles_batch_create();
-                    break;
-                case self::batch_file_job:
-                    $this->enqueue_scripts_styles_batch_file_create();
-                    break;
-            }
-        }
-    }
-
-
-    /**
-     * Create a batch job, enqueues a script to run it, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_create()
-    {
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', 'url');
-        if ($return_url) {
-            wp_localize_script(
-                'batch_runner_init',
-                'ee_job_i18n',
-                [
-                    'return_url'                => $return_url,
-                    'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
-                        'auto_redirect_on_complete'
-                    ),
-                    'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                        ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_file_create()
-    {
-        // creates a job based on the request variable
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', 'url');
-        if ($return_url) {
-            wp_localize_script(
-                'batch_file_runner_init',
-                'ee_job_i18n',
-                ['return_url' => $return_url]
-            );
-        }
-    }
-
-
-    /**
-     * Enqueues scripts and styles common to any batch job, and creates
-     * a job from the request data, and stores the response in the
-     * $this->_job_step_response property
-     *
-     * @return JobStepResponse
-     */
-    protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
-    {
-        // just copy the bits of EE admin's eei18n that we need in the JS
-        EE_Registry::$i18n_js_strings['batchJobError'] = __(
-            'An error occurred and the job has been stopped. Please refresh the page to try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
-        wp_enqueue_style(
-            EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
-            EE_ADMIN_URL . 'assets/ee-admin-page.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style(
-            'batch_runner',
-            BATCH_URL . 'assets/batch_runner.css',
-            [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
-            date('Y-m-d-H:i', time())
-        );
-        wp_register_script(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
-            ['jquery'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_enqueue_style(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
-            [],
-            date('Y-m-d-H:i', time())
-        );
-        wp_enqueue_script(
-            'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
-            ['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        // eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
-        // remember the response for later. We need it to display the page body
-        $this->_job_step_response = $batch_runner->createJob();
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
-     *
-     * @param string $template
-     * @return string
-     */
-    public function override_template(string $template): string
-    {
-        $request = EED_Batch::getRequest();
-        if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
-        }
-        return $template;
-    }
-
-
-    /**
-     * Adds an admin page which doesn't appear in the admin menu
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function register_admin_pages()
-    {
-        add_submenu_page(
-            '',
-            // parent slug. we don't want this to actually appear in the menu
-            esc_html__('Batch Job', 'event_espresso'),
-            // page title
-            'n/a',
-            // menu title
-            'read',
-            // we want this page to actually be accessible to anyone,
-            EED_Batch::PAGE_SLUG,
-            // menu slug
-            [self::instance(), 'show_admin_page']
-        );
-    }
-
-
-    /**
-     * Renders the admin page, after most of the work was already done during enqueuing scripts
-     * of creating the job and localizing some data
-     */
-    public function show_admin_page()
-    {
-        echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.php',
-            [
-                'batch_request_type'        => $this->batch_request_type(),
-                'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
-                'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                    ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-            ]
-        );
-    }
-
-
-    private function runBatchRunnerJob(string $job)
-    {
-        $job_id = EED_Batch::getRequest()->getRequestParam('job_id');
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        $job_response = $batch_runner->{$job}($job_id);
-        $this->_return_json($job_response->to_array());
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function continueBatchJob()
-    {
-        $this->runBatchRunnerJob('continueJob');
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function advanceBatchJob()
-    {
-        $this->runBatchRunnerJob('advanceJob');
-    }
-
-
-    /**
-     * Receives the ajax call to cleanup a job
-     *
-     * @return void
-     */
-    public function cleanupBatchJob()
-    {
-        $this->runBatchRunnerJob('cleanupJob');
-    }
-
-
-    /**
-     * Returns a json response
-     *
-     * @param array $data The data we want to send echo via in the JSON response's "data" element
-     *
-     * The returned json object is created from an array in the following format:
-     * array(
-     *    'notices' => '', // - contains any EE_Error formatted notices
-     *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *    We're also going to include the template args with every package (so js can pick out any specific template
-     *    args that might be included in here)
-     *    'isEEajax' => true,//indicates this is a response from EE
-     * )
-     */
-    protected function _return_json(array $data)
-    {
-        $json = [
-            'notices'  => EE_Error::get_notices(),
-            'data'     => $data,
-            'isEEajax' => true
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        ];
-
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (error_get_last() === null || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-            echo wp_json_encode($json);
-            exit();
-        }
-    }
-
-
-    /**
-     * Gets the job step response which was done during the enqueuing of scripts
-     *
-     * @return JobStepResponse
-     */
-    public function job_step_response(): JobStepResponse
-    {
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * Gets the batch request type indicated in the current request
-     *
-     * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
-     */
-    public function batch_request_type(): string
-    {
-        if (! $this->_batch_request_type) {
-            $request = EED_Batch::getRequest();
-            $batch   = $request->getRequestParam('batch');
-            switch ($batch) {
-                case self::batch_job:
-                    $this->_batch_request_type = self::batch_job;
-                    break;
-                case self::batch_file_job:
-                    $this->_batch_request_type = self::batch_file_job;
-                    break;
-                default:
-                    // if we didn't find that it was a batch request, indicate it wasn't
-                    $this->_batch_request_type = self::batch_not_job;
-            }
-        }
-        return $this->_batch_request_type;
-    }
-
-
-    /**
-     * Unnecessary
-     *
-     * @param WP $WP
-     */
-    public function run($WP)
-    {
-    }
+	public const PAGE_SLUG = 'espresso_batch';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * processes data only
+	 */
+	const batch_job = 'job';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * produces a file for download
+	 */
+	const batch_file_job = 'file';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
+	 * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
+	 * at all
+	 */
+	const batch_not_job = 'none';
+
+	/**
+	 *
+	 * @var string 'file', or 'job', or false to indicate its not a batch request at all
+	 */
+	protected $_batch_request_type = '';
+
+	/**
+	 * Because we want to use the response in both the localized JS and in the body
+	 * we need to make this response available between method calls
+	 *
+	 * @var JobStepResponse|null
+	 */
+	protected $_job_step_response = null;
+
+	/**
+	 * @var LoaderInterface|null
+	 */
+	protected $loader = null;
+
+
+	/**
+	 * Gets the batch instance
+	 *
+	 * @return  EED_Module|EED_Batch
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Batch
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Sets hooks to enable batch jobs on the frontend. Disabled by default
+	 * because it's an attack vector and there are currently no implementations
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks()
+	{
+		// because this is a possible attack vector, let's have this disabled until
+		// we at least have a real use for it on the frontend
+		if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
+			add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+			add_filter('template_include', [self::instance(), 'override_template'], 99);
+		}
+	}
+
+
+	/**
+	 * Initializes some hooks for the admin in order to run batch jobs
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('admin_menu', [self::instance(), 'register_admin_pages']);
+		add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+
+		// ajax
+		add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+		add_filter(
+			'admin_body_class',
+			function ($classes) {
+				if (strpos($classes, 'espresso-admin') === false) {
+					$classes .= ' espresso-admin';
+				}
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	protected function getLoader(): LoaderInterface
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Enqueues batch scripts on the frontend or admin, and creates a job
+	 */
+	public function enqueue_scripts()
+	{
+		$request = EED_Batch::getRequest();
+		if (
+			$request->getRequestParam(EED_Batch::PAGE_SLUG)
+			|| $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
+		) {
+			if (
+				! $request->requestParamIsSet('default_nonce')
+				|| ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
+			) {
+				wp_die(
+					esc_html__(
+						'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
+						'event_espresso'
+					)
+				);
+			}
+			switch ($this->batch_request_type()) {
+				case self::batch_job:
+					$this->enqueue_scripts_styles_batch_create();
+					break;
+				case self::batch_file_job:
+					$this->enqueue_scripts_styles_batch_file_create();
+					break;
+			}
+		}
+	}
+
+
+	/**
+	 * Create a batch job, enqueues a script to run it, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_create()
+	{
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_runner_init',
+			BATCH_URL . 'assets/batch_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', 'url');
+		if ($return_url) {
+			wp_localize_script(
+				'batch_runner_init',
+				'ee_job_i18n',
+				[
+					'return_url'                => $return_url,
+					'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
+						'auto_redirect_on_complete'
+					),
+					'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+						?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_file_create()
+	{
+		// creates a job based on the request variable
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_file_runner_init',
+			BATCH_URL . 'assets/batch_file_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', 'url');
+		if ($return_url) {
+			wp_localize_script(
+				'batch_file_runner_init',
+				'ee_job_i18n',
+				['return_url' => $return_url]
+			);
+		}
+	}
+
+
+	/**
+	 * Enqueues scripts and styles common to any batch job, and creates
+	 * a job from the request data, and stores the response in the
+	 * $this->_job_step_response property
+	 *
+	 * @return JobStepResponse
+	 */
+	protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
+	{
+		// just copy the bits of EE admin's eei18n that we need in the JS
+		EE_Registry::$i18n_js_strings['batchJobError'] = __(
+			'An error occurred and the job has been stopped. Please refresh the page to try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
+		wp_enqueue_style(
+			EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
+			EE_ADMIN_URL . 'assets/ee-admin-page.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style(
+			'batch_runner',
+			BATCH_URL . 'assets/batch_runner.css',
+			[EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
+			date('Y-m-d-H:i', time())
+		);
+		wp_register_script(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+			['jquery'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_enqueue_style(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+			[],
+			date('Y-m-d-H:i', time())
+		);
+		wp_enqueue_script(
+			'batch_runner',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+			['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		// eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
+		// remember the response for later. We need it to display the page body
+		$this->_job_step_response = $batch_runner->createJob();
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
+	 *
+	 * @param string $template
+	 * @return string
+	 */
+	public function override_template(string $template): string
+	{
+		$request = EED_Batch::getRequest();
+		if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
+			return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
+		}
+		return $template;
+	}
+
+
+	/**
+	 * Adds an admin page which doesn't appear in the admin menu
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function register_admin_pages()
+	{
+		add_submenu_page(
+			'',
+			// parent slug. we don't want this to actually appear in the menu
+			esc_html__('Batch Job', 'event_espresso'),
+			// page title
+			'n/a',
+			// menu title
+			'read',
+			// we want this page to actually be accessible to anyone,
+			EED_Batch::PAGE_SLUG,
+			// menu slug
+			[self::instance(), 'show_admin_page']
+		);
+	}
+
+
+	/**
+	 * Renders the admin page, after most of the work was already done during enqueuing scripts
+	 * of creating the job and localizing some data
+	 */
+	public function show_admin_page()
+	{
+		echo EEH_Template::locate_template(
+			EE_MODULES . 'batch/templates/batch_wrapper.template.php',
+			[
+				'batch_request_type'        => $this->batch_request_type(),
+				'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
+				'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+					?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+			]
+		);
+	}
+
+
+	private function runBatchRunnerJob(string $job)
+	{
+		$job_id = EED_Batch::getRequest()->getRequestParam('job_id');
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		$job_response = $batch_runner->{$job}($job_id);
+		$this->_return_json($job_response->to_array());
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function continueBatchJob()
+	{
+		$this->runBatchRunnerJob('continueJob');
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function advanceBatchJob()
+	{
+		$this->runBatchRunnerJob('advanceJob');
+	}
+
+
+	/**
+	 * Receives the ajax call to cleanup a job
+	 *
+	 * @return void
+	 */
+	public function cleanupBatchJob()
+	{
+		$this->runBatchRunnerJob('cleanupJob');
+	}
+
+
+	/**
+	 * Returns a json response
+	 *
+	 * @param array $data The data we want to send echo via in the JSON response's "data" element
+	 *
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *    'notices' => '', // - contains any EE_Error formatted notices
+	 *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *    We're also going to include the template args with every package (so js can pick out any specific template
+	 *    args that might be included in here)
+	 *    'isEEajax' => true,//indicates this is a response from EE
+	 * )
+	 */
+	protected function _return_json(array $data)
+	{
+		$json = [
+			'notices'  => EE_Error::get_notices(),
+			'data'     => $data,
+			'isEEajax' => true
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		];
+
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (error_get_last() === null || ! headers_sent()) {
+			header('Content-Type: application/json; charset=UTF-8');
+			echo wp_json_encode($json);
+			exit();
+		}
+	}
+
+
+	/**
+	 * Gets the job step response which was done during the enqueuing of scripts
+	 *
+	 * @return JobStepResponse
+	 */
+	public function job_step_response(): JobStepResponse
+	{
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * Gets the batch request type indicated in the current request
+	 *
+	 * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
+	 */
+	public function batch_request_type(): string
+	{
+		if (! $this->_batch_request_type) {
+			$request = EED_Batch::getRequest();
+			$batch   = $request->getRequestParam('batch');
+			switch ($batch) {
+				case self::batch_job:
+					$this->_batch_request_type = self::batch_job;
+					break;
+				case self::batch_file_job:
+					$this->_batch_request_type = self::batch_file_job;
+					break;
+				default:
+					// if we didn't find that it was a batch request, indicate it wasn't
+					$this->_batch_request_type = self::batch_not_job;
+			}
+		}
+		return $this->_batch_request_type;
+	}
+
+
+	/**
+	 * Unnecessary
+	 *
+	 * @param WP $WP
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -120,7 +120,7 @@ 
         add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -139,7 +139,7 @@ 
      */
     protected function getLoader(): LoaderInterface
     {
-        if (! $this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -187,7 +187,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
+            BATCH_URL.'assets/batch_runner_init.js',
             ['batch_runner'],
             date('Y-m-d-H:i', time()),
             true
@@ -222,7 +222,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
+            BATCH_URL.'assets/batch_file_runner_init.js',
             ['batch_runner'],
             date('Y-m-d-H:i', time()),
             true
@@ -255,35 +255,35 @@ 
             'An error occurred and the job has been stopped. Please refresh the page to try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
+        EE_Registry::$i18n_js_strings['is_admin'] = is_admin();
         wp_enqueue_style(
             EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
-            EE_ADMIN_URL . 'assets/ee-admin-page.css',
+            EE_ADMIN_URL.'assets/ee-admin-page.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style(
             'batch_runner',
-            BATCH_URL . 'assets/batch_runner.css',
+            BATCH_URL.'assets/batch_runner.css',
             [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
             date('Y-m-d-H:i', time())
         );
         wp_register_script(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.js',
             ['jquery'],
             date('Y-m-d-H:i', time()),
             true
         );
         wp_enqueue_style(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.css',
             [],
             date('Y-m-d-H:i', time())
         );
         wp_enqueue_script(
             'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/batch_runner.js',
             ['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
             date('Y-m-d-H:i', time()),
             true
@@ -307,7 +307,7 @@ 
     {
         $request = EED_Batch::getRequest();
         if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
+            return EE_MODULES.'batch/templates/batch_frontend_wrapper.template.php';
         }
         return $template;
     }
@@ -344,7 +344,7 @@ 
     public function show_admin_page()
     {
         echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.php',
+            EE_MODULES.'batch/templates/batch_wrapper.template.php',
             [
                 'batch_request_type'        => $this->batch_request_type(),
                 'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
@@ -444,7 +444,7 @@ 
      */
     public function batch_request_type(): string
     {
-        if (! $this->_batch_request_type) {
+        if ( ! $this->_batch_request_type) {
             $request = EED_Batch::getRequest();
             $batch   = $request->getRequestParam('batch');
             switch ($batch) {