eventespresso / event-espresso-core

core/admin/EE_Admin_Page_Init.core.php

Indentation +8 added lines, -8 removed lines

@@ -153,18 +153,18 @@
 
 
 	/**
-     * This loads scripts and styles for the EE_Admin system
-     * that must be available on ALL WP admin pages (i.e. EE_menu items)
-     *
+	 * This loads scripts and styles for the EE_Admin system
+	 * that must be available on ALL WP admin pages (i.e. EE_menu items)
+	 *
 	 * @return void
 	 */
 	public function load_wp_global_scripts_styles() {
 		wp_register_style(
-		    'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
+			'espresso_menu',
+			EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
 		wp_enqueue_style('espresso_menu');
 	}
 

Spacing +56 added lines, -56 removed lines

@@ -88,16 +88,16 @@ 
 		$this->_set_init_properties();
 
 		//global styles/scripts across all wp admin pages
-		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5 );
+		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5);
 
 		//load initial stuff.
 		$this->_set_file_and_folder_name();
 
 		$this->_set_menu_map();
 
-		if ( empty( $this->_menu_map ) || is_array( $this->_menu_map ) )
+		if (empty($this->_menu_map) || is_array($this->_menu_map))
 			 {
-			 	EE_Error::doing_it_wrong( get_class( $this ) . '::$_menu_map', sprintf( __('The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.', 'event_espresso' ), get_class( $this ) ), '4.4.0' );
+			 	EE_Error::doing_it_wrong(get_class($this).'::$_menu_map', sprintf(__('The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.', 'event_espresso'), get_class($this)), '4.4.0');
 			 	return;
 			 }
 
@@ -161,7 +161,7 @@ 
 	public function load_wp_global_scripts_styles() {
 		wp_register_style(
 		    'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+            EE_ADMIN_URL.'assets/admin-menu-styles.css',
             array('dashicons'),
             EVENT_ESPRESSO_VERSION
         );
@@ -193,8 +193,8 @@ 
 
 
 	protected function _set_capability() {
-		$capability = empty($this->capability) ?  $this->_menu_map->capability : $this->capability;
-		$this->capability = apply_filters( 'FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability );
+		$capability = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
+		$this->capability = apply_filters('FHEE_'.$this->_menu_map->menu_slug.'_capability', $capability);
 	}
 
 
@@ -212,7 +212,7 @@ 
 	public function initialize_admin_page() {
 		//let's check user access first
 		$this->_check_user_access();
-		if ( !is_object( $this->_loaded_page_object) ) return;
+		if ( ! is_object($this->_loaded_page_object)) return;
 		$this->_loaded_page_object->route_admin_request();
 		return;
 	}
@@ -224,25 +224,25 @@ 
 
 
 	public function set_page_dependencies($wp_page_slug) {
-		if ( !$this->_load_page ) return;
+		if ( ! $this->_load_page) return;
 
-		if ( !is_object($this->_loaded_page_object) ) {
+		if ( ! is_object($this->_loaded_page_object)) {
 			$msg[] = __('We can\'t load the page because we\'re missing a valid page object that tells us what to load', 'event_espresso');
-			$msg[] = $msg[0] . "\r\n" . sprintf(
+			$msg[] = $msg[0]."\r\n".sprintf(
 				__('The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory', 'event_espresso'),
 				 $this->_file_name,
 				 $this->_file_name,
-				 $this->_folder_path . $this->_file_name,
+				 $this->_folder_path.$this->_file_name,
 				 $this->_menu_map->menu_slug
 			);
-			throw new EE_Error( implode( '||', $msg) );
+			throw new EE_Error(implode('||', $msg));
 		}
 
 		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-		$page_hook = 'load-' . $wp_page_slug;
+		$page_hook = 'load-'.$wp_page_slug;
 		//hook into page load hook so all page specific stuff get's loaded.
-		if ( !empty($wp_page_slug) )
-			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies') );
+		if ( ! empty($wp_page_slug))
+			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
 	}
 
 
@@ -253,7 +253,7 @@ 
 	 */
 	public function do_initial_loads() {
 		//no loading or initializing if menu map is setup incorrectly.
-		if ( empty( $this->_menu_map ) || is_array( $this->_menu_map ) ) {
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
 			return;
 		}
 		$this->_initialize_admin_page();
@@ -270,19 +270,19 @@ 
 		$bt = debug_backtrace();
 		//for more reliable determination of folder name
 		//we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-		$class = get_class( $this );
-		foreach ( $bt as $index => $values ) {
-			if ( isset( $values['class'] ) && $values['class'] == $class ) {
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
 				$file_index = $index - 1;
-				$this->_folder_name = basename(dirname($bt[$file_index]['file']) );
-				if ( !empty( $this->_folder_name ) ) break;
+				$this->_folder_name = basename(dirname($bt[$file_index]['file']));
+				if ( ! empty($this->_folder_name)) break;
 			}
 		}
 
-		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . DS;
+		$this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.DS;
 
-		$this->_file_name = preg_replace( '/^ee/' , 'EE', $this->_folder_name );
-		$this->_file_name = ucwords( str_replace('_', ' ', $this->_file_name) );
+		$this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
 		$this->_file_name = str_replace(' ', '_', $this->_file_name);
 	}
 
@@ -294,19 +294,19 @@ 
 	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks files/classes
 	 * @return array
 	 */
-	public function register_hooks( $extend = FALSE ) {
+	public function register_hooks($extend = FALSE) {
 
 		//get a list of files in the directory that have the "Hook" in their name an
 
 		//if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-		if ( $extend ) {
-			$hook_files_glob_path = apply_filters( 'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend', EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS . '*' . $this->_file_name . '_Hooks_Extend.class.php' );
-			$this->_hook_paths = $this->_register_hook_files( $hook_files_glob_path, $extend );
+		if ($extend) {
+			$hook_files_glob_path = apply_filters('FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend', EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.DS.'*'.$this->_file_name.'_Hooks_Extend.class.php');
+			$this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
 		}
 
 		//loop through decaf folders
-		$hook_files_glob_path = apply_filters( 'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path', $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php' );
-		$this->_hook_paths = array_merge( $this->_register_hook_files( $hook_files_glob_path ), $this->_hook_paths );  //making sure any extended hook paths are later in the array than the core hook paths!
+		$hook_files_glob_path = apply_filters('FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path', $this->_folder_path.'*'.$this->_file_name.'_Hooks.class.php');
+		$this->_hook_paths = array_merge($this->_register_hook_files($hook_files_glob_path), $this->_hook_paths); //making sure any extended hook paths are later in the array than the core hook paths!
 
 		return $this->_hook_paths;
 
@@ -314,27 +314,27 @@ 
 
 
 
-	protected function _register_hook_files( $hook_files_glob_path, $extend = FALSE ) {
+	protected function _register_hook_files($hook_files_glob_path, $extend = FALSE) {
 		$hook_paths = array();
-		if ( $hook_files = glob( $hook_files_glob_path ) ) {
-			if ( empty( $hook_files ) ) {
+		if ($hook_files = glob($hook_files_glob_path)) {
+			if (empty($hook_files)) {
 				return array();
 			}
-			foreach ( $hook_files as $file ) {
+			foreach ($hook_files as $file) {
 				//lets get the linked admin.
-				$hook_file = $extend ? str_replace( EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . DS, '', $file ) : str_replace($this->_folder_path, '', $file );
-				$replace = $extend ? '_' . $this->_file_name . '_Hooks_Extend.class.php' : '_' . $this->_file_name . '_Hooks.class.php';
-				$rel_admin = str_replace( $replace, '', $hook_file);
+				$hook_file = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.DS, '', $file) : str_replace($this->_folder_path, '', $file);
+				$replace = $extend ? '_'.$this->_file_name.'_Hooks_Extend.class.php' : '_'.$this->_file_name.'_Hooks.class.php';
+				$rel_admin = str_replace($replace, '', $hook_file);
 				$rel_admin = strtolower($rel_admin);
 				$hook_paths[] = $file;
 
 				//make sure we haven't already got a hook setup for this page path
-				if ( in_array( $rel_admin, $this->_files_hooked ) )
+				if (in_array($rel_admin, $this->_files_hooked))
 					continue;
 
 				$this->hook_file = $hook_file;
-				$rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
-				$filter = add_filter( $rel_admin_hook, array($this, 'load_admin_hook') );
+				$rel_admin_hook = 'FHEE_do_other_page_hooks_'.$rel_admin;
+				$filter = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
 				$this->_files_hooked[] = $rel_admin;
 			}
 		}
@@ -359,7 +359,7 @@ 
 	protected function _initialize_admin_page() {
 
 		//JUST CHECK WE'RE ON RIGHT PAGE.
-		if ( (!isset( $_REQUEST['page'] ) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing )
+		if (( ! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing)
 			return; //not on the right page so let's get out.
 		$this->_load_page = TRUE;
 
@@ -367,30 +367,30 @@ 
 //		spl_autoload_register(array( $this, 'set_autoloaders') );
 
 		//we don't need to do a page_request check here because it's only called via WP menu system.
-		$admin_page = $this->_file_name . '_Admin_Page';
-		$hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
+		$admin_page = $this->_file_name.'_Admin_Page';
+		$hook_suffix = $this->_menu_map->menu_slug.'_'.$admin_page;
 		$admin_page = apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}", $admin_page);
 
 		// define requested admin page class name then load the file and instantiate
-		$path_to_file = str_replace( array( '\\', '/' ), DS, $this->_folder_path . $admin_page . '.core.php' );
-		$path_to_file=apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",$path_to_file );//so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		$path_to_file = str_replace(array('\\', '/'), DS, $this->_folder_path.$admin_page.'.core.php');
+		$path_to_file = apply_filters("FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}", $path_to_file); //so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
 
-		if ( is_readable( $path_to_file )) {
+		if (is_readable($path_to_file)) {
 			// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-			do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization' );
-			do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug );
-			require_once( $path_to_file );
-			$a = new ReflectionClass( $admin_page );
-			$this->_loaded_page_object = $a->newInstance( $this->_routing );
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_'.$this->_menu_map->menu_slug);
+			require_once($path_to_file);
+			$a = new ReflectionClass($admin_page);
+			$this->_loaded_page_object = $a->newInstance($this->_routing);
 		}
-		do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__after_initialization' );
-		do_action( 'AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug );
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_'.$this->_menu_map->menu_slug);
 	}
 
 
 
 	public function get_admin_page_name() {
-		return $this->_file_name . '_Admin_Page';
+		return $this->_file_name.'_Admin_Page';
 	}
 
 
@@ -422,8 +422,8 @@ 
 	 * @return bool|die true if pass (or admin) wp_die if fail
 	 */
 	private function _check_user_access() {
-		if ( ! EE_Registry::instance()->CAP->current_user_can( $this->_menu_map->capability, $this->_menu_map->menu_slug ) ) {
-			wp_die( __('You don\'t have access to this page.'), '', array( 'back_link' => true ) );
+		if ( ! EE_Registry::instance()->CAP->current_user_can($this->_menu_map->capability, $this->_menu_map->menu_slug)) {
+			wp_die(__('You don\'t have access to this page.'), '', array('back_link' => true));
 		}
 		return true;
 	}

core/libraries/form_sections/strategies/layout/EE_Div_Per_Section_Layout.strategy.php

Indentation +126 added lines, -126 removed lines

@@ -14,132 +14,132 @@
 class EE_Div_Per_Section_Layout extends EE_Form_Section_Layout_Base
 {
 
-    /**
-     * opening div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        return EEH_HTML::div(
-            '',
-            $this->_form_section->html_id(),
-            $this->_form_section->html_class(),
-            $this->_form_section->html_style()
-        );
-    }
-
-
-
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws \EE_Error
-     */
-    public function layout_input($input)
-    {
-        $html = '';
-        // set something unique for the id
-        $html_id = (string)$input->html_id() !== ''
-            ? (string)$input->html_id()
-            : spl_object_hash($input);
-        // and add a generic input type class
-        $html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-        } else if ($input instanceof EE_Submit_Input) {
-            $html .= EEH_HTML::div(
-                $input->get_html_for_input(),
-                $html_id . '-submit-dv',
-                "{$input->html_class()}-submit-dv {$html_class}"
-            );
-        } else if ($input instanceof EE_Select_Input) {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
-                "{$input->html_class()}-input-dv {$html_class}"
-            );
-        } else if ($input instanceof EE_Form_Input_With_Options_Base) {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
-                "{$input->html_class()}-input-dv {$html_class}"
-            );
-        } else {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
-                "{$input->html_class()}-input-dv {$html_class}"
-            );
-        }
-        return $html;
-    }
-
-
-
-    /**
-     *
-     * _display_label_for_option_type_question
-     * Gets the HTML for the 'label', which is just text for this (because labels
-     * should be for each input)
-     *
-     * @param EE_Form_Input_With_Options_Base $input
-     * @return string
-     */
-    protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input)
-    {
-        if ($input->display_html_label_text() !== '') {
-            return EEH_HTML::div(
-                $input->required()
-                    ? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk')
-                    : $input->html_label_text(),
-                $input->html_label_id(),
-                $input->required()
-                    ? 'ee-required-label ' . $input->html_label_class()
-                    : $input->html_label_class(),
-                $input->html_label_style(),
-                $input->html_other_attributes()
-            );
-        }
-        return '';
-    }
-
-
-
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
-    }
-
-
-
-    /**
-     * closing div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class());
-    }
+	/**
+	 * opening div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		return EEH_HTML::div(
+			'',
+			$this->_form_section->html_id(),
+			$this->_form_section->html_class(),
+			$this->_form_section->html_style()
+		);
+	}
+
+
+
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function layout_input($input)
+	{
+		$html = '';
+		// set something unique for the id
+		$html_id = (string)$input->html_id() !== ''
+			? (string)$input->html_id()
+			: spl_object_hash($input);
+		// and add a generic input type class
+		$html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+		} else if ($input instanceof EE_Submit_Input) {
+			$html .= EEH_HTML::div(
+				$input->get_html_for_input(),
+				$html_id . '-submit-dv',
+				"{$input->html_class()}-submit-dv {$html_class}"
+			);
+		} else if ($input instanceof EE_Select_Input) {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl(1) . $input->get_html_for_label() .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$html_id . '-input-dv',
+				"{$input->html_class()}-input-dv {$html_class}"
+			);
+		} else if ($input instanceof EE_Form_Input_With_Options_Base) {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$html_id . '-input-dv',
+				"{$input->html_class()}-input-dv {$html_class}"
+			);
+		} else {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl(1) . $input->get_html_for_label() .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$html_id . '-input-dv',
+				"{$input->html_class()}-input-dv {$html_class}"
+			);
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 *
+	 * _display_label_for_option_type_question
+	 * Gets the HTML for the 'label', which is just text for this (because labels
+	 * should be for each input)
+	 *
+	 * @param EE_Form_Input_With_Options_Base $input
+	 * @return string
+	 */
+	protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input)
+	{
+		if ($input->display_html_label_text() !== '') {
+			return EEH_HTML::div(
+				$input->required()
+					? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk')
+					: $input->html_label_text(),
+				$input->html_label_id(),
+				$input->required()
+					? 'ee-required-label ' . $input->html_label_class()
+					: $input->html_label_class(),
+				$input->html_label_style(),
+				$input->html_other_attributes()
+			);
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		//		d( $form_section );
+		return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+	}
+
+
+
+	/**
+	 * closing div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class());
+	}
 
 
 

Spacing +23 added lines, -23 removed lines

@@ -42,44 +42,44 @@ 
     {
         $html = '';
         // set something unique for the id
-        $html_id = (string)$input->html_id() !== ''
-            ? (string)$input->html_id()
+        $html_id = (string) $input->html_id() !== ''
+            ? (string) $input->html_id()
             : spl_object_hash($input);
         // and add a generic input type class
-        $html_class = sanitize_key(str_replace('_', '-', get_class($input))) . '-dv';
+        $html_class = sanitize_key(str_replace('_', '-', get_class($input))).'-dv';
         if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
         } else if ($input instanceof EE_Submit_Input) {
             $html .= EEH_HTML::div(
                 $input->get_html_for_input(),
-                $html_id . '-submit-dv',
+                $html_id.'-submit-dv',
                 "{$input->html_class()}-submit-dv {$html_class}"
             );
         } else if ($input instanceof EE_Select_Input) {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
+                EEH_HTML::nl(1).$input->get_html_for_label().
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $html_id.'-input-dv',
                 "{$input->html_class()}-input-dv {$html_class}"
             );
         } else if ($input instanceof EE_Form_Input_With_Options_Base) {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
+                EEH_HTML::nl().$this->_display_label_for_option_type_question($input).
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $html_id.'-input-dv',
                 "{$input->html_class()}-input-dv {$html_class}"
             );
         } else {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $html_id . '-input-dv',
+                EEH_HTML::nl(1).$input->get_html_for_label().
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $html_id.'-input-dv',
                 "{$input->html_class()}-input-dv {$html_class}"
             );
         }
@@ -102,11 +102,11 @@ 
         if ($input->display_html_label_text() !== '') {
             return EEH_HTML::div(
                 $input->required()
-                    ? $input->html_label_text() . EEH_HTML::span('*', '', 'ee-asterisk')
+                    ? $input->html_label_text().EEH_HTML::span('*', '', 'ee-asterisk')
                     : $input->html_label_text(),
                 $input->html_label_id(),
                 $input->required()
-                    ? 'ee-required-label ' . $input->html_label_class()
+                    ? 'ee-required-label '.$input->html_label_class()
                     : $input->html_label_class(),
                 $input->html_label_style(),
                 $input->html_other_attributes()
@@ -126,7 +126,7 @@ 
     public function layout_subsection($form_section)
     {
         //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+        return EEH_HTML::nl(1).$form_section->get_html().EEH_HTML::nl(-1);
     }
 
 

core/db_classes/EE_Message_Template_Group.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -211,7 +211,7 @@
      * appropriately.
      *
      * @throws EE_Error
-     * @return EE_message_type|false if exception thrown.
+     * @return null|EE_message_type if exception thrown.
      */
     public function message_type_obj()
     {

Indentation +482 added lines, -482 removed lines

@@ -15,486 +15,486 @@
 class EE_Message_Template_Group extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * Extra Meta key prefix for whether a given context for this message tmeplate group is active or not.
-     */
-    const ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX = 'active_context_';
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group|mixed
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template_Group
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $message_type
-     * @throws EE_Error
-     */
-    public function set_message_type($message_type = false)
-    {
-        if (! $message_type) {
-            throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
-        }
-        $this->set('MTP_message_type', $message_type);
-    }
-
-
-    /**
-     * @param bool $messenger
-     * @throws EE_Error
-     */
-    public function set_messenger($messenger = false)
-    {
-        if (! $messenger) {
-            throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
-        }
-        $this->set('MTP_messenger', $messenger);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(
-                esc_html__(
-                    'Missing required value for the message template group id',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function user()
-    {
-        $user_id = $this->get('MTP_user_id');
-        return empty($user_id) ? get_current_user_id() : $user_id;
-    }
-
-
-    /**
-     * Wrapper for the user function() (preserve backward compat)
-     *
-     * @since  4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->user();
-    }
-
-
-    /**
-     * This simply returns a count of all related events to this message template group
-     *
-     * @return int
-     */
-    public function count_events()
-    {
-        return $this->count_related('Event');
-    }
-
-
-    /**
-     * returns the name saved in the db for this template
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('MTP_name');
-    }
-
-
-    /**
-     * Returns the description saved in the db for this template group
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('MTP_description');
-    }
-
-
-    /**
-     * returns all related EE_Message_Template objects
-     *
-     * @param  array $query_params like EEM_Base::get_all()
-     * @return EE_Message_Template[]
-     * @throws EE_Error
-     */
-    public function message_templates($query_params = array())
-    {
-        return $this->get_many_related('Message_Template', $query_params);
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     */
-    public function messenger()
-    {
-        return $this->get('MTP_messenger');
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     * If an attempt to get the corresponding messenger object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @return EE_messenger
-     * @throws EE_Error
-     */
-    public function messenger_obj()
-    {
-        $messenger = $this->messenger();
-        try {
-            $messenger = EEH_MSG_Template::messenger_obj($messenger);
-        } catch (EE_Error $e) {
-            //if an exception was thrown then let's deactivate this message template group because it means there is no
-            // class for this messenger in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $messenger;
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     */
-    public function message_type()
-    {
-        return $this->get('MTP_message_type');
-    }
-
-
-    /**
-     * get Message type OBJECT
-     * If an attempt to get the corresponding message type object fails, then we set this message
-     * template group to inactive, and save to db.  Then return null so client code can handle
-     * appropriately.
-     *
-     * @throws EE_Error
-     * @return EE_message_type|false if exception thrown.
-     */
-    public function message_type_obj()
-    {
-        $message_type = $this->message_type();
-        try {
-            $message_type = EEH_MSG_Template::message_type_obj($message_type);
-        } catch (EE_Error $e) {
-            //if an exception was thrown then let's deactivate this message template group because it means there is no
-            // class for the message type in this group.
-            $this->set('MTP_is_active', false);
-            $this->save();
-            return null;
-        }
-        return $message_type;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     */
-    public function contexts_config()
-    {
-        return $this->message_type_obj()->get_contexts();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     * Note this is an array with singular and plural keys
-     *
-     * @access public
-     * @return array labels for "context"
-     * @throws EE_Error
-     */
-    public function context_label()
-    {
-        $obj = $this->message_type_obj();
-        return $obj->get_context_label();
-    }
-
-
-    /**
-     * This returns an array of EE_Message_Template objects indexed by context and field.
-     *
-     * @return array ()
-     * @throws EE_Error
-     */
-    public function context_templates()
-    {
-        $mtps_arr = array();
-        $mtps     = $this->get_many_related('Message_Template');
-        if (empty($mtps)) {
-            return array();
-        }
-        //note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
-        foreach ($mtps as $mtp) {
-            $mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
-        }
-        return $mtps_arr;
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return bool true if it is, false if it isn't
-     * @throws EE_Error
-     */
-    public function is_global()
-    {
-        return $this->get('MTP_is_global');
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return bool true if it is, false if it isn't
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        return $this->get('MTP_is_active');
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @since 4.3.0
-     * @uses  EEH_MSG_Template::get_shortcodes()
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be returned.
-     * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
-     *                        unique shortcodes for all the given (or all) fields.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *                        shortcodes found.
-     * @throws EE_Error
-     */
-    public function get_shortcodes($context, $fields = array(), $merged = false)
-    {
-        $messenger    = $this->messenger();
-        $message_type = $this->message_type();
-        return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
-    }
-
-
-    /**
-     * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
-     * use the default template pack.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_template_pack_name()
-    {
-        return $this->get_extra_meta('MTP_template_pack', true, 'default');
-    }
-
-
-    /**
-     * This returns the specific template pack object referenced by the template pack name attached to this message
-     * template group.  If no template pack is assigned then the default template pack is retrieved.
-     *
-     * @since 4.5.0
-     * @return EE_Messages_Template_Pack
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_template_pack()
-    {
-        $pack_name = $this->get_template_pack_name();
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($pack_name);
-    }
-
-
-    /**
-     * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
-     * use the default template variation.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_template_pack_variation()
-    {
-        return $this->get_extra_meta('MTP_variation', true, 'default');
-    }
-
-
-    /**
-     * This just sets the template pack name attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $template_pack_name What message template pack is assigned.
-     * @return int
-     * @throws EE_Error
-     */
-    public function set_template_pack_name($template_pack_name)
-    {
-        return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
-    }
-
-
-    /**
-     * This just sets the template pack variation attached to this message template group.
-     *
-     * @since 4.5.0
-     * @param string $variation What variation is being set on the message template group.
-     * @return int
-     * @throws EE_Error
-     */
-    public function set_template_pack_variation($variation)
-    {
-        return $this->update_extra_meta('MTP_variation', $variation);
-    }
-
-
-    /**
-     * Deactivates the given context.
-     *
-     * @param $context
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function deactivate_context($context)
-    {
-        $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
-    }
-
-
-    /**
-     * Activates the given context.
-     *
-     * @param $context
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function activate_context($context)
-    {
-        $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
-    }
-
-
-    /**
-     * Returns whether the context is active or not.
-     * Note, this will default to true if the extra meta record doesn't exist.
-     * Also, this does NOT account for whether the "To" field is empty or not. Some messengers may allow the "To" field
-     * to be empty (@see EE_Messenger::allow_empty_to_field()) so an empty "To" field is not always an indicator of
-     * whether a context is "active" or not.
-     *
-     * @param $context
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function is_context_active($context)
-    {
-        $this->validate_context($context);
-        return filter_var(
-            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Validates the incoming context to verify it matches a registered context for the related message type.
-     * @param string $context
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    public function validate_context($context)
-    {
-        $contexts = $this->contexts_config();
-        if (! isset($contexts[$context])) {
-            throw new InvalidIdentifierException(
-                '',
-                '',
-                sprintf(
-                    esc_html__(
-                        'An invalid string identifying a context was provided.  "%1$s" was received, and one of "%2$s" was expected.',
-                        'event_espresso'
-                    ),
-                    $context,
-                    implode(',', array_keys($contexts))
-                )
-            );
-        }
-    }
+	/**
+	 * Extra Meta key prefix for whether a given context for this message tmeplate group is active or not.
+	 */
+	const ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX = 'active_context_';
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group|mixed
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template_Group
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $message_type
+	 * @throws EE_Error
+	 */
+	public function set_message_type($message_type = false)
+	{
+		if (! $message_type) {
+			throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
+		}
+		$this->set('MTP_message_type', $message_type);
+	}
+
+
+	/**
+	 * @param bool $messenger
+	 * @throws EE_Error
+	 */
+	public function set_messenger($messenger = false)
+	{
+		if (! $messenger) {
+			throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
+		}
+		$this->set('MTP_messenger', $messenger);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(
+				esc_html__(
+					'Missing required value for the message template group id',
+					'event_espresso'
+				)
+			);
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function user()
+	{
+		$user_id = $this->get('MTP_user_id');
+		return empty($user_id) ? get_current_user_id() : $user_id;
+	}
+
+
+	/**
+	 * Wrapper for the user function() (preserve backward compat)
+	 *
+	 * @since  4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->user();
+	}
+
+
+	/**
+	 * This simply returns a count of all related events to this message template group
+	 *
+	 * @return int
+	 */
+	public function count_events()
+	{
+		return $this->count_related('Event');
+	}
+
+
+	/**
+	 * returns the name saved in the db for this template
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('MTP_name');
+	}
+
+
+	/**
+	 * Returns the description saved in the db for this template group
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('MTP_description');
+	}
+
+
+	/**
+	 * returns all related EE_Message_Template objects
+	 *
+	 * @param  array $query_params like EEM_Base::get_all()
+	 * @return EE_Message_Template[]
+	 * @throws EE_Error
+	 */
+	public function message_templates($query_params = array())
+	{
+		return $this->get_many_related('Message_Template', $query_params);
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function messenger()
+	{
+		return $this->get('MTP_messenger');
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 * If an attempt to get the corresponding messenger object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @return EE_messenger
+	 * @throws EE_Error
+	 */
+	public function messenger_obj()
+	{
+		$messenger = $this->messenger();
+		try {
+			$messenger = EEH_MSG_Template::messenger_obj($messenger);
+		} catch (EE_Error $e) {
+			//if an exception was thrown then let's deactivate this message template group because it means there is no
+			// class for this messenger in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $messenger;
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function message_type()
+	{
+		return $this->get('MTP_message_type');
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 * If an attempt to get the corresponding message type object fails, then we set this message
+	 * template group to inactive, and save to db.  Then return null so client code can handle
+	 * appropriately.
+	 *
+	 * @throws EE_Error
+	 * @return EE_message_type|false if exception thrown.
+	 */
+	public function message_type_obj()
+	{
+		$message_type = $this->message_type();
+		try {
+			$message_type = EEH_MSG_Template::message_type_obj($message_type);
+		} catch (EE_Error $e) {
+			//if an exception was thrown then let's deactivate this message template group because it means there is no
+			// class for the message type in this group.
+			$this->set('MTP_is_active', false);
+			$this->save();
+			return null;
+		}
+		return $message_type;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function contexts_config()
+	{
+		return $this->message_type_obj()->get_contexts();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 * Note this is an array with singular and plural keys
+	 *
+	 * @access public
+	 * @return array labels for "context"
+	 * @throws EE_Error
+	 */
+	public function context_label()
+	{
+		$obj = $this->message_type_obj();
+		return $obj->get_context_label();
+	}
+
+
+	/**
+	 * This returns an array of EE_Message_Template objects indexed by context and field.
+	 *
+	 * @return array ()
+	 * @throws EE_Error
+	 */
+	public function context_templates()
+	{
+		$mtps_arr = array();
+		$mtps     = $this->get_many_related('Message_Template');
+		if (empty($mtps)) {
+			return array();
+		}
+		//note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
+		foreach ($mtps as $mtp) {
+			$mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
+		}
+		return $mtps_arr;
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return bool true if it is, false if it isn't
+	 * @throws EE_Error
+	 */
+	public function is_global()
+	{
+		return $this->get('MTP_is_global');
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return bool true if it is, false if it isn't
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		return $this->get('MTP_is_active');
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @since 4.3.0
+	 * @uses  EEH_MSG_Template::get_shortcodes()
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be returned.
+	 * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the
+	 *                        unique shortcodes for all the given (or all) fields.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *                        shortcodes found.
+	 * @throws EE_Error
+	 */
+	public function get_shortcodes($context, $fields = array(), $merged = false)
+	{
+		$messenger    = $this->messenger();
+		$message_type = $this->message_type();
+		return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
+	}
+
+
+	/**
+	 * This just gets the template pack name assigned to this message template group.  If it's not set, then we just
+	 * use the default template pack.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_template_pack_name()
+	{
+		return $this->get_extra_meta('MTP_template_pack', true, 'default');
+	}
+
+
+	/**
+	 * This returns the specific template pack object referenced by the template pack name attached to this message
+	 * template group.  If no template pack is assigned then the default template pack is retrieved.
+	 *
+	 * @since 4.5.0
+	 * @return EE_Messages_Template_Pack
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_template_pack()
+	{
+		$pack_name = $this->get_template_pack_name();
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($pack_name);
+	}
+
+
+	/**
+	 * This retrieves the template variation assigned to this message template group.  If it's not set, then we just
+	 * use the default template variation.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_template_pack_variation()
+	{
+		return $this->get_extra_meta('MTP_variation', true, 'default');
+	}
+
+
+	/**
+	 * This just sets the template pack name attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $template_pack_name What message template pack is assigned.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function set_template_pack_name($template_pack_name)
+	{
+		return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
+	}
+
+
+	/**
+	 * This just sets the template pack variation attached to this message template group.
+	 *
+	 * @since 4.5.0
+	 * @param string $variation What variation is being set on the message template group.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function set_template_pack_variation($variation)
+	{
+		return $this->update_extra_meta('MTP_variation', $variation);
+	}
+
+
+	/**
+	 * Deactivates the given context.
+	 *
+	 * @param $context
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function deactivate_context($context)
+	{
+		$this->validate_context($context);
+		return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
+	}
+
+
+	/**
+	 * Activates the given context.
+	 *
+	 * @param $context
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function activate_context($context)
+	{
+		$this->validate_context($context);
+		return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
+	}
+
+
+	/**
+	 * Returns whether the context is active or not.
+	 * Note, this will default to true if the extra meta record doesn't exist.
+	 * Also, this does NOT account for whether the "To" field is empty or not. Some messengers may allow the "To" field
+	 * to be empty (@see EE_Messenger::allow_empty_to_field()) so an empty "To" field is not always an indicator of
+	 * whether a context is "active" or not.
+	 *
+	 * @param $context
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function is_context_active($context)
+	{
+		$this->validate_context($context);
+		return filter_var(
+			$this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Validates the incoming context to verify it matches a registered context for the related message type.
+	 * @param string $context
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	public function validate_context($context)
+	{
+		$contexts = $this->contexts_config();
+		if (! isset($contexts[$context])) {
+			throw new InvalidIdentifierException(
+				'',
+				'',
+				sprintf(
+					esc_html__(
+						'An invalid string identifying a context was provided.  "%1$s" was received, and one of "%2$s" was expected.',
+						'event_espresso'
+					),
+					$context,
+					implode(',', array_keys($contexts))
+				)
+			);
+		}
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -50,7 +50,7 @@ 
      */
     public function set_message_type($message_type = false)
     {
-        if (! $message_type) {
+        if ( ! $message_type) {
             throw new EE_Error(esc_html__('Missing required value for the message_type parameter', 'event_espresso'));
         }
         $this->set('MTP_message_type', $message_type);
@@ -63,7 +63,7 @@ 
      */
     public function set_messenger($messenger = false)
     {
-        if (! $messenger) {
+        if ( ! $messenger) {
             throw new EE_Error(esc_html__('Missing required value for the messenger parameter', 'event_espresso'));
         }
         $this->set('MTP_messenger', $messenger);
@@ -76,7 +76,7 @@ 
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(
                 esc_html__(
                     'Missing required value for the message template group id',
@@ -432,7 +432,7 @@ 
     public function deactivate_context($context)
     {
         $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, false);
+        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, false);
     }
 
 
@@ -447,7 +447,7 @@ 
     public function activate_context($context)
     {
         $this->validate_context($context);
-        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true);
+        return $this->update_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, true);
     }
 
 
@@ -467,7 +467,7 @@ 
     {
         $this->validate_context($context);
         return filter_var(
-            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX . $context, true, true),
+            $this->get_extra_meta(self::ACTIVE_CONTEXT_RECORD_META_KEY_PREFIX.$context, true, true),
             FILTER_VALIDATE_BOOLEAN
         );
     }
@@ -482,7 +482,7 @@ 
     public function validate_context($context)
     {
         $contexts = $this->contexts_config();
-        if (! isset($contexts[$context])) {
+        if ( ! isset($contexts[$context])) {
             throw new InvalidIdentifierException(
                 '',
                 '',

core/libraries/messages/EE_Messages_Generator.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -459,7 +459,7 @@ 
      * there's a single shared message template group among all the events.  Otherwise it returns null.
      *
      * @param array $event_ids
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -495,7 +495,7 @@ 
     /**
      * Retrieves the global message template group for the current messenger and message type.
      *
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -641,7 +641,7 @@ 
      * @param EE_Messages_Addressee     $recipient
      * @param array                     $templates formatted array of templates used for parsing data.
      * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
+     * @return EE_Message
      * @throws EE_Error
      */
     protected function _setup_message_object(

Indentation +966 added lines, -966 removed lines

@@ -13,970 +13,970 @@
 {
 
 
-    /**
-     * @type EE_Messages_Data_Handler_Collection
-     */
-    protected $_data_handler_collection;
-
-    /**
-     * @type  EE_Message_Template_Group_Collection
-     */
-    protected $_template_collection;
-
-    /**
-     * This will hold the data handler for the current EE_Message being generated.
-     *
-     * @type EE_Messages_incoming_data
-     */
-    protected $_current_data_handler;
-
-    /**
-     * This holds the EE_Messages_Queue that contains the messages to generate.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_generation_queue;
-
-    /**
-     * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_ready_queue;
-
-    /**
-     * This is a container for any error messages that get created through the generation
-     * process.
-     *
-     * @type array
-     */
-    protected $_error_msg = array();
-
-    /**
-     * Flag used to set when the current EE_Message in the generation queue has been verified.
-     *
-     * @type bool
-     */
-    protected $_verified = false;
-
-    /**
-     * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_messenger
-     */
-    protected $_current_messenger;
-
-    /**
-     * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_message_type
-     */
-    protected $_current_message_type;
-
-    /**
-     * @type EEH_Parse_Shortcodes
-     */
-    protected $_shortcode_parser;
-
-
-    /**
-     * @param EE_Messages_Queue                     $generation_queue
-     * @param \EE_Messages_Queue                    $ready_queue
-     * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
-     * @param \EE_Message_Template_Group_Collection $template_collection
-     * @param \EEH_Parse_Shortcodes                 $shortcode_parser
-     */
-    public function __construct(
-        EE_Messages_Queue $generation_queue,
-        EE_Messages_Queue $ready_queue,
-        EE_Messages_Data_Handler_Collection $data_handler_collection,
-        EE_Message_Template_Group_Collection $template_collection,
-        EEH_Parse_Shortcodes $shortcode_parser
-    ) {
-        $this->_generation_queue        = $generation_queue;
-        $this->_ready_queue             = $ready_queue;
-        $this->_data_handler_collection = $data_handler_collection;
-        $this->_template_collection     = $template_collection;
-        $this->_shortcode_parser        = $shortcode_parser;
-    }
-
-
-    /**
-     * @return EE_Messages_Queue
-     */
-    public function generation_queue()
-    {
-        return $this->_generation_queue;
-    }
-
-
-    /**
-     *  This iterates through the provided queue and generates the EE_Message objects.
-     *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
-     *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
-     *  for the caller to decide what to do with it.
-     *
-     * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
-     * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate($save = true)
-    {
-        //iterate through the messages in the queue, generate, and add to new queue.
-        $this->_generation_queue->get_message_repository()->rewind();
-        while ($this->_generation_queue->get_message_repository()->valid()) {
-            //reset "current" properties
-            $this->_reset_current_properties();
-
-            /** @type EE_Message $msg */
-            $msg = $this->_generation_queue->get_message_repository()->current();
-
-            /**
-             * need to get the next object and capture it for setting manually after deletes.  The reason is that when
-             * an object is removed from the repo then valid for the next object will fail.
-             */
-            $this->_generation_queue->get_message_repository()->next();
-            $next_msg = $this->_generation_queue->get_message_repository()->current();
-            //restore pointer to current item
-            $this->_generation_queue->get_message_repository()->set_current($msg);
-
-            //skip and delete if the current $msg is NOT incomplete (queued for generation)
-            if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
-                //we keep this item in the db just remove from the repo.
-                $this->_generation_queue->get_message_repository()->remove($msg);
-                //next item
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            if ($this->_verify()) {
-                //let's get generating!
-                $this->_generate();
-            }
-
-            //don't persist debug_only messages if the messages system is not in debug mode.
-            if ($msg->STS_ID() === EEM_Message::status_debug_only
-                && ! EEM_Message::debug()
-            ) {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_debug_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $this->_generation_queue->get_message_repository()->delete();
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            //if there are error messages then let's set the status and the error message.
-            if ($this->_error_msg) {
-                //if the status is already debug only, then let's leave it at that.
-                if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
-                    $msg->set_STS_ID(EEM_Message::status_failed);
-                }
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__processing_failed_message',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $msg->set_error_message(
-                    esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
-                    . "\n"
-                    . implode("\n", $this->_error_msg)
-                );
-                $msg->set_modified(time());
-            } else {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                //remove from db
-                $this->_generation_queue->get_message_repository()->delete();
-            }
-            //next item
-            $this->_generation_queue->get_message_repository()->set_current($next_msg);
-        }
-
-        //generation queue is ALWAYS saved to record any errors in the generation process.
-        $this->_generation_queue->save();
-
-        /**
-         * save _ready_queue if flag set.
-         * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
-         * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
-         * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
-         * irrelevant.
-         */
-        if ($save) {
-            $this->_ready_queue->save();
-        }
-
-        //final reset of properties
-        $this->_reset_current_properties();
-
-        return $this->_ready_queue;
-    }
-
-
-    /**
-     * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
-     * in the generation queue.
-     */
-    protected function _reset_current_properties()
-    {
-        $this->_verified = false;
-        //make sure any _data value in the current message type is reset
-        if ($this->_current_message_type instanceof EE_message_type) {
-            $this->_current_message_type->reset_data();
-        }
-        $this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
-    }
-
-
-    /**
-     * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
-     * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
-     * _generating_queue.
-     *
-     * @return bool Whether the message was successfully generated or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _generate()
-    {
-        //double check verification has run and that everything is ready to work with (saves us having to validate
-        // everything again).
-        if (! $this->_verified) {
-            return false; //get out because we don't have a valid setup to work with.
-        }
-
-
-        try {
-            $addressees = $this->_current_message_type->get_addressees(
-                $this->_current_data_handler,
-                $this->_generation_queue->get_message_repository()->current()->context()
-            );
-        } catch (EE_Error $e) {
-            $this->_error_msg[] = $e->getMessage();
-            return false;
-        }
-
-
-        //if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
-            do_action(
-                'AHEE__EE_Messages_Generator___generate__invalid_addressees',
-                $this->_generation_queue->get_message_repository()->current(),
-                $addressees,
-                $this->_current_messenger,
-                $this->_current_message_type,
-                $this->_current_data_handler
-            );
-            $this->_generation_queue->get_message_repository()->current()->set_STS_ID(
-                EEM_Message::status_debug_only
-            );
-            $this->_error_msg[] = esc_html__(
-                'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        $message_template_group = $this->_get_message_template_group();
-
-        //in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        //get formatted templates for using to parse and setup EE_Message objects.
-        $templates = $this->_get_templates($message_template_group);
-
-
-        //setup new EE_Message objects (and add to _ready_queue)
-        return $this->_assemble_messages($addressees, $templates, $message_template_group);
-    }
-
-
-    /**
-     * Retrieves the message template group being used for generating messages.
-     * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_message_template_group()
-    {
-        //first see if there is a specific message template group requested (current message in the queue has a specific
-        //GRP_ID
-        $message_template_group = $this->_specific_message_template_group_from_queue();
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //get event_ids from the datahandler so we can check to see if there's already a message template group for them
-        //in the collection.
-        $event_ids              = $this->_get_event_ids_from_current_data_handler();
-        $message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                $event_ids
-            )
-        );
-
-        //if we have a message template group then no need to hit the database, just return it.
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //okay made it here, so let's get the global group first for this messenger and message type to ensure
-        //there is no override set.
-        $global_message_template_group =
-            $this->_get_global_message_template_group_for_current_messenger_and_message_type();
-
-        if ($global_message_template_group instanceof EE_Message_Template_Group
-            && $global_message_template_group->get('MTP_is_override')
-        ) {
-            return $global_message_template_group;
-        }
-
-        //if we're still here, that means there was no message template group for the events in the collection and
-        //the global message template group for the messenger and message type is not set for override.  So next step is
-        //to see if there is a common shared custom message template group for this set of events.
-        $message_template_group = $this->_get_shared_message_template_for_events($event_ids);
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
-        //So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
-        //and return it.
-        if ($global_message_template_group instanceof EE_Message_Template_Group) {
-            $this->_template_collection->add(
-                $global_message_template_group,
-                $event_ids
-            );
-            return $global_message_template_group;
-        }
-
-        //if we land here that means there's NO active message template group for this set.
-        //TODO this will be a good target for some optimization down the road.  Whenever there is no active message
-        //template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
-        //this should likely bit hit rarely enough that it's not a significant issue.
-        return null;
-    }
-
-
-    /**
-     * This checks the current message in the queue and determines if there is a specific Message Template Group
-     * requested for that message.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _specific_message_template_group_from_queue()
-    {
-        //is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
-        //so let's use that.
-        $GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
-
-        if ($GRP_ID) {
-            //attempt to retrieve from repo first
-            $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  //got it!
-            }
-
-            //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
-            //is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add($message_template_group);
-                return $message_template_group;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether the event ids passed in all share the same message template group for the current message type
-     * and messenger.
-     *
-     * @param array $event_ids
-     * @return bool true means they DO share the same message template group, false means they don't.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
-    {
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[$event['ID']] = $event['ID'];
-        }
-        $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
-            array(
-                array(
-                    'Event.EVT_ID'           => array('IN', $event_ids),
-                    'MTP_messenger'    => $this->_current_messenger->name,
-                    'MTP_message_type' => $this->_current_message_type->name,
-                ),
-            ),
-            'GRP_ID',
-            true
-        );
-        return $count_of_message_template_groups === 1;
-    }
-
-
-    /**
-     * This will get the shared message template group for events that are in the current data handler but ONLY if
-     * there's a single shared message template group among all the events.  Otherwise it returns null.
-     *
-     * @param array $event_ids
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_shared_message_template_for_events(array $event_ids)
-    {
-        $message_template_group = null;
-        if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'Event.EVT_ID'           => array('IN', $event_ids),
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                    ),
-                    'group_by' => 'GRP_ID',
-                )
-            );
-            //store this in the collection if its valid
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $message_template_group,
-                    $event_ids
-                );
-            }
-        }
-        return $message_template_group;
-    }
-
-
-    /**
-     * Retrieves the global message template group for the current messenger and message type.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_global_message_template_group_for_current_messenger_and_message_type()
-    {
-        //first check the collection (we use an array with 0 in it to represent global groups).
-        $global_message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                array(0)
-            )
-        );
-
-        //if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
-            $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-            //if we have a group, add it to the collection.
-            if ($global_message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $global_message_template_group,
-                    array(0)
-                );
-            }
-        }
-        return $global_message_template_group;
-    }
-
-
-    /**
-     * Returns an array of event ids for all the events within the current data handler.
-     *
-     * @return array
-     */
-    protected function _get_event_ids_from_current_data_handler()
-    {
-        $event_ids = array();
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[$event['ID']] = $event['ID'];
-        }
-        return $event_ids;
-    }
-
-
-    /**
-     *  Retrieves formatted array of template information for each context specific to the given
-     *  EE_Message_Template_Group
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @return array The returned array is in this structure:
-     *                          array(
-     *                          'field_name' => array(
-     *                          'context' => 'content'
-     *                          )
-     *                          )
-     * @throws EE_Error
-     */
-    protected function _get_templates(EE_Message_Template_Group $message_template_group)
-    {
-        $templates         = array();
-        $context_templates = $message_template_group->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
-                    continue;
-                }
-                $templates[$template_field][$context] = $template_obj->get('MTP_content');
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Assembles new fully generated EE_Message objects and adds to _ready_queue
-     *
-     * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
-     *                                               context.
-     * @param array                     $templates   formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
-     *                                               method will attempt to generate ALL EE_Message objects and add to
-     *                                               the _ready_queue.  Successfully generated messages get added to the
-     *                                               queue with EEM_Message::status_idle, unsuccessfully generated
-     *                                               messages will get added to the queue as EEM_Message::status_failed.
-     *                                               Very rarely should "false" be returned from this method.
-     * @throws EE_Error
-     */
-    protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
-    {
-
-        //if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to assemble messages because there are no templates retrieved for generating the messages with',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        //We use this as the counter for generated messages because don't forget we may be executing this inside of a
-        //generation_queue.  So _ready_queue may have generated EE_Message objects already.
-        $generated_count = 0;
-        foreach ($addressees as $context => $recipients) {
-            foreach ($recipients as $recipient) {
-                $message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
-                if ($message instanceof EE_Message) {
-                    $this->_ready_queue->add(
-                        $message,
-                        array(),
-                        $this->_generation_queue->get_message_repository()->is_preview(),
-                        $this->_generation_queue->get_message_repository()->is_test_send()
-                    );
-                    $generated_count++;
-                }
-
-                //if the current MSG being generated is for a test send then we'll only use ONE message in the
-                // generation.
-                if ($this->_generation_queue->get_message_repository()->is_test_send()) {
-                    break 2;
-                }
-            }
-        }
-
-        //if there are no generated messages then something else fatal went wrong.
-        return $generated_count > 0;
-    }
-
-
-    /**
-     * @param string                    $context   The context for the generated message.
-     * @param EE_Messages_Addressee     $recipient
-     * @param array                     $templates formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
-     * @throws EE_Error
-     */
-    protected function _setup_message_object(
-        $context,
-        EE_Messages_Addressee $recipient,
-        $templates,
-        EE_Message_Template_Group $message_template_group
-    ) {
-        //stuff we already know
-        $transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
-        $transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
-            ? $this->_current_data_handler->txn->ID()
-            : $transaction_id;
-        $message_fields = array(
-            'GRP_ID'           => $message_template_group->ID(),
-            'TXN_ID'           => $transaction_id,
-            'MSG_messenger'    => $this->_current_messenger->name,
-            'MSG_message_type' => $this->_current_message_type->name,
-            'MSG_context'      => $context,
-        );
-
-        //recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
-        // the info from the att_obj found in the EE_Messages_Addressee object.
-        if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
-            $message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
-                ? $recipient->att_obj->ID()
-                : 0;
-            $message_fields['MSG_recipient_type'] = 'Attendee';
-        } else {
-            $message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
-            $message_fields['MSG_recipient_type'] = $recipient->recipient_type;
-        }
-        $message = EE_Message_Factory::create($message_fields);
-
-        //grab valid shortcodes for shortcode parser
-        $mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
-        $m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
-
-        //if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
-        if ((
-                (
-                    empty($templates['to'][$context])
-                    && ! $this->_current_messenger->allow_empty_to_field()
-                )
-                || ! $message_template_group->is_context_active($context)
-            )
-            && ! $this->_generation_queue->get_message_repository()->is_preview()
-        ) {
-            //we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
-            //field.
-            return false;
-        }
-        $error_msg = array();
-        foreach ($templates as $field => $field_context) {
-            $error_msg = array();
-            //let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[$context];
-            //merge in valid shortcodes for the field.
-            $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
-            if (isset($templates[$field][$context])) {
-                //prefix field.
-                $column_name = 'MSG_' . $field;
-                try {
-                    $content = $this->_shortcode_parser->parse_message_template(
-                        $templates[$field][$context],
-                        $recipient,
-                        $shortcodes,
-                        $this->_current_message_type,
-                        $this->_current_messenger,
-                        $message
-                    );
-                    $message->set_field_or_extra_meta($column_name, $content);
-                } catch (EE_Error $e) {
-                    $error_msg[] = sprintf(
-                        esc_html__(
-                            'There was a problem generating the content for the field %s: %s',
-                            'event_espresso'
-                        ),
-                        $field,
-                        $e->getMessage()
-                    );
-                    $message->set_STS_ID(EEM_Message::status_failed);
-                }
-            }
-        }
-
-        if ($message->STS_ID() === EEM_Message::status_failed) {
-            $error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
-                         . "\n"
-                         . implode("\n", $error_msg);
-            $message->set_error_message($error_msg);
-        } else {
-            $message->set_STS_ID(EEM_Message::status_idle);
-        }
-        return $message;
-    }
-
-
-    /**
-     * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
-     * error message if either is missing.
-     *
-     * @return bool true means there were no errors, false means there were errors.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _verify()
-    {
-        //reset error message to an empty array.
-        $this->_error_msg = array();
-        $valid            = true;
-        $valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
-        $valid            = $valid ? $this->_validate_and_setup_data() : $valid;
-
-        //set the verified flag so we know everything has been validated.
-        $this->_verified = $valid;
-
-        return $valid;
-    }
-
-
-    /**
-     * This accepts an array and validates that it is an array indexed by context with each value being an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
-     * @return bool
-     */
-    protected function _valid_addressees($addressees)
-    {
-        if (! $addressees || ! is_array($addressees)) {
-            return false;
-        }
-
-        foreach ($addressees as $addressee_array) {
-            foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
-     * queue. This process sets error messages if something is wrong.
-     *
-     * @return bool   true is if there are no errors.  false is if there is.
-     */
-    protected function _validate_messenger_and_message_type()
-    {
-
-        //first are there any existing error messages?  If so then return.
-        if ($this->_error_msg) {
-            return false;
-        }
-        /** @type EE_Message $message */
-        $message = $this->_generation_queue->get_message_repository()->current();
-        try {
-            $this->_current_messenger = $message->valid_messenger(true)
-                ? $message->messenger_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-        try {
-            $this->_current_message_type = $message->valid_message_type(true)
-                ? $message->message_type_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-
-        /**
-         * Check if there is any generation data, but only if this is not for a preview.
-         */
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
-            && (
-                ! $this->_generation_queue->get_message_repository()->is_preview()
-                && $this->_generation_queue->get_message_repository()->get_data_handler()
-                   !== 'EE_Messages_Preview_incoming_data'
-            )
-        ) {
-            $this->_error_msg[] = esc_html__(
-                'There is no generation data for this message. Unable to generate.',
-                'event_espresso'
-            );
-        }
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * This method retrieves the expected data handler for the message type and validates the generation data for that
-     * data handler.
-     *
-     * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _validate_and_setup_data()
-    {
-
-        //First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
-        //be used anyways.
-        if ($this->_error_msg) {
-            return false;
-        }
-
-        $generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
-
-        /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually*/
-        $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
-            ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
-
-        //If this EE_Message is for a preview, then let's switch out to the preview data handler.
-        if ($this->_generation_queue->get_message_repository()->is_preview()) {
-            $data_handler_class_name = 'EE_Messages_Preview_incoming_data';
-        }
-
-        //First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
-            $this->_error_msg[] = sprintf(
-                esc_html__(
-                    'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
-                    'event_espresso'
-                ),
-                'EE_Messages_incoming_data',
-                $data_handler_class_name
-            );
-            return false;
-        }
-
-        //convert generation_data for data_handler_instantiation.
-        $generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
-
-        //note, this may set error messages as well.
-        $this->_set_data_handler($generation_data, $data_handler_class_name);
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
-     * adds it to the _data repository.
-     *
-     * @param mixed  $generating_data           This is data expected by the instantiated data handler.
-     * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
-     *                                          instantiated.
-     * @return void .
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_data_handler($generating_data, $data_handler_class_name)
-    {
-        //valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
-        //is already a ready data handler in the repository.
-        $this->_current_data_handler = $this->_data_handler_collection->get_by_key(
-            $this->_data_handler_collection->get_key(
-                $data_handler_class_name,
-                $generating_data
-            )
-        );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
-            //no saved data_handler in the repo so let's set one up and add it to the repo.
-            try {
-                $this->_current_data_handler = new $data_handler_class_name($generating_data);
-                $this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
-            } catch (EE_Error $e) {
-                $this->_error_msg[] = $e->get_error();
-            }
-        }
-    }
-
-
-    /**
-     * The queued EE_Message for generation does not save the data used for generation as objects
-     * because serialization of those objects could be problematic if the data is saved to the db.
-     * So this method calls the static method on the associated data_handler for the given message_type
-     * and that preps the data for later instantiation when generating.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $preview Indicate whether this is being used for a preview or not.
-     * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
-     */
-    protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
-    {
-        /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
-        $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        if (! $message_to_generate->valid()) {
-            return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
-        }
-        return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
-    }
-
-
-    /**
-     * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        //prep data
-        $data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
-
-        $message = $message_to_generate->get_EE_Message();
-
-        //is there a GRP_ID in the request?
-        if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
-            $message->set_GRP_ID($GRP_ID);
-        }
-
-        if ($data === false) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                esc_html__(
-                    'Unable to prepare data for persistence to the database.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            //make sure that the data handler is cached on the message as well
-            $data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
-        }
-
-        $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
-    }
+	/**
+	 * @type EE_Messages_Data_Handler_Collection
+	 */
+	protected $_data_handler_collection;
+
+	/**
+	 * @type  EE_Message_Template_Group_Collection
+	 */
+	protected $_template_collection;
+
+	/**
+	 * This will hold the data handler for the current EE_Message being generated.
+	 *
+	 * @type EE_Messages_incoming_data
+	 */
+	protected $_current_data_handler;
+
+	/**
+	 * This holds the EE_Messages_Queue that contains the messages to generate.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_generation_queue;
+
+	/**
+	 * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_ready_queue;
+
+	/**
+	 * This is a container for any error messages that get created through the generation
+	 * process.
+	 *
+	 * @type array
+	 */
+	protected $_error_msg = array();
+
+	/**
+	 * Flag used to set when the current EE_Message in the generation queue has been verified.
+	 *
+	 * @type bool
+	 */
+	protected $_verified = false;
+
+	/**
+	 * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_messenger
+	 */
+	protected $_current_messenger;
+
+	/**
+	 * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_message_type
+	 */
+	protected $_current_message_type;
+
+	/**
+	 * @type EEH_Parse_Shortcodes
+	 */
+	protected $_shortcode_parser;
+
+
+	/**
+	 * @param EE_Messages_Queue                     $generation_queue
+	 * @param \EE_Messages_Queue                    $ready_queue
+	 * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
+	 * @param \EE_Message_Template_Group_Collection $template_collection
+	 * @param \EEH_Parse_Shortcodes                 $shortcode_parser
+	 */
+	public function __construct(
+		EE_Messages_Queue $generation_queue,
+		EE_Messages_Queue $ready_queue,
+		EE_Messages_Data_Handler_Collection $data_handler_collection,
+		EE_Message_Template_Group_Collection $template_collection,
+		EEH_Parse_Shortcodes $shortcode_parser
+	) {
+		$this->_generation_queue        = $generation_queue;
+		$this->_ready_queue             = $ready_queue;
+		$this->_data_handler_collection = $data_handler_collection;
+		$this->_template_collection     = $template_collection;
+		$this->_shortcode_parser        = $shortcode_parser;
+	}
+
+
+	/**
+	 * @return EE_Messages_Queue
+	 */
+	public function generation_queue()
+	{
+		return $this->_generation_queue;
+	}
+
+
+	/**
+	 *  This iterates through the provided queue and generates the EE_Message objects.
+	 *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
+	 *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
+	 *  for the caller to decide what to do with it.
+	 *
+	 * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
+	 * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate($save = true)
+	{
+		//iterate through the messages in the queue, generate, and add to new queue.
+		$this->_generation_queue->get_message_repository()->rewind();
+		while ($this->_generation_queue->get_message_repository()->valid()) {
+			//reset "current" properties
+			$this->_reset_current_properties();
+
+			/** @type EE_Message $msg */
+			$msg = $this->_generation_queue->get_message_repository()->current();
+
+			/**
+			 * need to get the next object and capture it for setting manually after deletes.  The reason is that when
+			 * an object is removed from the repo then valid for the next object will fail.
+			 */
+			$this->_generation_queue->get_message_repository()->next();
+			$next_msg = $this->_generation_queue->get_message_repository()->current();
+			//restore pointer to current item
+			$this->_generation_queue->get_message_repository()->set_current($msg);
+
+			//skip and delete if the current $msg is NOT incomplete (queued for generation)
+			if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
+				//we keep this item in the db just remove from the repo.
+				$this->_generation_queue->get_message_repository()->remove($msg);
+				//next item
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			if ($this->_verify()) {
+				//let's get generating!
+				$this->_generate();
+			}
+
+			//don't persist debug_only messages if the messages system is not in debug mode.
+			if ($msg->STS_ID() === EEM_Message::status_debug_only
+				&& ! EEM_Message::debug()
+			) {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_debug_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$this->_generation_queue->get_message_repository()->delete();
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			//if there are error messages then let's set the status and the error message.
+			if ($this->_error_msg) {
+				//if the status is already debug only, then let's leave it at that.
+				if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
+					$msg->set_STS_ID(EEM_Message::status_failed);
+				}
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__processing_failed_message',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$msg->set_error_message(
+					esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
+					. "\n"
+					. implode("\n", $this->_error_msg)
+				);
+				$msg->set_modified(time());
+			} else {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				//remove from db
+				$this->_generation_queue->get_message_repository()->delete();
+			}
+			//next item
+			$this->_generation_queue->get_message_repository()->set_current($next_msg);
+		}
+
+		//generation queue is ALWAYS saved to record any errors in the generation process.
+		$this->_generation_queue->save();
+
+		/**
+		 * save _ready_queue if flag set.
+		 * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
+		 * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
+		 * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
+		 * irrelevant.
+		 */
+		if ($save) {
+			$this->_ready_queue->save();
+		}
+
+		//final reset of properties
+		$this->_reset_current_properties();
+
+		return $this->_ready_queue;
+	}
+
+
+	/**
+	 * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
+	 * in the generation queue.
+	 */
+	protected function _reset_current_properties()
+	{
+		$this->_verified = false;
+		//make sure any _data value in the current message type is reset
+		if ($this->_current_message_type instanceof EE_message_type) {
+			$this->_current_message_type->reset_data();
+		}
+		$this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
+	}
+
+
+	/**
+	 * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
+	 * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
+	 * _generating_queue.
+	 *
+	 * @return bool Whether the message was successfully generated or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _generate()
+	{
+		//double check verification has run and that everything is ready to work with (saves us having to validate
+		// everything again).
+		if (! $this->_verified) {
+			return false; //get out because we don't have a valid setup to work with.
+		}
+
+
+		try {
+			$addressees = $this->_current_message_type->get_addressees(
+				$this->_current_data_handler,
+				$this->_generation_queue->get_message_repository()->current()->context()
+			);
+		} catch (EE_Error $e) {
+			$this->_error_msg[] = $e->getMessage();
+			return false;
+		}
+
+
+		//if no addressees then get out because there is nothing to generation (possible bad data).
+		if (! $this->_valid_addressees($addressees)) {
+			do_action(
+				'AHEE__EE_Messages_Generator___generate__invalid_addressees',
+				$this->_generation_queue->get_message_repository()->current(),
+				$addressees,
+				$this->_current_messenger,
+				$this->_current_message_type,
+				$this->_current_data_handler
+			);
+			$this->_generation_queue->get_message_repository()->current()->set_STS_ID(
+				EEM_Message::status_debug_only
+			);
+			$this->_error_msg[] = esc_html__(
+				'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		$message_template_group = $this->_get_message_template_group();
+
+		//in the unlikely event there is no EE_Message_Template_Group available, get out!
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		//get formatted templates for using to parse and setup EE_Message objects.
+		$templates = $this->_get_templates($message_template_group);
+
+
+		//setup new EE_Message objects (and add to _ready_queue)
+		return $this->_assemble_messages($addressees, $templates, $message_template_group);
+	}
+
+
+	/**
+	 * Retrieves the message template group being used for generating messages.
+	 * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_message_template_group()
+	{
+		//first see if there is a specific message template group requested (current message in the queue has a specific
+		//GRP_ID
+		$message_template_group = $this->_specific_message_template_group_from_queue();
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//get event_ids from the datahandler so we can check to see if there's already a message template group for them
+		//in the collection.
+		$event_ids              = $this->_get_event_ids_from_current_data_handler();
+		$message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				$event_ids
+			)
+		);
+
+		//if we have a message template group then no need to hit the database, just return it.
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//okay made it here, so let's get the global group first for this messenger and message type to ensure
+		//there is no override set.
+		$global_message_template_group =
+			$this->_get_global_message_template_group_for_current_messenger_and_message_type();
+
+		if ($global_message_template_group instanceof EE_Message_Template_Group
+			&& $global_message_template_group->get('MTP_is_override')
+		) {
+			return $global_message_template_group;
+		}
+
+		//if we're still here, that means there was no message template group for the events in the collection and
+		//the global message template group for the messenger and message type is not set for override.  So next step is
+		//to see if there is a common shared custom message template group for this set of events.
+		$message_template_group = $this->_get_shared_message_template_for_events($event_ids);
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
+		//So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
+		//and return it.
+		if ($global_message_template_group instanceof EE_Message_Template_Group) {
+			$this->_template_collection->add(
+				$global_message_template_group,
+				$event_ids
+			);
+			return $global_message_template_group;
+		}
+
+		//if we land here that means there's NO active message template group for this set.
+		//TODO this will be a good target for some optimization down the road.  Whenever there is no active message
+		//template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
+		//this should likely bit hit rarely enough that it's not a significant issue.
+		return null;
+	}
+
+
+	/**
+	 * This checks the current message in the queue and determines if there is a specific Message Template Group
+	 * requested for that message.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _specific_message_template_group_from_queue()
+	{
+		//is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
+		//so let's use that.
+		$GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
+
+		if ($GRP_ID) {
+			//attempt to retrieve from repo first
+			$message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				return $message_template_group;  //got it!
+			}
+
+			//nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
+			//is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add($message_template_group);
+				return $message_template_group;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether the event ids passed in all share the same message template group for the current message type
+	 * and messenger.
+	 *
+	 * @param array $event_ids
+	 * @return bool true means they DO share the same message template group, false means they don't.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
+	{
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[$event['ID']] = $event['ID'];
+		}
+		$count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
+			array(
+				array(
+					'Event.EVT_ID'           => array('IN', $event_ids),
+					'MTP_messenger'    => $this->_current_messenger->name,
+					'MTP_message_type' => $this->_current_message_type->name,
+				),
+			),
+			'GRP_ID',
+			true
+		);
+		return $count_of_message_template_groups === 1;
+	}
+
+
+	/**
+	 * This will get the shared message template group for events that are in the current data handler but ONLY if
+	 * there's a single shared message template group among all the events.  Otherwise it returns null.
+	 *
+	 * @param array $event_ids
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_shared_message_template_for_events(array $event_ids)
+	{
+		$message_template_group = null;
+		if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'Event.EVT_ID'           => array('IN', $event_ids),
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+					),
+					'group_by' => 'GRP_ID',
+				)
+			);
+			//store this in the collection if its valid
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$message_template_group,
+					$event_ids
+				);
+			}
+		}
+		return $message_template_group;
+	}
+
+
+	/**
+	 * Retrieves the global message template group for the current messenger and message type.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_global_message_template_group_for_current_messenger_and_message_type()
+	{
+		//first check the collection (we use an array with 0 in it to represent global groups).
+		$global_message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				array(0)
+			)
+		);
+
+		//if we don't have a group lets hit the db.
+		if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+			$global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+			//if we have a group, add it to the collection.
+			if ($global_message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$global_message_template_group,
+					array(0)
+				);
+			}
+		}
+		return $global_message_template_group;
+	}
+
+
+	/**
+	 * Returns an array of event ids for all the events within the current data handler.
+	 *
+	 * @return array
+	 */
+	protected function _get_event_ids_from_current_data_handler()
+	{
+		$event_ids = array();
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[$event['ID']] = $event['ID'];
+		}
+		return $event_ids;
+	}
+
+
+	/**
+	 *  Retrieves formatted array of template information for each context specific to the given
+	 *  EE_Message_Template_Group
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return array The returned array is in this structure:
+	 *                          array(
+	 *                          'field_name' => array(
+	 *                          'context' => 'content'
+	 *                          )
+	 *                          )
+	 * @throws EE_Error
+	 */
+	protected function _get_templates(EE_Message_Template_Group $message_template_group)
+	{
+		$templates         = array();
+		$context_templates = $message_template_group->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			foreach ($template_fields as $template_field => $template_obj) {
+				if (! $template_obj instanceof EE_Message_Template) {
+					continue;
+				}
+				$templates[$template_field][$context] = $template_obj->get('MTP_content');
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Assembles new fully generated EE_Message objects and adds to _ready_queue
+	 *
+	 * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
+	 *                                               context.
+	 * @param array                     $templates   formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
+	 *                                               method will attempt to generate ALL EE_Message objects and add to
+	 *                                               the _ready_queue.  Successfully generated messages get added to the
+	 *                                               queue with EEM_Message::status_idle, unsuccessfully generated
+	 *                                               messages will get added to the queue as EEM_Message::status_failed.
+	 *                                               Very rarely should "false" be returned from this method.
+	 * @throws EE_Error
+	 */
+	protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
+	{
+
+		//if templates are empty then get out because we can't generate anything.
+		if (! $templates) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to assemble messages because there are no templates retrieved for generating the messages with',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		//We use this as the counter for generated messages because don't forget we may be executing this inside of a
+		//generation_queue.  So _ready_queue may have generated EE_Message objects already.
+		$generated_count = 0;
+		foreach ($addressees as $context => $recipients) {
+			foreach ($recipients as $recipient) {
+				$message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
+				if ($message instanceof EE_Message) {
+					$this->_ready_queue->add(
+						$message,
+						array(),
+						$this->_generation_queue->get_message_repository()->is_preview(),
+						$this->_generation_queue->get_message_repository()->is_test_send()
+					);
+					$generated_count++;
+				}
+
+				//if the current MSG being generated is for a test send then we'll only use ONE message in the
+				// generation.
+				if ($this->_generation_queue->get_message_repository()->is_test_send()) {
+					break 2;
+				}
+			}
+		}
+
+		//if there are no generated messages then something else fatal went wrong.
+		return $generated_count > 0;
+	}
+
+
+	/**
+	 * @param string                    $context   The context for the generated message.
+	 * @param EE_Messages_Addressee     $recipient
+	 * @param array                     $templates formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool|EE_Message
+	 * @throws EE_Error
+	 */
+	protected function _setup_message_object(
+		$context,
+		EE_Messages_Addressee $recipient,
+		$templates,
+		EE_Message_Template_Group $message_template_group
+	) {
+		//stuff we already know
+		$transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
+		$transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
+			? $this->_current_data_handler->txn->ID()
+			: $transaction_id;
+		$message_fields = array(
+			'GRP_ID'           => $message_template_group->ID(),
+			'TXN_ID'           => $transaction_id,
+			'MSG_messenger'    => $this->_current_messenger->name,
+			'MSG_message_type' => $this->_current_message_type->name,
+			'MSG_context'      => $context,
+		);
+
+		//recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
+		// the info from the att_obj found in the EE_Messages_Addressee object.
+		if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
+			$message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
+				? $recipient->att_obj->ID()
+				: 0;
+			$message_fields['MSG_recipient_type'] = 'Attendee';
+		} else {
+			$message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
+			$message_fields['MSG_recipient_type'] = $recipient->recipient_type;
+		}
+		$message = EE_Message_Factory::create($message_fields);
+
+		//grab valid shortcodes for shortcode parser
+		$mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
+		$m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
+
+		//if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
+		if ((
+				(
+					empty($templates['to'][$context])
+					&& ! $this->_current_messenger->allow_empty_to_field()
+				)
+				|| ! $message_template_group->is_context_active($context)
+			)
+			&& ! $this->_generation_queue->get_message_repository()->is_preview()
+		) {
+			//we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
+			//field.
+			return false;
+		}
+		$error_msg = array();
+		foreach ($templates as $field => $field_context) {
+			$error_msg = array();
+			//let's setup the valid shortcodes for the incoming context.
+			$valid_shortcodes = $mt_shortcodes[$context];
+			//merge in valid shortcodes for the field.
+			$shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
+			if (isset($templates[$field][$context])) {
+				//prefix field.
+				$column_name = 'MSG_' . $field;
+				try {
+					$content = $this->_shortcode_parser->parse_message_template(
+						$templates[$field][$context],
+						$recipient,
+						$shortcodes,
+						$this->_current_message_type,
+						$this->_current_messenger,
+						$message
+					);
+					$message->set_field_or_extra_meta($column_name, $content);
+				} catch (EE_Error $e) {
+					$error_msg[] = sprintf(
+						esc_html__(
+							'There was a problem generating the content for the field %s: %s',
+							'event_espresso'
+						),
+						$field,
+						$e->getMessage()
+					);
+					$message->set_STS_ID(EEM_Message::status_failed);
+				}
+			}
+		}
+
+		if ($message->STS_ID() === EEM_Message::status_failed) {
+			$error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
+						 . "\n"
+						 . implode("\n", $error_msg);
+			$message->set_error_message($error_msg);
+		} else {
+			$message->set_STS_ID(EEM_Message::status_idle);
+		}
+		return $message;
+	}
+
+
+	/**
+	 * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
+	 * error message if either is missing.
+	 *
+	 * @return bool true means there were no errors, false means there were errors.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _verify()
+	{
+		//reset error message to an empty array.
+		$this->_error_msg = array();
+		$valid            = true;
+		$valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
+		$valid            = $valid ? $this->_validate_and_setup_data() : $valid;
+
+		//set the verified flag so we know everything has been validated.
+		$this->_verified = $valid;
+
+		return $valid;
+	}
+
+
+	/**
+	 * This accepts an array and validates that it is an array indexed by context with each value being an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
+	 * @return bool
+	 */
+	protected function _valid_addressees($addressees)
+	{
+		if (! $addressees || ! is_array($addressees)) {
+			return false;
+		}
+
+		foreach ($addressees as $addressee_array) {
+			foreach ($addressee_array as $addressee) {
+				if (! $addressee instanceof EE_Messages_Addressee) {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
+	 * queue. This process sets error messages if something is wrong.
+	 *
+	 * @return bool   true is if there are no errors.  false is if there is.
+	 */
+	protected function _validate_messenger_and_message_type()
+	{
+
+		//first are there any existing error messages?  If so then return.
+		if ($this->_error_msg) {
+			return false;
+		}
+		/** @type EE_Message $message */
+		$message = $this->_generation_queue->get_message_repository()->current();
+		try {
+			$this->_current_messenger = $message->valid_messenger(true)
+				? $message->messenger_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+		try {
+			$this->_current_message_type = $message->valid_message_type(true)
+				? $message->message_type_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+
+		/**
+		 * Check if there is any generation data, but only if this is not for a preview.
+		 */
+		if (! $this->_generation_queue->get_message_repository()->get_generation_data()
+			&& (
+				! $this->_generation_queue->get_message_repository()->is_preview()
+				&& $this->_generation_queue->get_message_repository()->get_data_handler()
+				   !== 'EE_Messages_Preview_incoming_data'
+			)
+		) {
+			$this->_error_msg[] = esc_html__(
+				'There is no generation data for this message. Unable to generate.',
+				'event_espresso'
+			);
+		}
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * This method retrieves the expected data handler for the message type and validates the generation data for that
+	 * data handler.
+	 *
+	 * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _validate_and_setup_data()
+	{
+
+		//First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
+		//be used anyways.
+		if ($this->_error_msg) {
+			return false;
+		}
+
+		$generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
+
+		/** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually*/
+		$data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
+			? $this->_generation_queue->get_message_repository()->get_data_handler()
+			: 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+
+		//If this EE_Message is for a preview, then let's switch out to the preview data handler.
+		if ($this->_generation_queue->get_message_repository()->is_preview()) {
+			$data_handler_class_name = 'EE_Messages_Preview_incoming_data';
+		}
+
+		//First get the class name for the data handler (and also verifies it exists.
+		if (! class_exists($data_handler_class_name)) {
+			$this->_error_msg[] = sprintf(
+				esc_html__(
+					'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
+					'event_espresso'
+				),
+				'EE_Messages_incoming_data',
+				$data_handler_class_name
+			);
+			return false;
+		}
+
+		//convert generation_data for data_handler_instantiation.
+		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
+
+		//note, this may set error messages as well.
+		$this->_set_data_handler($generation_data, $data_handler_class_name);
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
+	 * adds it to the _data repository.
+	 *
+	 * @param mixed  $generating_data           This is data expected by the instantiated data handler.
+	 * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
+	 *                                          instantiated.
+	 * @return void .
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_data_handler($generating_data, $data_handler_class_name)
+	{
+		//valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
+		//is already a ready data handler in the repository.
+		$this->_current_data_handler = $this->_data_handler_collection->get_by_key(
+			$this->_data_handler_collection->get_key(
+				$data_handler_class_name,
+				$generating_data
+			)
+		);
+		if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+			//no saved data_handler in the repo so let's set one up and add it to the repo.
+			try {
+				$this->_current_data_handler = new $data_handler_class_name($generating_data);
+				$this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
+			} catch (EE_Error $e) {
+				$this->_error_msg[] = $e->get_error();
+			}
+		}
+	}
+
+
+	/**
+	 * The queued EE_Message for generation does not save the data used for generation as objects
+	 * because serialization of those objects could be problematic if the data is saved to the db.
+	 * So this method calls the static method on the associated data_handler for the given message_type
+	 * and that preps the data for later instantiation when generating.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $preview Indicate whether this is being used for a preview or not.
+	 * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
+	 */
+	protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
+	{
+		/** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
+		$data_handler = $message_to_generate->get_data_handler_class_name($preview);
+		if (! $message_to_generate->valid()) {
+			return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
+		}
+		return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
+	}
+
+
+	/**
+	 * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		//prep data
+		$data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
+
+		$message = $message_to_generate->get_EE_Message();
+
+		//is there a GRP_ID in the request?
+		if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
+			$message->set_GRP_ID($GRP_ID);
+		}
+
+		if ($data === false) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				esc_html__(
+					'Unable to prepare data for persistence to the database.',
+					'event_espresso'
+				)
+			);
+		} else {
+			//make sure that the data handler is cached on the message as well
+			$data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
+		}
+
+		$this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -259,7 +259,7 @@ 
     {
         //double check verification has run and that everything is ready to work with (saves us having to validate
         // everything again).
-        if (! $this->_verified) {
+        if ( ! $this->_verified) {
             return false; //get out because we don't have a valid setup to work with.
         }
 
@@ -276,7 +276,7 @@ 
 
 
         //if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
+        if ( ! $this->_valid_addressees($addressees)) {
             do_action(
                 'AHEE__EE_Messages_Generator___generate__invalid_addressees',
                 $this->_generation_queue->get_message_repository()->current(),
@@ -298,7 +298,7 @@ 
         $message_template_group = $this->_get_message_template_group();
 
         //in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             $this->_error_msg[] = esc_html__(
                 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
                 'event_espresso'
@@ -408,7 +408,7 @@ 
             //attempt to retrieve from repo first
             $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
             if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  //got it!
+                return $message_template_group; //got it!
             }
 
             //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
@@ -513,7 +513,7 @@ 
         );
 
         //if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $global_message_template_group instanceof EE_Message_Template_Group) {
             $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -570,7 +570,7 @@ 
         $context_templates = $message_template_group->context_templates();
         foreach ($context_templates as $context => $template_fields) {
             foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
+                if ( ! $template_obj instanceof EE_Message_Template) {
                     continue;
                 }
                 $templates[$template_field][$context] = $template_obj->get('MTP_content');
@@ -599,7 +599,7 @@ 
     {
 
         //if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
+        if ( ! $templates) {
             $this->_error_msg[] = esc_html__(
                 'Unable to assemble messages because there are no templates retrieved for generating the messages with',
                 'event_espresso'
@@ -703,7 +703,7 @@ 
             $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
             if (isset($templates[$field][$context])) {
                 //prefix field.
-                $column_name = 'MSG_' . $field;
+                $column_name = 'MSG_'.$field;
                 try {
                     $content = $this->_shortcode_parser->parse_message_template(
                         $templates[$field][$context],
@@ -772,13 +772,13 @@ 
      */
     protected function _valid_addressees($addressees)
     {
-        if (! $addressees || ! is_array($addressees)) {
+        if ( ! $addressees || ! is_array($addressees)) {
             return false;
         }
 
         foreach ($addressees as $addressee_array) {
             foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
+                if ( ! $addressee instanceof EE_Messages_Addressee) {
                     return false;
                 }
             }
@@ -820,7 +820,7 @@ 
         /**
          * Check if there is any generation data, but only if this is not for a preview.
          */
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
+        if ( ! $this->_generation_queue->get_message_repository()->get_generation_data()
             && (
                 ! $this->_generation_queue->get_message_repository()->is_preview()
                 && $this->_generation_queue->get_message_repository()->get_data_handler()
@@ -859,7 +859,7 @@ 
         /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually*/
         $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
             ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+            : 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
 
         //If this EE_Message is for a preview, then let's switch out to the preview data handler.
         if ($this->_generation_queue->get_message_repository()->is_preview()) {
@@ -867,7 +867,7 @@ 
         }
 
         //First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
+        if ( ! class_exists($data_handler_class_name)) {
             $this->_error_msg[] = sprintf(
                 esc_html__(
                     'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
@@ -910,7 +910,7 @@ 
                 $generating_data
             )
         );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+        if ( ! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
             //no saved data_handler in the repo so let's set one up and add it to the repo.
             try {
                 $this->_current_data_handler = new $data_handler_class_name($generating_data);
@@ -936,7 +936,7 @@ 
     {
         /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
         $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
         }
         return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());

admin_pages/messages/templates/ee_msg_editor_active_context_element.template.php

Indentation +18 added lines, -18 removed lines

@@ -10,22 +10,22 @@ 
  * @var int    $message_template_group_id The ID for the message template group this context belongs to.
  */
 $active_message = sprintf(
-    esc_html__(
-        'The template for %1$s is currently %2$sactive%3$s.',
-        'event_espresso'
-    ),
-    $context_label,
-    '<strong>',
-    '</strong>'
+	esc_html__(
+		'The template for %1$s is currently %2$sactive%3$s.',
+		'event_espresso'
+	),
+	$context_label,
+	'<strong>',
+	'</strong>'
 );
 $inactive_message = sprintf(
-    esc_html__(
-        'The template for %1$s is currently %2$sinactive%3$s.',
-        'event_espresso'
-    ),
-    $context_label,
-    '<strong>',
-    '</strong>'
+	esc_html__(
+		'The template for %1$s is currently %2$sinactive%3$s.',
+		'event_espresso'
+	),
+	$context_label,
+	'<strong>',
+	'</strong>'
 );
 ?>
 <div class="context-active-control-container">
@@ -34,8 +34,8 @@ 
         <span id="on-off-nonce-<?php echo $context; ?>" class="hidden"><?php echo $nonce; ?></span>
         <span class="ee-on-off-toggle-label">
             <?php
-            echo $is_active ? $active_message : $inactive_message;
-            ?>
+			echo $is_active ? $active_message : $inactive_message;
+			?>
         </span>
         <div class="hidden js-data">
             <span class="ee-active-message"><?php echo $active_message; ?></span>
@@ -43,8 +43,8 @@ 
         </div>
         <div class="switch">
             <?php
-            $checked = $is_active ? ' checked="checked"' : '';
-            ?>
+			$checked = $is_active ? ' checked="checked"' : '';
+			?>
             <input data-grpid="<?php echo $message_template_group_id; ?>" id="ee-on-off-toggle-<?php echo $context; ?>" type="checkbox" class="ee-on-off-toggle ee-toggle-round-flat"<?php echo $checked; ?> value="<?php echo $on_off_action; ?>">
             <label for="ee-on-off-toggle-<?php echo $context; ?>"></label>
         </div>

admin_pages/messages/Messages_Template_List_Table.class.php

Indentation +368 added lines, -368 removed lines

@@ -13,373 +13,373 @@
 {
 
 
-    /**
-     * @return Messages_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    /**
-     * Setup data object
-     */
-    protected function _setup_data()
-    {
-        $this->_data           = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            false
-        );
-        $this->_all_data_count = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            true,
-            true
-        );
-    }
-
-
-    /**
-     * Set internal properties
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('Message Template Group', 'event_espresso'),
-            'plural'   => esc_html__('Message Template', 'event_espresso'),
-            'ajax'     => true, //for now,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
-        $this->_columns      = array(
-            //'cb' => '<input type="checkbox" />', //no deleting default (global) templates!
-            'message_type' => esc_html__('Message Type', 'event_espresso'),
-            'messenger'    => esc_html__('Messenger', 'event_espresso'),
-            'description'  => esc_html__('Description', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'messenger' => array('MTP_messenger' => true),
-        );
-
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * Overriding the single_row method from parent to verify whether the $item has an accessible
-     * message_type or messenger object before generating the row.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function single_row($item)
-    {
-        $message_type = $item->message_type_obj();
-        $messenger    = $item->messenger_obj();
-
-        if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
-            echo '';
-            return;
-        }
-
-        parent::single_row($item);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-
-        //get select inputs
-        $select_inputs = array(
-            $this->_get_messengers_dropdown_filter(),
-            $this->_get_message_types_dropdown_filter(),
-        );
-
-        //set filters to select inputs if they aren't empty
-        foreach ($select_inputs as $select_input) {
-            if ($select_input) {
-                $filters[] = $select_input;
-            }
-        }
-        return $filters;
-    }
-
-    /**
-     * We're just removing the search box for message templates, not needed.
-     *
-     * @param string $text
-     * @param string $input_id
-     * @return string ;
-     */
-    public function search_box($text, $input_id)
-    {
-        return '';
-    }
-
-
-    /**
-     * Add counts to the _views property
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
-                $this->_per_page,
-                $view,
-                true,
-                true
-            );
-        }
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return '';
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_description($item)
-    {
-        return '<p>' . $item->message_type_obj()->description . '</p>';
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_messenger($item)
-    {
-        //Return the name contents
-        return sprintf(
-            '%1$s <span style="color:silver">(id:%2$s)</span><br />%3$s%4$s',
-            /* $1%s */
-            $this->_get_name_link_for_messenger($item),
-            /* $2%s */
-            $item->GRP_ID(),
-            /* %4$s */
-            $this->_get_context_links($item),
-            /* $3%s */
-            $this->row_actions($this->_get_actions_for_messenger_column($item))
-        );
-    }
-
-    /**
-     * column_message_type
-     *
-     * @param  EE_Message_Template_Group $item message info for the row
-     * @return string message_type name
-     * @throws EE_Error
-     */
-    public function column_message_type($item)
-    {
-        return ucwords($item->message_type_obj()->label['singular']);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for messengers
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_messengers_dropdown_filter($global = true)
-    {
-        $messenger_options                                   = array();
-        $active_message_template_groups_grouped_by_messenger = EEM_Message_Template_Group::instance()->get_all(
-            array(
-                array(
-                    'MTP_is_active' => true,
-                    'MTP_is_global' => $global,
-                ),
-                'group_by' => 'MTP_messenger',
-            )
-        );
-
-        foreach ($active_message_template_groups_grouped_by_messenger as $active_message_template_group) {
-            if ($active_message_template_group instanceof EE_Message_Template_Group) {
-                $messenger                          = $active_message_template_group->messenger_obj();
-                $messenger_label                    = $messenger instanceof EE_messenger
-                    ? $messenger->label['singular']
-                    : $active_message_template_group->messenger();
-                $messenger_options[$active_message_template_group->messenger()] = ucwords($messenger_label);
-            }
-        }
-        return $this->get_admin_page()->get_messengers_select_input($messenger_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_message_types_dropdown_filter($global = true)
-    {
-        $message_type_options                                   = array();
-        $active_message_template_groups_grouped_by_message_type = EEM_Message_Template_Group::instance()->get_all(
-            array(
-                array(
-                    'MTP_is_active' => true,
-                    'MTP_is_global' => true,
-                ),
-                'group_by' => 'MTP_message_type',
-            )
-        );
-
-        foreach ($active_message_template_groups_grouped_by_message_type as $active_message_template_group) {
-            if ($active_message_template_group instanceof EE_Message_Template_Group) {
-                $message_type               = $active_message_template_group->message_type_obj();
-                $message_type_label         = $message_type instanceof EE_message_type
-                    ? $message_type->label['singular']
-                    : $active_message_template_group->message_type();
-                $message_type_options[$active_message_template_group->message_type()] = ucwords($message_type_label);
-            }
-        }
-        return $this->get_admin_page()->get_message_types_select_input($message_type_options);
-    }
-
-
-    /**
-     * Return the edit url for the message template group.
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_edit_url(EE_Message_Template_Group $item)
-    {
-        $edit_url = '';
-        // edit link but only if item isn't trashed.
-        if (! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_message',
-                'espresso_messages_edit_message_template',
-                $item->ID()
-            )) {
-            $edit_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'edit_message_template',
-                    'id'     => $item->GRP_ID(),
-                ),
-                EE_MSG_ADMIN_URL
-            );
-        }
-        return $edit_url;
-    }
-
-
-    /**
-     * Get the context link string for the messenger column.
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_context_links(EE_Message_Template_Group $item)
-    {
-        //first check if we even show the context links or not.
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_message',
-            'espresso_messages_edit_message_template',
-            $item->ID()
-        )
-            || $item->get('MTP_deleted')
-        ) {
-            return '';
-        }
-        //we want to display the contexts in here so we need to set them up
-        $c_label           = $item->context_label();
-        $c_configs         = $item->contexts_config();
-        $ctxt              = array();
-        $context_templates = $item->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            $mtp_to        = ! empty($context_templates[$context]['to'])
-                             && $context_templates[$context]['to'] instanceof EE_Message_Template
-                ? $context_templates[$context]['to']->get('MTP_content')
-                : null;
-            $inactive_class      = (
-                empty($mtp_to)
-                && ! empty($context_templates[$context]['to'])
-            )
-            || ! $item->is_context_active($context)
-                ? ' mtp-inactive'
-                : '';
-            $context_title = ucwords($c_configs[$context]['label']);
-            $edit_link     = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action'  => 'edit_message_template',
-                'id'      => $item->GRP_ID(),
-                'context' => $context,
-            ), EE_MSG_ADMIN_URL);
-            $ctxt[]        =  '<a'
-                  . ' href="' . $edit_link . '"'
-                  . ' class="' . $item->message_type() . '-' . $context . '-edit-link' .$inactive_class . '"'
-                  . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
-                  . $context_title
-                  . '</a>';
-        }
-
-        return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])) . implode(' | ', $ctxt);
-    }
-
-
-    /**
-     * Get the Name string from the messenger column (linked to edit if the context allows for that).
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_name_link_for_messenger(EE_Message_Template_Group $item)
-    {
-        $edit_url = $this->_get_edit_url($item);
-        return $edit_url
-            ? '<a href="' . $edit_url . '"'
-              . ' title="' . esc_attr__('Edit Template Group', 'event_espresso') . '">'
-              . ucwords($item->messenger_obj()->label['singular'])
-              . '</a>'
-            : ucwords($item->messenger_obj()->label['singular']);
-    }
-
-
-    /**
-     * Return the actions array for the messenger column.
-     * @param EE_Message_Template_Group $item
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
-    {
-        $actions = array();
-        if ($edit_url = $this->_get_edit_url($item)) {
-            $actions = array(
-                'edit' => '<a href="' . $edit_url . '"'
-                          . ' class="' . $item->message_type() . '-edit-link"'
-                          . ' title="' . esc_attr__('Edit Template Group', 'event_espresso') . '">'
-                          . esc_html__('Edit', 'event_espresso')
-                          . '</a>'
-            );
-        }
-        return $actions;
-    }
+	/**
+	 * @return Messages_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	/**
+	 * Setup data object
+	 */
+	protected function _setup_data()
+	{
+		$this->_data           = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			false
+		);
+		$this->_all_data_count = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			true,
+			true
+		);
+	}
+
+
+	/**
+	 * Set internal properties
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('Message Template Group', 'event_espresso'),
+			'plural'   => esc_html__('Message Template', 'event_espresso'),
+			'ajax'     => true, //for now,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
+		$this->_columns      = array(
+			//'cb' => '<input type="checkbox" />', //no deleting default (global) templates!
+			'message_type' => esc_html__('Message Type', 'event_espresso'),
+			'messenger'    => esc_html__('Messenger', 'event_espresso'),
+			'description'  => esc_html__('Description', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'messenger' => array('MTP_messenger' => true),
+		);
+
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * Overriding the single_row method from parent to verify whether the $item has an accessible
+	 * message_type or messenger object before generating the row.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function single_row($item)
+	{
+		$message_type = $item->message_type_obj();
+		$messenger    = $item->messenger_obj();
+
+		if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
+			echo '';
+			return;
+		}
+
+		parent::single_row($item);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+
+		//get select inputs
+		$select_inputs = array(
+			$this->_get_messengers_dropdown_filter(),
+			$this->_get_message_types_dropdown_filter(),
+		);
+
+		//set filters to select inputs if they aren't empty
+		foreach ($select_inputs as $select_input) {
+			if ($select_input) {
+				$filters[] = $select_input;
+			}
+		}
+		return $filters;
+	}
+
+	/**
+	 * We're just removing the search box for message templates, not needed.
+	 *
+	 * @param string $text
+	 * @param string $input_id
+	 * @return string ;
+	 */
+	public function search_box($text, $input_id)
+	{
+		return '';
+	}
+
+
+	/**
+	 * Add counts to the _views property
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
+				$this->_per_page,
+				$view,
+				true,
+				true
+			);
+		}
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return '';
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_description($item)
+	{
+		return '<p>' . $item->message_type_obj()->description . '</p>';
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_messenger($item)
+	{
+		//Return the name contents
+		return sprintf(
+			'%1$s <span style="color:silver">(id:%2$s)</span><br />%3$s%4$s',
+			/* $1%s */
+			$this->_get_name_link_for_messenger($item),
+			/* $2%s */
+			$item->GRP_ID(),
+			/* %4$s */
+			$this->_get_context_links($item),
+			/* $3%s */
+			$this->row_actions($this->_get_actions_for_messenger_column($item))
+		);
+	}
+
+	/**
+	 * column_message_type
+	 *
+	 * @param  EE_Message_Template_Group $item message info for the row
+	 * @return string message_type name
+	 * @throws EE_Error
+	 */
+	public function column_message_type($item)
+	{
+		return ucwords($item->message_type_obj()->label['singular']);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for messengers
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_messengers_dropdown_filter($global = true)
+	{
+		$messenger_options                                   = array();
+		$active_message_template_groups_grouped_by_messenger = EEM_Message_Template_Group::instance()->get_all(
+			array(
+				array(
+					'MTP_is_active' => true,
+					'MTP_is_global' => $global,
+				),
+				'group_by' => 'MTP_messenger',
+			)
+		);
+
+		foreach ($active_message_template_groups_grouped_by_messenger as $active_message_template_group) {
+			if ($active_message_template_group instanceof EE_Message_Template_Group) {
+				$messenger                          = $active_message_template_group->messenger_obj();
+				$messenger_label                    = $messenger instanceof EE_messenger
+					? $messenger->label['singular']
+					: $active_message_template_group->messenger();
+				$messenger_options[$active_message_template_group->messenger()] = ucwords($messenger_label);
+			}
+		}
+		return $this->get_admin_page()->get_messengers_select_input($messenger_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_message_types_dropdown_filter($global = true)
+	{
+		$message_type_options                                   = array();
+		$active_message_template_groups_grouped_by_message_type = EEM_Message_Template_Group::instance()->get_all(
+			array(
+				array(
+					'MTP_is_active' => true,
+					'MTP_is_global' => true,
+				),
+				'group_by' => 'MTP_message_type',
+			)
+		);
+
+		foreach ($active_message_template_groups_grouped_by_message_type as $active_message_template_group) {
+			if ($active_message_template_group instanceof EE_Message_Template_Group) {
+				$message_type               = $active_message_template_group->message_type_obj();
+				$message_type_label         = $message_type instanceof EE_message_type
+					? $message_type->label['singular']
+					: $active_message_template_group->message_type();
+				$message_type_options[$active_message_template_group->message_type()] = ucwords($message_type_label);
+			}
+		}
+		return $this->get_admin_page()->get_message_types_select_input($message_type_options);
+	}
+
+
+	/**
+	 * Return the edit url for the message template group.
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_edit_url(EE_Message_Template_Group $item)
+	{
+		$edit_url = '';
+		// edit link but only if item isn't trashed.
+		if (! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_message',
+				'espresso_messages_edit_message_template',
+				$item->ID()
+			)) {
+			$edit_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'edit_message_template',
+					'id'     => $item->GRP_ID(),
+				),
+				EE_MSG_ADMIN_URL
+			);
+		}
+		return $edit_url;
+	}
+
+
+	/**
+	 * Get the context link string for the messenger column.
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_context_links(EE_Message_Template_Group $item)
+	{
+		//first check if we even show the context links or not.
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_message',
+			'espresso_messages_edit_message_template',
+			$item->ID()
+		)
+			|| $item->get('MTP_deleted')
+		) {
+			return '';
+		}
+		//we want to display the contexts in here so we need to set them up
+		$c_label           = $item->context_label();
+		$c_configs         = $item->contexts_config();
+		$ctxt              = array();
+		$context_templates = $item->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			$mtp_to        = ! empty($context_templates[$context]['to'])
+							 && $context_templates[$context]['to'] instanceof EE_Message_Template
+				? $context_templates[$context]['to']->get('MTP_content')
+				: null;
+			$inactive_class      = (
+				empty($mtp_to)
+				&& ! empty($context_templates[$context]['to'])
+			)
+			|| ! $item->is_context_active($context)
+				? ' mtp-inactive'
+				: '';
+			$context_title = ucwords($c_configs[$context]['label']);
+			$edit_link     = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action'  => 'edit_message_template',
+				'id'      => $item->GRP_ID(),
+				'context' => $context,
+			), EE_MSG_ADMIN_URL);
+			$ctxt[]        =  '<a'
+				  . ' href="' . $edit_link . '"'
+				  . ' class="' . $item->message_type() . '-' . $context . '-edit-link' .$inactive_class . '"'
+				  . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
+				  . $context_title
+				  . '</a>';
+		}
+
+		return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])) . implode(' | ', $ctxt);
+	}
+
+
+	/**
+	 * Get the Name string from the messenger column (linked to edit if the context allows for that).
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_name_link_for_messenger(EE_Message_Template_Group $item)
+	{
+		$edit_url = $this->_get_edit_url($item);
+		return $edit_url
+			? '<a href="' . $edit_url . '"'
+			  . ' title="' . esc_attr__('Edit Template Group', 'event_espresso') . '">'
+			  . ucwords($item->messenger_obj()->label['singular'])
+			  . '</a>'
+			: ucwords($item->messenger_obj()->label['singular']);
+	}
+
+
+	/**
+	 * Return the actions array for the messenger column.
+	 * @param EE_Message_Template_Group $item
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
+	{
+		$actions = array();
+		if ($edit_url = $this->_get_edit_url($item)) {
+			$actions = array(
+				'edit' => '<a href="' . $edit_url . '"'
+						  . ' class="' . $item->message_type() . '-edit-link"'
+						  . ' title="' . esc_attr__('Edit Template Group', 'event_espresso') . '">'
+						  . esc_html__('Edit', 'event_espresso')
+						  . '</a>'
+			);
+		}
+		return $actions;
+	}
 }
 

Spacing +17 added lines, -17 removed lines

@@ -27,7 +27,7 @@ 
      */
     protected function _setup_data()
     {
-        $this->_data           = $this->get_admin_page()->get_message_templates(
+        $this->_data = $this->get_admin_page()->get_message_templates(
             $this->_per_page,
             $this->_view,
             false
@@ -52,7 +52,7 @@ 
             'ajax'     => true, //for now,
             'screen'   => $this->get_admin_page()->get_current_screen()->id,
         );
-        $this->_columns      = array(
+        $this->_columns = array(
             //'cb' => '<input type="checkbox" />', //no deleting default (global) templates!
             'message_type' => esc_html__('Message Type', 'event_espresso'),
             'messenger'    => esc_html__('Messenger', 'event_espresso'),
@@ -80,7 +80,7 @@ 
         $message_type = $item->message_type_obj();
         $messenger    = $item->messenger_obj();
 
-        if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
+        if ( ! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
             echo '';
             return;
         }
@@ -158,7 +158,7 @@ 
      */
     public function column_description($item)
     {
-        return '<p>' . $item->message_type_obj()->description . '</p>';
+        return '<p>'.$item->message_type_obj()->description.'</p>';
     }
 
 
@@ -272,7 +272,7 @@ 
     {
         $edit_url = '';
         // edit link but only if item isn't trashed.
-        if (! $item->get('MTP_deleted')
+        if ( ! $item->get('MTP_deleted')
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_edit_message',
                 'espresso_messages_edit_message_template',
@@ -299,7 +299,7 @@ 
     protected function _get_context_links(EE_Message_Template_Group $item)
     {
         //first check if we even show the context links or not.
-        if (! EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_message',
             'espresso_messages_edit_message_template',
             $item->ID()
@@ -318,7 +318,7 @@ 
                              && $context_templates[$context]['to'] instanceof EE_Message_Template
                 ? $context_templates[$context]['to']->get('MTP_content')
                 : null;
-            $inactive_class      = (
+            $inactive_class = (
                 empty($mtp_to)
                 && ! empty($context_templates[$context]['to'])
             )
@@ -331,15 +331,15 @@ 
                 'id'      => $item->GRP_ID(),
                 'context' => $context,
             ), EE_MSG_ADMIN_URL);
-            $ctxt[]        =  '<a'
-                  . ' href="' . $edit_link . '"'
-                  . ' class="' . $item->message_type() . '-' . $context . '-edit-link' .$inactive_class . '"'
-                  . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
+            $ctxt[] = '<a'
+                  . ' href="'.$edit_link.'"'
+                  . ' class="'.$item->message_type().'-'.$context.'-edit-link'.$inactive_class.'"'
+                  . ' title="'.esc_attr__('Edit Context', 'event_espresso').'">'
                   . $context_title
                   . '</a>';
         }
 
-        return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])) . implode(' | ', $ctxt);
+        return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])).implode(' | ', $ctxt);
     }
 
 
@@ -353,8 +353,8 @@ 
     {
         $edit_url = $this->_get_edit_url($item);
         return $edit_url
-            ? '<a href="' . $edit_url . '"'
-              . ' title="' . esc_attr__('Edit Template Group', 'event_espresso') . '">'
+            ? '<a href="'.$edit_url.'"'
+              . ' title="'.esc_attr__('Edit Template Group', 'event_espresso').'">'
               . ucwords($item->messenger_obj()->label['singular'])
               . '</a>'
             : ucwords($item->messenger_obj()->label['singular']);
@@ -372,9 +372,9 @@ 
         $actions = array();
         if ($edit_url = $this->_get_edit_url($item)) {
             $actions = array(
-                'edit' => '<a href="' . $edit_url . '"'
-                          . ' class="' . $item->message_type() . '-edit-link"'
-                          . ' title="' . esc_attr__('Edit Template Group', 'event_espresso') . '">'
+                'edit' => '<a href="'.$edit_url.'"'
+                          . ' class="'.$item->message_type().'-edit-link"'
+                          . ' title="'.esc_attr__('Edit Template Group', 'event_espresso').'">'
                           . esc_html__('Edit', 'event_espresso')
                           . '</a>'
             );

acceptance_tests/Page/MessagesAdmin.php

Indentation +272 added lines, -272 removed lines

@@ -14,286 +14,286 @@
 class MessagesAdmin extends CoreAdmin
 {
 
-    /**
-     * Context slug for the admin messages context.
-     * @var string
-     */
-    const ADMIN_CONTEXT_SLUG = 'admin';
+	/**
+	 * Context slug for the admin messages context.
+	 * @var string
+	 */
+	const ADMIN_CONTEXT_SLUG = 'admin';
 
-    /**
-     * Context slug for the primary attendee messages context
-     * @var string
-     */
-    const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
+	/**
+	 * Context slug for the primary attendee messages context
+	 * @var string
+	 */
+	const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
 
 
-    /**
-     * Status reference for the EEM_Message::status_sent status.
-     * @var string
-     */
-    const MESSAGE_STATUS_SENT = 'MSN';
+	/**
+	 * Status reference for the EEM_Message::status_sent status.
+	 * @var string
+	 */
+	const MESSAGE_STATUS_SENT = 'MSN';
 
 
-    /**
-     * Message type slug for the Payment Failed message type
-     */
-    const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
+	/**
+	 * Message type slug for the Payment Failed message type
+	 */
+	const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
 
 
-    /**
-     * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
-     * @var string
-     */
-    const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
-        '#global_messages_settings-do-messages-on-same-request';
+	/**
+	 * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
+	 * @var string
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
+		'#global_messages_settings-do-messages-on-same-request';
 
 
-    /**
-     * Selector for the Global Messages Settings submit button in the Messages Settings tab.
-     * @var string
-     */
-    const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
-
+	/**
+	 * Selector for the Global Messages Settings submit button in the Messages Settings tab.
+	 * @var string
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
+
 
-    /**
-     * This is the container where active message types for a messenger are found/dragged to.
-     * @var string
-     */
-    const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
-
-
-    /**
-     * Locator for the context switcher selector on the Message Template Editor page.
-     * @var string
-     */
-    const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
-
-
-    /**
-     * Locator for the context switcher submit button in the Message Template Editor page.
-     * @var string
-     */
-    const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
-
-
-    /**
-     * Locator for the dialog container used for housing viewed messages in the message activity list table.
-     * @var string
-     */
-    const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
-
-
-    /**
-     * Returns the selector for the on/off toggle for context on the message template editor.
-     */
-    const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
-        "//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
-
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function messageActivityListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'default', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function defaultMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function customMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function messageSettingsUrl()
-    {
-        return self::adminUrl('espresso_messages', 'settings');
-    }
-
-
-
-    public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
-        $message_type_slug,
-        $messenger_slug = 'email'
-    ) {
-        return "#$message_type_slug-messagetype-$messenger_slug";
-    }
-
-
-    /**
-     * @param string $message_type_slug
-     * @param string $context
-     * @return string
-     */
-    public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
-    {
-        return $context
-            ? '.' . $message_type_slug . '-' . $context . '-edit-link'
-            : '.' . $message_type_slug . '-edit-link';
-    }
-
-
-    /**
-     * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
-     *
-     * @param        $field
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param string $table_cell_content_for_field
-     * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
-     *                                This allows you to indicate which item from the set to match.  If this is set to 0
-     *                                then all matches for the locator will be returned.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableCellSelectorFor(
-        $field,
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $table_cell_content_for_field = '',
-        $number_in_set = 1
-    ) {
-        $selector = "//tbody[@id='the-list']";
-        $selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
-                     . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
-        if ($messenger) {
-            $selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
-        }
-        $selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
-        $selector .= $table_cell_content_for_field
-            ? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
-            : "/ancestor::tr/td[contains(@class, 'column-$field')]";
-        return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
-    }
-
-
-    /**
-     * Selector for the Create Custom button found in the message template list table.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     * @return string
-     */
-    public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
-    {
-        $selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
-                    . "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
-                    . "//ancestor::tr/td/a[@class='button button-small']";
-        return $selector;
-    }
-
-
-    /**
-     * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
-     * the FIRST match (which will be the latest message sent if the table is default sorted).
-     *
-     * @param string $message_type_label    The visible message type label for the row you want to match
-     * @param string $message_status        The status of the message for the row you want to match.
-     * @param string $messenger             The visible messenger label for the row you want to match.
-     * @param string $context               The visible context label for the row you want to match.
-     * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
-     *                                      view. This allows you to indicate which item from the set to match.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableViewButtonSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'action',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
-                     . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
-        return $selector;
-    }
-
-
-    /**
-     * Locator for the delete action link for a message item in the message activity list table.
-     * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
-     *
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableDeleteActionSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/div/span[@class='delete']/a";
-        return $selector;
-    }
-
-
-
-    /**
-     * Returns the input selector for a given field in the message template editor.
-     * Assumes one is already viewing the Message Template Editor.
-     * @param string     $field
-     * @return string
-     */
-    public static function messageInputFieldSelectorFor($field)
-    {
-        return "//div[@id='post-body']//input[@id='$field-content']";
-    }
-
-
-    /**
-     * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
-     */
-    public static function messageTemplateToFieldSelector()
-    {
-        return self::messageInputFieldSelectorFor('to');
-    }
+	/**
+	 * This is the container where active message types for a messenger are found/dragged to.
+	 * @var string
+	 */
+	const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
+
+
+	/**
+	 * Locator for the context switcher selector on the Message Template Editor page.
+	 * @var string
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
+
+
+	/**
+	 * Locator for the context switcher submit button in the Message Template Editor page.
+	 * @var string
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
+
+
+	/**
+	 * Locator for the dialog container used for housing viewed messages in the message activity list table.
+	 * @var string
+	 */
+	const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
+
+
+	/**
+	 * Returns the selector for the on/off toggle for context on the message template editor.
+	 */
+	const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
+		"//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
+
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function messageActivityListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'default', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function defaultMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function customMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function messageSettingsUrl()
+	{
+		return self::adminUrl('espresso_messages', 'settings');
+	}
+
+
+
+	public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
+		$message_type_slug,
+		$messenger_slug = 'email'
+	) {
+		return "#$message_type_slug-messagetype-$messenger_slug";
+	}
+
+
+	/**
+	 * @param string $message_type_slug
+	 * @param string $context
+	 * @return string
+	 */
+	public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
+	{
+		return $context
+			? '.' . $message_type_slug . '-' . $context . '-edit-link'
+			: '.' . $message_type_slug . '-edit-link';
+	}
+
+
+	/**
+	 * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
+	 *
+	 * @param        $field
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param string $table_cell_content_for_field
+	 * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
+	 *                                This allows you to indicate which item from the set to match.  If this is set to 0
+	 *                                then all matches for the locator will be returned.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableCellSelectorFor(
+		$field,
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$table_cell_content_for_field = '',
+		$number_in_set = 1
+	) {
+		$selector = "//tbody[@id='the-list']";
+		$selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
+					 . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
+		if ($messenger) {
+			$selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
+		}
+		$selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
+		$selector .= $table_cell_content_for_field
+			? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
+			: "/ancestor::tr/td[contains(@class, 'column-$field')]";
+		return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
+	}
+
+
+	/**
+	 * Selector for the Create Custom button found in the message template list table.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 * @return string
+	 */
+	public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
+	{
+		$selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
+					. "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
+					. "//ancestor::tr/td/a[@class='button button-small']";
+		return $selector;
+	}
+
+
+	/**
+	 * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
+	 * the FIRST match (which will be the latest message sent if the table is default sorted).
+	 *
+	 * @param string $message_type_label    The visible message type label for the row you want to match
+	 * @param string $message_status        The status of the message for the row you want to match.
+	 * @param string $messenger             The visible messenger label for the row you want to match.
+	 * @param string $context               The visible context label for the row you want to match.
+	 * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
+	 *                                      view. This allows you to indicate which item from the set to match.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableViewButtonSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'action',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
+					 . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
+		return $selector;
+	}
+
+
+	/**
+	 * Locator for the delete action link for a message item in the message activity list table.
+	 * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
+	 *
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableDeleteActionSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/div/span[@class='delete']/a";
+		return $selector;
+	}
+
+
+
+	/**
+	 * Returns the input selector for a given field in the message template editor.
+	 * Assumes one is already viewing the Message Template Editor.
+	 * @param string     $field
+	 * @return string
+	 */
+	public static function messageInputFieldSelectorFor($field)
+	{
+		return "//div[@id='post-body']//input[@id='$field-content']";
+	}
+
+
+	/**
+	 * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
+	 */
+	public static function messageTemplateToFieldSelector()
+	{
+		return self::messageInputFieldSelectorFor('to');
+	}
 }
\ No newline at end of file

acceptance_tests/Helpers/MessagesAdmin.php

Indentation +243 added lines, -243 removed lines

@@ -10,276 +10,276 @@
  */
 trait MessagesAdmin
 {
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnMessagesActivityListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnMessagesActivityListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
+	}
 
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
+	}
 
 
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnCustomMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
+	}
 
 
-    /**
-     * Directs to message settings page
-     */
-    public function amOnMessageSettingsPage()
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
-    }
+	/**
+	 * Directs to message settings page
+	 */
+	public function amOnMessageSettingsPage()
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
+	}
 
 
-    public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
-    {
-        $this->actor()->dragAndDrop(
-            MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
-            MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
-        );
-    }
+	public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
+	{
+		$this->actor()->dragAndDrop(
+			MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
+			MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
+		);
+	}
 
 
-    /**
-     * Assumes you are already on the list table page that has the ui for editing the template.
-     * @param string $message_type_slug
-     * @param string $context [optional] if you want to click directly to the given context in the editor
-     */
-    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
-    {
-        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
-    }
+	/**
+	 * Assumes you are already on the list table page that has the ui for editing the template.
+	 * @param string $message_type_slug
+	 * @param string $context [optional] if you want to click directly to the given context in the editor
+	 */
+	public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
+	{
+		$this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
+	}
 
 
-    /**
-     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
-     * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
-     *
-     * @param int    $expected_occurence_count
-     * @param string $text_to_check_for
-     * @param string $field
-     * @param string $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     */
-    public function verifyMatchingCountofTextInMessageActivityListTableFor(
-        $expected_occurence_count,
-        $text_to_check_for,
-        $field,
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin'
-    ) {
-        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
-            $field,
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $text_to_check_for,
-            0
-        ));
-        $actual_count = count($elements);
-        $this->actor()->assertEquals(
-            $expected_occurence_count,
-            $actual_count,
-            sprintf(
-                'Expected %s of the %s text for the %s field but there were actually %s counted.',
-                $expected_occurence_count,
-                $text_to_check_for,
-                $field,
-                $actual_count
-            )
-        );
-    }
+	/**
+	 * Use this action to verify that the count for the given text in the specified field is as expected.  For example
+	 * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
+	 *
+	 * @param int    $expected_occurence_count
+	 * @param string $text_to_check_for
+	 * @param string $field
+	 * @param string $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 */
+	public function verifyMatchingCountofTextInMessageActivityListTableFor(
+		$expected_occurence_count,
+		$text_to_check_for,
+		$field,
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin'
+	) {
+		$elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
+			$field,
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$text_to_check_for,
+			0
+		));
+		$actual_count = count($elements);
+		$this->actor()->assertEquals(
+			$expected_occurence_count,
+			$actual_count,
+			sprintf(
+				'Expected %s of the %s text for the %s field but there were actually %s counted.',
+				$expected_occurence_count,
+				$text_to_check_for,
+				$field,
+				$actual_count
+			)
+		);
+	}
 
 
-    /**
-     * This will create a custom message template for the given messenger and message type from the context of the
-     * default (global) message template list table.
-     * Also takes care of verifying the template was created.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     */
-    public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
-    {
-        $this->amOnDefaultMessageTemplateListTablePage();
-        $this->actor()->click(
-            MessagesPage::createCustomButtonForMessageTypeAndMessenger(
-                $message_type_label,
-                $messenger_label
-            )
-        );
-        $this->actor()->seeInField('#title', 'New Custom Template');
-    }
+	/**
+	 * This will create a custom message template for the given messenger and message type from the context of the
+	 * default (global) message template list table.
+	 * Also takes care of verifying the template was created.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 */
+	public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
+	{
+		$this->amOnDefaultMessageTemplateListTablePage();
+		$this->actor()->click(
+			MessagesPage::createCustomButtonForMessageTypeAndMessenger(
+				$message_type_label,
+				$messenger_label
+			)
+		);
+		$this->actor()->seeInField('#title', 'New Custom Template');
+	}
 
 
-    /**
-     * This switches the context of the current messages template to the given reference.
-     * @param string $context_reference  This should be the visible label for the option.
-     */
-    public function switchContextTo($context_reference)
-    {
-        $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
-        $this->actor()->waitForText($context_reference, 10, 'h1');
-    }
+	/**
+	 * This switches the context of the current messages template to the given reference.
+	 * @param string $context_reference  This should be the visible label for the option.
+	 */
+	public function switchContextTo($context_reference)
+	{
+		$this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
+		$this->actor()->waitForText($context_reference, 10, 'h1');
+	}
 
 
-    /**
-     * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
-     * toggling.
-     *
-     * @param string $context_string           What context is being switched (used for the expected state text)
-     * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
-     *                                         (false)
-     */
-    public function toggleContextState($context_string, $expected_state_is_active = true)
-    {
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
-        if ($expected_state_is_active) {
-            $this->actor()->waitForText("The template for $context_string is currently active.");
-        } else {
-            $this->actor()->waitForText("The template for $context_string is currently inactive");
-        }
-    }
+	/**
+	 * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
+	 * toggling.
+	 *
+	 * @param string $context_string           What context is being switched (used for the expected state text)
+	 * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
+	 *                                         (false)
+	 */
+	public function toggleContextState($context_string, $expected_state_is_active = true)
+	{
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
+		if ($expected_state_is_active) {
+			$this->actor()->waitForText("The template for $context_string is currently active.");
+		} else {
+			$this->actor()->waitForText("The template for $context_string is currently inactive");
+		}
+	}
 
 
-    /**
-     * Triggers saving the message template.
-     * @param bool $and_close   Use to indicate to click the Save and Close button.
-     */
-    public function saveMessageTemplate($and_close = false)
-    {
-        if ($and_close) {
-            $this->actor()->click('Save and Close');
-        } else {
-            $this->actor()->click('Save');
-        }
-        $this->actor()->waitForText('successfully updated');
-    }
+	/**
+	 * Triggers saving the message template.
+	 * @param bool $and_close   Use to indicate to click the Save and Close button.
+	 */
+	public function saveMessageTemplate($and_close = false)
+	{
+		if ($and_close) {
+			$this->actor()->click('Save and Close');
+		} else {
+			$this->actor()->click('Save');
+		}
+		$this->actor()->waitForText('successfully updated');
+	}
 
 
-    /**
-     * This takes care of clicking the View Message icon for the given parameters.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function viewMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        ));
-    }
+	/**
+	 * This takes care of clicking the View Message icon for the given parameters.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function viewMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		));
+	}
 
 
-    /**
-     * Takes care of deleting a message matching the given parameters via the message activity list table.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function deleteMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        );
-        $this->actor()->moveMouseOver(
-            MessagesPage::messagesActivityListTableCellSelectorFor(
-                'to',
-                $message_type_label,
-                $message_status,
-                $messenger,
-                $context,
-                '',
-                $number_in_set
-            ),
-            5,
-            5
-        );
-        $this->actor()->waitForElementVisible(
-            $delete_action_selector
-        );
-        $this->actor()->click(
-            $delete_action_selector
-        );
-        $this->actor()->waitForText('successfully deleted');
-    }
+	/**
+	 * Takes care of deleting a message matching the given parameters via the message activity list table.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function deleteMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		);
+		$this->actor()->moveMouseOver(
+			MessagesPage::messagesActivityListTableCellSelectorFor(
+				'to',
+				$message_type_label,
+				$message_status,
+				$messenger,
+				$context,
+				'',
+				$number_in_set
+			),
+			5,
+			5
+		);
+		$this->actor()->waitForElementVisible(
+			$delete_action_selector
+		);
+		$this->actor()->click(
+			$delete_action_selector
+		);
+		$this->actor()->waitForText('successfully deleted');
+	}
 
 
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is in that window.
-     * @param string $text_to_view
-     */
-    public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
-    {
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
-        $this->actor()->switchToIframe();
-    }
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is in that window.
+	 * @param string $text_to_view
+	 */
+	public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
+	{
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
+		$this->actor()->switchToIframe();
+	}
 
 
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is NOT that window.
-     * @param string $text_to_view
-     */
-    public function dontSeeTextInViewMessageModal($text_to_view)
-    {
-        $this->seeTextInViewMessageModal($text_to_view, true);
-    }
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is NOT that window.
+	 * @param string $text_to_view
+	 */
+	public function dontSeeTextInViewMessageModal($text_to_view)
+	{
+		$this->seeTextInViewMessageModal($text_to_view, true);
+	}
 
 
-    public function dismissMessageModal()
-    {
-        $this->actor()->click('#espresso-admin-page-overlay-dv');
-        //this is needed otherwise phantom js gets stuck in the wrong context and any future element events will fail.
-        $this->actor()->click('form#EE_Message_List_Table-table-frm');
-    }
+	public function dismissMessageModal()
+	{
+		$this->actor()->click('#espresso-admin-page-overlay-dv');
+		//this is needed otherwise phantom js gets stuck in the wrong context and any future element events will fail.
+		$this->actor()->click('form#EE_Message_List_Table-table-frm');
+	}
 }

acceptance_tests/tests/e-TestContextActivationToggleCept.php

Indentation +62 added lines, -62 removed lines

@@ -8,8 +8,8 @@ 
 $event_label = 'Testing Context Deactivation';
 
 $I->wantTo(
-    'Test that the context activation toggle for turning on or off specific contexts for message sending works as'
-    . ' expected'
+	'Test that the context activation toggle for turning on or off specific contexts for message sending works as'
+	. ' expected'
 );
 
 $I->loginAsAdmin();
@@ -34,7 +34,7 @@ 
 $I->see('The template for Primary Registrant Recipient is currently inactive.');
 
 $I->amGoingTo(
-    'Trigger Registration Approved Messages and verify primary registrant context is excluded from sent messages.'
+	'Trigger Registration Approved Messages and verify primary registrant context is excluded from sent messages.'
 );
 $I->amOnDefaultEventsListTablePage();
 $I->click(EventsAdmin::ADD_NEW_EVENT_BUTTON_SELECTOR);
@@ -44,9 +44,9 @@ 
 $event_link = $I->observeLinkUrlAt(EventsAdmin::EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR);
 $event_id = $I->observeValueFromInputAt(EventsAdmin::EVENT_EDITOR_EVT_ID_SELECTOR);
 $test_registration_details = array(
-    'fname' => 'ContextTestGuy',
-    'lname' => 'ContextTestDude',
-    'email' => 'contexttestguy@example.org',
+	'fname' => 'ContextTestGuy',
+	'lname' => 'ContextTestDude',
+	'email' => 'contexttestguy@example.org',
 );
 $I->logOut();
 $I->amOnUrl($event_link);
@@ -63,48 +63,48 @@ 
 $I->amOnMessagesActivityListTablePage();
 //verify registrant context
 $I->see(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Registrant'
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 //verify admin context
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 //verify primary registrant context is NOT present.
 $I->dontSee(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 
 $I->amGoingTo(
-    'Deactivate primary registrant context for Registration Approved Message Templates and restore the "To"'
-    . ' field to an empty string to verify the message does not send for that context.'
+	'Deactivate primary registrant context for Registration Approved Message Templates and restore the "To"'
+	. ' field to an empty string to verify the message does not send for that context.'
 );
 $I->amOnDefaultMessageTemplateListTablePage();
 $I->clickToEditMessageTemplateByMessageType('registration', 'primary_attendee');
@@ -128,41 +128,41 @@ 
 $I->amOnMessagesActivityListTablePage();
 //verify registrant context
 $I->see(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Registrant'
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 //verify admin context
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 //verify primary registrant context is NOT present.
 $I->dontSee(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
\ No newline at end of file