eventespresso / event-espresso-core

core/data_migration_scripts/EE_DMS_Core_4_8_0.dms.php

Indentation +357 added lines, -357 removed lines

@@ -17,9 +17,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_8_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_8_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = array();
+	preg_match('~4_8_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[ $matches[1] ] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_8_0__autoloaded_stages', $class_to_filepath);
@@ -38,71 +38,71 @@ 
 class EE_DMS_Core_4_8_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_8_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.8.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_8_0_pretax_totals(),
-            new EE_DMS_4_8_0_event_subtotals(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 * return EE_DMS_Core_4_8_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.8.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_8_0_pretax_totals(),
+			new EE_DMS_4_8_0_event_subtotals(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
 
 
 
-    /**
-     * Because this is being done at basically the same time as the MER-ready branch
-     * of core, it's possible people might have installed MEr-ready branch first,
-     * and then this one, in which case we still want to perform this migration,
-     * even though the version might not have increased
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.8.0', '<=') && version_compare($version_string, '4.7.0', '>=')) {
+	/**
+	 * Because this is being done at basically the same time as the MER-ready branch
+	 * of core, it's possible people might have installed MEr-ready branch first,
+	 * and then this one, in which case we still want to perform this migration,
+	 * even though the version might not have increased
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.8.0', '<=') && version_compare($version_string, '4.7.0', '>=')) {
 //          echo "$version_string can be migrated from";
-            return true;
-        } elseif (! $version_string) {
+			return true;
+		} elseif (! $version_string) {
 //          echo "no version string provided: $version_string";
-            // no version string provided... this must be pre 4.3
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
+			// no version string provided... this must be pre 4.3
+			return false;// changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //          echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $now_in_mysql = current_time('mysql', true);
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$now_in_mysql = current_time('mysql', true);
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID),
 					KEY REG_ID (REG_ID),
 					KEY QST_ID (QST_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID int(10) unsigned NOT	NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "ATTM_ID int(10) unsigned NOT	NULL AUTO_INCREMENT,
 						ATT_ID bigint(20) unsigned NOT NULL,
 						ATT_fname varchar(45) NOT NULL,
 						ATT_lname varchar(45) NOT	NULL,
@@ -117,9 +117,9 @@ 
 							PRIMARY KEY  (ATTM_ID),
 								KEY ATT_ID (ATT_ID),
 								KEY ATT_email (ATT_email(191))";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO varchar(2) collate utf8_bin NOT NULL,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO varchar(2) collate utf8_bin NOT NULL,
 					  CNT_ISO3 varchar(3) collate utf8_bin NOT NULL,
 					  RGN_ID tinyint(3) unsigned DEFAULT NULL,
 					  CNT_name varchar(45) collate utf8_bin NOT NULL,
@@ -135,25 +135,25 @@ 
 					  CNT_is_EU tinyint(1) DEFAULT '0',
 					  CNT_active tinyint(1) DEFAULT '0',
 					  PRIMARY KEY  (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code varchar(6) collate utf8_bin NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code varchar(6) collate utf8_bin NOT NULL,
 				CUR_single varchar(45) collate utf8_bin DEFAULT 'dollar',
 				CUR_plural varchar(45) collate utf8_bin DEFAULT 'dollars',
 				CUR_sign varchar(45) collate utf8_bin DEFAULT '$',
 				CUR_dec_plc varchar(1) collate utf8_bin NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) collate utf8_bin NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				  EVT_ID bigint(20) unsigned NOT NULL,
 				  DTT_name varchar(255) NOT NULL DEFAULT '',
 				  DTT_description text NOT NULL,
@@ -169,9 +169,9 @@ 
 						KEY DTT_EVT_start (DTT_EVT_start),
 						KEY EVT_ID (EVT_ID),
 						KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "
 			EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 			EVT_ID bigint(20) unsigned NOT NULL,
 			EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -187,34 +187,34 @@ 
 			EVT_donations tinyint(1) NULL,
 			PRIMARY KEY  (EVTM_ID),
 			KEY EVT_ID (EVT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					EVT_ID bigint(20) unsigned NOT NULL,
 					QSG_ID int(10) unsigned NOT NULL,
 					EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EQG_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY QSG_ID (QSG_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID),
 				KEY EXM_type (EXM_type,OBJ_ID,EXM_key)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_join';
-        $sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_join';
+		$sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(6) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(6) NOT NULL,
@@ -222,9 +222,9 @@ 
 				PRIMARY KEY  (EXJ_ID),
 				KEY first_model (EXJ_first_model_name,EXJ_first_model_id),
 				KEY second_model (EXJ_second_model_name,EXJ_second_model_id)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -243,9 +243,9 @@ 
 				PRIMARY KEY  (LIN_ID),
 				KEY LIN_code (LIN_code(191)),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -256,18 +256,18 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					GRP_ID int(10) unsigned NOT NULL,
 					MTP_context varchar(50) NOT NULL,
 					MTP_template_field varchar(30) NOT NULL,
 					MTP_content text NOT NULL,
 					PRIMARY KEY  (MTP_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					MTP_user_id int(10) NOT NULL DEFAULT '1',
 					MTP_name varchar(245) NOT NULL DEFAULT '',
 					MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -279,17 +279,17 @@ 
 					MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 					PRIMARY KEY  (GRP_ID),
 					KEY MTP_user_id (MTP_user_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 					EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 					GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EMT_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					TXN_ID int(10) unsigned DEFAULT NULL,
 					STS_ID varchar(3) collate utf8_bin DEFAULT NULL,
 					PAY_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -306,9 +306,9 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY PAY_timestamp (PAY_timestamp),
 					KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -324,32 +324,32 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TKT_ID int(10) unsigned NOT NULL,
 					  PRC_ID int(10) unsigned NOT NULL,
 					  PRIMARY KEY  (TKP_ID),
 					  KEY TKT_ID (TKT_ID),
 					  KEY PRC_ID (PRC_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  DTT_ID int(10) unsigned NOT NULL,
 					  TKT_ID int(10) unsigned NOT NULL,
 					  PRIMARY KEY  (DTK_ID),
 					  KEY DTT_ID (DTT_ID),
 					  KEY TKT_ID (TKT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TTM_name varchar(45) NOT NULL,
 					  TTM_description text,
 					  TTM_file varchar(45),
 					  PRIMARY KEY  (TTM_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QST_display_text text NOT NULL,
 					QST_admin_label varchar(255) NOT NULL,
 					QST_system varchar(25) NOT NULL DEFAULT "",
@@ -363,18 +363,18 @@ 
 					QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QST_ID),
 					KEY QST_order (QST_order)';
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QGQ_ID),
 					KEY QST_ID (QST_ID),
 					KEY QSG_ID_order (QSG_ID,QGQ_order)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSO_value varchar(255) NOT NULL,
 					QSO_desc text NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
@@ -384,9 +384,9 @@ 
 					PRIMARY KEY  (QSO_ID),
 					KEY QST_ID (QST_ID),
 					KEY QSO_order (QSO_order)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  EVT_ID bigint(20) unsigned NOT NULL,
 					  ATT_ID bigint(20) unsigned NOT NULL,
 					  TXN_ID int(10) unsigned NOT NULL,
@@ -410,18 +410,18 @@ 
 					  KEY TKT_ID (TKT_ID),
 					  KEY EVT_ID (EVT_ID),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_registration_payment';
-        $sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_registration_payment';
+		$sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(10,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID),
 					  KEY REG_ID (REG_ID),
 					  KEY PAY_ID (PAY_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					DTT_ID int(10) unsigned NOT NULL,
 					CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -429,9 +429,9 @@ 
 					PRIMARY KEY  (CHK_ID),
 					KEY REG_ID (REG_ID),
 					KEY DTT_ID (DTT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 					  CNT_ISO varchar(2) collate utf8_bin NOT NULL,
 					  STA_abbrev varchar(24) collate utf8_bin NOT NULL,
 					  STA_name varchar(100) collate utf8_bin NOT NULL,
@@ -439,9 +439,9 @@ 
 					  PRIMARY KEY  (STA_ID),
 					  KEY STA_abbrev (STA_abbrev),
 					  KEY CNT_ISO (CNT_ISO)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID varchar(3) NOT NULL,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID varchar(3) NOT NULL,
 					  STS_code varchar(45) NOT NULL,
 					  STS_type varchar(45) NOT NULL,
 					  STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -449,9 +449,9 @@ 
 					  STS_open tinyint(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TXN_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 					  TXN_total decimal(10,3) DEFAULT '0.00',
 					  TXN_paid decimal(10,3) NOT NULL DEFAULT '0.00',
@@ -463,9 +463,9 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -484,10 +484,10 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        // modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		// modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  PRT_ID tinyint(3) unsigned NOT NULL,
 					  PRC_amount decimal(10,3) NOT NULL DEFAULT '0.00',
 					  PRC_name varchar(245) NOT NULL,
@@ -500,9 +500,9 @@ 
 					  PRC_parent int(10) unsigned DEFAULT 0,
 					  PRIMARY KEY  (PRC_ID),
 					  KEY PRT_ID (PRT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				  PRT_name varchar(45) NOT NULL,
 				  PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				  PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -511,9 +511,9 @@ 
 				  PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				  UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				  PRIMARY KEY  (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TTM_ID int(10) unsigned NOT NULL,
 					  TKT_name varchar(245) NOT NULL DEFAULT '',
 					  TKT_description text NOT NULL,
@@ -535,9 +535,9 @@ 
 					  TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 					  PRIMARY KEY  (TKT_ID),
 					  KEY TKT_start_date (TKT_start_date)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSG_name varchar(255) NOT NULL,
 					QSG_identifier varchar(100) NOT NULL,
 					QSG_desc text NULL,
@@ -550,223 +550,223 @@ 
 					PRIMARY KEY  (QSG_ID),
 					UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 					KEY QSG_order (QSG_order)';
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        // (because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        /** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
-        $script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
-        $script_4_6_defaults->add_default_admin_only_payments();
-        $script_4_6_defaults->insert_default_currencies();
-        $this->verify_new_countries();
-        $this->verify_new_currencies();
-        return true;
-    }
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		// (because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		/** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
+		$script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
+		$script_4_6_defaults->add_default_admin_only_payments();
+		$script_4_6_defaults->insert_default_currencies();
+		$this->verify_new_countries();
+		$this->verify_new_currencies();
+		return true;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        $this->fix_non_default_taxes();
-        // this is actually the same as the last DMS
-        /** @var EE_DMS_Core_4_7_0 $script_4_7_defaults */
-        $script_4_7_defaults = EE_Registry::instance()->load_dms('Core_4_7_0');
-        return $script_4_7_defaults->schema_changes_after_migration();
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		$this->fix_non_default_taxes();
+		// this is actually the same as the last DMS
+		/** @var EE_DMS_Core_4_7_0 $script_4_7_defaults */
+		$script_4_7_defaults = EE_Registry::instance()->load_dms('Core_4_7_0');
+		return $script_4_7_defaults->schema_changes_after_migration();
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 
 
 
-    /**
-     * verifies each of the new countries exists that somehow we missed in 4.1
-     */
-    public function verify_new_countries()
-    {
-        // a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
-        // how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
-        // currency symbols: http://www.xe.com/symbols.php
-        // CNT_ISO, CNT_ISO3, RGN_ID, CNT_name, CNT_cur_code, CNT_cur_single, CNT_cur_plural, CNT_cur_sign, CNT_cur_sign_b4, CNT_cur_dec_plc, CNT_tel_code, CNT_is_EU, CNT_active
-        // ('AD', 'AND', 0, 'Andorra', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+376', 0, 0),
-        $newer_countries = array(
-            array('AX', 'ALA', 0, 'Åland Islands', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+358', 1, 0),
-            array('BL', 'BLM', 0, 'Saint Barthelemy', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
-            array('CW', 'CUW', 0, 'Curacao', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+599', 1, 0),
-            array('GG', 'GGY', 0, 'Guernsey', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+44', 0, 0),
-            array('IM', 'IMN', 0, 'Isle of Man', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
-            array('JE', 'JEY', 0, 'Jersey', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
-            array('MF', 'MAF', 0, 'Saint Martin', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
-            array('ME', 'MNE', 0, 'Montenegro', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+382', 0, 0),
-            array('RS', 'SRB', 0, 'Serbia', 'RSD', 'Dinar', 'Dinars', '', 0, 2, '+381', 1, 0),
-            array('SS', 'SSD', 0, 'South Sudan', 'SSP', 'Pound', 'Pounds', '£', 1, 2, '+211', 0, 0),
-            array('SX', 'SXM', 0, 'Sint Maarten', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+1', 1, 0),
-            array('XK', 'XKX', 0, 'Kosovo', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+383', 0, 0),
-            array('YT', 'MYT', 0, 'Mayotte', 'EUR', 'Euro', 'Euros', '€', 0, 2, '+262', 1, 0),
-            array(
-                'BQ',
-                'BES',
-                0,
-                'Bonaire, Saint Eustatius and Saba',
-                'USD',
-                'Dollar',
-                'Dollars',
-                '$',
-                1,
-                2,
-                '+599',
-                0,
-                0,
-            ),
-            array('BV', 'BVT', 0, 'Bouvet Island', 'NOK', 'Krone', 'Krones', 'kr', 1, 2, '+47', 0, 0),
-            array('IO', 'IOT', 0, 'British Indian Ocean Territory', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+246', 0, 0),
-            array('CX', 'CXR', 0, 'Christmas Island', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+61', 0, 0),
-            array('CC', 'CCK', 0, 'Cocos (Keeling) Islands', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+891', 0, 0),
-            array(
-                'HM',
-                'HMD',
-                0,
-                'Heard Island and McDonald Islands',
-                'AUD',
-                'Dollar',
-                'Dollars',
-                '$',
-                1,
-                2,
-                '+891',
-                0,
-                0,
-            ),
-            array('PS', 'PSE', 0, 'Palestinian Territory', 'ILS', 'Shekel', 'Shekels', '₪', 1, 2, '+970', 0, 0),
-            array(
-                'GS',
-                'SGS',
-                0,
-                'South Georgia and the South Sandwich Islands',
-                'GBP',
-                'Pound',
-                'Pounds',
-                '£',
-                1,
-                2,
-                '+500',
-                0,
-                0,
-            ),
-            array('TL', 'TLS', 0, 'Timor-Leste', 'USD', 'Dollar', 'Dollars', '$', 1, 2, '+670', 0, 0),
-            array('TF', 'ATF', 0, 'French Southern Territories', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+262', 0, 0),
-            array(
-                'UM',
-                'UMI',
-                0,
-                'United States Minor Outlying Islands',
-                'USD',
-                'Dollar',
-                'Dollars',
-                '$',
-                1,
-                2,
-                '+1',
-                0,
-                0,
-            ),
-        );
-        global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
-        $country_format = array(
-            "CNT_ISO"         => '%s',
-            "CNT_ISO3"        => '%s',
-            "RGN_ID"          => '%d',
-            "CNT_name"        => '%s',
-            "CNT_cur_code"    => '%s',
-            "CNT_cur_single"  => '%s',
-            "CNT_cur_plural"  => '%s',
-            "CNT_cur_sign"    => '%s',
-            "CNT_cur_sign_b4" => '%d',
-            "CNT_cur_dec_plc" => '%d',
-            "CNT_tel_code"    => '%s',
-            "CNT_is_EU"       => '%d',
-            "CNT_active"      => '%d',
-        );
-        if ($this->_get_table_analysis()->tableExists($country_table)) {
-            foreach ($newer_countries as $country) {
-                $SQL = "SELECT COUNT('CNT_ISO') FROM {$country_table} WHERE CNT_ISO='{$country[0]}' LIMIT 1";
-                $countries = $wpdb->get_var($SQL);
-                if (! $countries) {
-                    $wpdb->insert(
-                        $country_table,
-                        array_combine(array_keys($country_format), $country),
-                        $country_format
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * verifies each of the new countries exists that somehow we missed in 4.1
+	 */
+	public function verify_new_countries()
+	{
+		// a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
+		// how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
+		// currency symbols: http://www.xe.com/symbols.php
+		// CNT_ISO, CNT_ISO3, RGN_ID, CNT_name, CNT_cur_code, CNT_cur_single, CNT_cur_plural, CNT_cur_sign, CNT_cur_sign_b4, CNT_cur_dec_plc, CNT_tel_code, CNT_is_EU, CNT_active
+		// ('AD', 'AND', 0, 'Andorra', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+376', 0, 0),
+		$newer_countries = array(
+			array('AX', 'ALA', 0, 'Åland Islands', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+358', 1, 0),
+			array('BL', 'BLM', 0, 'Saint Barthelemy', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
+			array('CW', 'CUW', 0, 'Curacao', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+599', 1, 0),
+			array('GG', 'GGY', 0, 'Guernsey', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+44', 0, 0),
+			array('IM', 'IMN', 0, 'Isle of Man', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
+			array('JE', 'JEY', 0, 'Jersey', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
+			array('MF', 'MAF', 0, 'Saint Martin', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
+			array('ME', 'MNE', 0, 'Montenegro', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+382', 0, 0),
+			array('RS', 'SRB', 0, 'Serbia', 'RSD', 'Dinar', 'Dinars', '', 0, 2, '+381', 1, 0),
+			array('SS', 'SSD', 0, 'South Sudan', 'SSP', 'Pound', 'Pounds', '£', 1, 2, '+211', 0, 0),
+			array('SX', 'SXM', 0, 'Sint Maarten', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+1', 1, 0),
+			array('XK', 'XKX', 0, 'Kosovo', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+383', 0, 0),
+			array('YT', 'MYT', 0, 'Mayotte', 'EUR', 'Euro', 'Euros', '€', 0, 2, '+262', 1, 0),
+			array(
+				'BQ',
+				'BES',
+				0,
+				'Bonaire, Saint Eustatius and Saba',
+				'USD',
+				'Dollar',
+				'Dollars',
+				'$',
+				1,
+				2,
+				'+599',
+				0,
+				0,
+			),
+			array('BV', 'BVT', 0, 'Bouvet Island', 'NOK', 'Krone', 'Krones', 'kr', 1, 2, '+47', 0, 0),
+			array('IO', 'IOT', 0, 'British Indian Ocean Territory', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+246', 0, 0),
+			array('CX', 'CXR', 0, 'Christmas Island', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+61', 0, 0),
+			array('CC', 'CCK', 0, 'Cocos (Keeling) Islands', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+891', 0, 0),
+			array(
+				'HM',
+				'HMD',
+				0,
+				'Heard Island and McDonald Islands',
+				'AUD',
+				'Dollar',
+				'Dollars',
+				'$',
+				1,
+				2,
+				'+891',
+				0,
+				0,
+			),
+			array('PS', 'PSE', 0, 'Palestinian Territory', 'ILS', 'Shekel', 'Shekels', '₪', 1, 2, '+970', 0, 0),
+			array(
+				'GS',
+				'SGS',
+				0,
+				'South Georgia and the South Sandwich Islands',
+				'GBP',
+				'Pound',
+				'Pounds',
+				'£',
+				1,
+				2,
+				'+500',
+				0,
+				0,
+			),
+			array('TL', 'TLS', 0, 'Timor-Leste', 'USD', 'Dollar', 'Dollars', '$', 1, 2, '+670', 0, 0),
+			array('TF', 'ATF', 0, 'French Southern Territories', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+262', 0, 0),
+			array(
+				'UM',
+				'UMI',
+				0,
+				'United States Minor Outlying Islands',
+				'USD',
+				'Dollar',
+				'Dollars',
+				'$',
+				1,
+				2,
+				'+1',
+				0,
+				0,
+			),
+		);
+		global $wpdb;
+		$country_table = $wpdb->prefix . "esp_country";
+		$country_format = array(
+			"CNT_ISO"         => '%s',
+			"CNT_ISO3"        => '%s',
+			"RGN_ID"          => '%d',
+			"CNT_name"        => '%s',
+			"CNT_cur_code"    => '%s',
+			"CNT_cur_single"  => '%s',
+			"CNT_cur_plural"  => '%s',
+			"CNT_cur_sign"    => '%s',
+			"CNT_cur_sign_b4" => '%d',
+			"CNT_cur_dec_plc" => '%d',
+			"CNT_tel_code"    => '%s',
+			"CNT_is_EU"       => '%d',
+			"CNT_active"      => '%d',
+		);
+		if ($this->_get_table_analysis()->tableExists($country_table)) {
+			foreach ($newer_countries as $country) {
+				$SQL = "SELECT COUNT('CNT_ISO') FROM {$country_table} WHERE CNT_ISO='{$country[0]}' LIMIT 1";
+				$countries = $wpdb->get_var($SQL);
+				if (! $countries) {
+					$wpdb->insert(
+						$country_table,
+						array_combine(array_keys($country_format), $country),
+						$country_format
+					);
+				}
+			}
+		}
+	}
 
 
 
-    /**
-     * verifies each of the new currencies exists that somehow we missed in 4.6
-     */
-    public function verify_new_currencies()
-    {
-        // a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
-        // how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
-        // currency symbols: http://www.xe.com/symbols.php
-        // CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active
-        // ( 'EUR',  'Euro',  'Euros',  '€',  2,1),
-        $newer_currencies = array(
-            array('RSD', 'Dinar', 'Dinars', '', 3, 1),
-        );
-        global $wpdb;
-        $currency_table = $wpdb->prefix . "esp_currency";
-        $currency_format = array(
-            "CUR_code"    => '%s',
-            "CUR_single"  => '%s',
-            "CUR_plural"  => '%s',
-            "CUR_sign"    => '%s',
-            "CUR_dec_plc" => '%d',
-            "CUR_active"  => '%d',
-        );
-        if ($this->_get_table_analysis()->tableExists($currency_table)) {
-            foreach ($newer_currencies as $currency) {
-                $SQL = "SELECT COUNT('CUR_code') FROM {$currency_table} WHERE CUR_code='{$currency[0]}' LIMIT 1";
-                $countries = $wpdb->get_var($SQL);
-                if (! $countries) {
-                    $wpdb->insert(
-                        $currency_table,
-                        array_combine(array_keys($currency_format), $currency),
-                        $currency_format
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * verifies each of the new currencies exists that somehow we missed in 4.6
+	 */
+	public function verify_new_currencies()
+	{
+		// a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
+		// how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
+		// currency symbols: http://www.xe.com/symbols.php
+		// CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active
+		// ( 'EUR',  'Euro',  'Euros',  '€',  2,1),
+		$newer_currencies = array(
+			array('RSD', 'Dinar', 'Dinars', '', 3, 1),
+		);
+		global $wpdb;
+		$currency_table = $wpdb->prefix . "esp_currency";
+		$currency_format = array(
+			"CUR_code"    => '%s',
+			"CUR_single"  => '%s',
+			"CUR_plural"  => '%s',
+			"CUR_sign"    => '%s',
+			"CUR_dec_plc" => '%d',
+			"CUR_active"  => '%d',
+		);
+		if ($this->_get_table_analysis()->tableExists($currency_table)) {
+			foreach ($newer_currencies as $currency) {
+				$SQL = "SELECT COUNT('CUR_code') FROM {$currency_table} WHERE CUR_code='{$currency[0]}' LIMIT 1";
+				$countries = $wpdb->get_var($SQL);
+				if (! $countries) {
+					$wpdb->insert(
+						$currency_table,
+						array_combine(array_keys($currency_format), $currency),
+						$currency_format
+					);
+				}
+			}
+		}
+	}
 
 
 
-    /**
-     * addresses https://events.codebasehq.com/projects/event-espresso/tickets/8731
-     * which should just be a temporary issue for folks who installed 4.8.0-4.8.5;
-     * we should be able to stop doing this in 4.9
-     */
-    public function fix_non_default_taxes()
-    {
-        global $wpdb;
-        $query = $wpdb->prepare("UPDATE
+	/**
+	 * addresses https://events.codebasehq.com/projects/event-espresso/tickets/8731
+	 * which should just be a temporary issue for folks who installed 4.8.0-4.8.5;
+	 * we should be able to stop doing this in 4.9
+	 */
+	public function fix_non_default_taxes()
+	{
+		global $wpdb;
+		$query = $wpdb->prepare("UPDATE
 				{$wpdb->prefix}esp_price p INNER JOIN
 				{$wpdb->prefix}esp_price_type pt ON p.PRT_ID = pt.PRT_ID
 			SET
@@ -775,6 +775,6 @@ 
 				p.PRC_is_default = 0 AND
 				pt.PBT_ID = %d
 					", EEM_Price_Type::base_type_tax);
-        $wpdb->query($query);
-    }
+		$wpdb->query($query);
+	}
 }

admin_pages/general_settings/OrganizationSettings.php

Indentation +473 added lines, -473 removed lines

@@ -40,498 +40,498 @@
 class OrganizationSettings extends FormHandler
 {
 
-    /**
-     * @var EE_Organization_Config
-     */
-    protected $organization_config;
+	/**
+	 * @var EE_Organization_Config
+	 */
+	protected $organization_config;
 
-    /**
-     * @var EE_Core_Config
-     */
-    protected $core_config;
+	/**
+	 * @var EE_Core_Config
+	 */
+	protected $core_config;
 
 
-    /**
-     * @var EE_Network_Core_Config
-     */
-    protected $network_core_config;
+	/**
+	 * @var EE_Network_Core_Config
+	 */
+	protected $network_core_config;
 
-    /**
-     * Form constructor.
-     *
-     * @param EE_Registry             $registry
-     * @param EE_Organization_Config  $organization_config
-     * @param EE_Core_Config          $core_config
-     * @param EE_Network_Core_Config $network_core_config
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function __construct(
-        EE_Registry $registry,
-        EE_Organization_Config $organization_config,
-        EE_Core_Config $core_config,
-        EE_Network_Core_Config $network_core_config
-    ) {
-        $this->organization_config = $organization_config;
-        $this->core_config = $core_config;
-        $this->network_core_config = $network_core_config;
-        parent::__construct(
-            esc_html__('Your Organization Settings', 'event_espresso'),
-            esc_html__('Your Organization Settings', 'event_espresso'),
-            'organization_settings',
-            '',
-            FormHandler::DO_NOT_SETUP_FORM,
-            $registry
-        );
-    }
+	/**
+	 * Form constructor.
+	 *
+	 * @param EE_Registry             $registry
+	 * @param EE_Organization_Config  $organization_config
+	 * @param EE_Core_Config          $core_config
+	 * @param EE_Network_Core_Config $network_core_config
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function __construct(
+		EE_Registry $registry,
+		EE_Organization_Config $organization_config,
+		EE_Core_Config $core_config,
+		EE_Network_Core_Config $network_core_config
+	) {
+		$this->organization_config = $organization_config;
+		$this->core_config = $core_config;
+		$this->network_core_config = $network_core_config;
+		parent::__construct(
+			esc_html__('Your Organization Settings', 'event_espresso'),
+			esc_html__('Your Organization Settings', 'event_espresso'),
+			'organization_settings',
+			'',
+			FormHandler::DO_NOT_SETUP_FORM,
+			$registry
+		);
+	}
 
 
 
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function generate()
-    {
-        $form = new EE_Form_Section_Proper(
-            array(
-                'name'            => 'organization_settings',
-                'html_id'         => 'organization_settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => array(
-                    'contact_information_hdr'        => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Contact Information', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(EEH_Template::get_help_tab_link('contact_info_info')),
-                            '',
-                            'contact-information-hdr'
-                        )
-                    ),
-                    'organization_name'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_name',
-                            'html_label_text' => esc_html__('Organization Name', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'Displayed on all emails and invoices.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('name'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_address_1'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_address_1',
-                            'html_label_text' => esc_html__('Street Address', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('address_1'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_address_2'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_address_2',
-                            'html_label_text' => esc_html__('Street Address 2', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('address_2'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_city'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_city',
-                            'html_label_text' => esc_html__('City', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('city'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_state'      => new EE_State_Select_Input(
-                        null,
-                        array(
-                            'html_name' => 'organization_state',
-                            'html_label_text' => esc_html__('State/Province', 'event_espresso'),
-                            'default'         => $this->organization_config->STA_ID,
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_country'      => new EE_Country_Select_Input(
-                        null,
-                        array(
-                            'html_name' => 'organization_country',
-                            'html_label_text' => esc_html__('Country', 'event_espresso'),
-                            'default'         => $this->organization_config->CNT_ISO,
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_zip'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_zip',
-                            'html_label_text' => esc_html__('Zip/Postal Code', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('zip'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_email'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_email',
-                            'html_label_text' => esc_html__('Primary Contact Email', 'event_espresso'),
-                            'html_help_text'  => sprintf(
-                                esc_html__(
-                                    'This is where notifications go to when you use the %1$s and %2$s shortcodes in the message templates.',
-                                    'event_espresso'
-                                ),
-                                '<code>[CO_FORMATTED_EMAIL]</code>',
-                                '<code>[CO_EMAIL]</code>'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('email'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_phone'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_phone',
-                            'html_label_text' => esc_html__('Phone Number', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'The phone number for your organization.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('phone'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_vat'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_vat',
-                            'html_label_text' => esc_html__('VAT/Tax Number', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'The VAT/Tax Number may be displayed on invoices and receipts.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('vat'),
-                            'required'        => false,
-                        )
-                    ),
-                    'company_logo_hdr'        => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Company Logo', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(EEH_Template::get_help_tab_link('organization_logo_info')),
-                            '',
-                            'company-logo-hdr'
-                        )
-                    ),
-                    'organization_logo_url'      => new EE_Admin_File_Uploader_Input(
-                        array(
-                            'html_name' => 'organization_logo_url',
-                            'html_label_text' => esc_html__('Upload New Logo', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'Your logo will be used on custom invoices, tickets, certificates, and payment templates.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('logo_url'),
-                            'required'        => false,
-                        )
-                    ),
-                    'social_links_hdr'        => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Social Links', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(EEH_Template::get_help_tab_link('social_links_info'))
-                            . EEH_HTML::br()
-                            . EEH_HTML::p(
-                                esc_html__(
-                                    'Enter any links to social accounts for your organization here',
-                                    'event_espresso'
-                                ),
-                                '',
-                                'description'
-                            ),
-                            '',
-                            'social-links-hdr'
-                        )
-                    ),
-                    'organization_facebook'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_facebook',
-                            'html_label_text' => esc_html__('Facebook', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="facebook.com/profile.name"',
-                            'default'         => $this->organization_config->get_pretty('facebook'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_twitter'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_twitter',
-                            'html_label_text' => esc_html__('Twitter', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="twitter.com/twitterhandle"',
-                            'default'         => $this->organization_config->get_pretty('twitter'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_linkedin'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_linkedin',
-                            'html_label_text' => esc_html__('LinkedIn', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="linkedin.com/in/profilename"',
-                            'default'         => $this->organization_config->get_pretty('linkedin'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_pinterest'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_pinterest',
-                            'html_label_text' => esc_html__('Pinterest', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="pinterest.com/profilename"',
-                            'default'         => $this->organization_config->get_pretty('pinterest'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_google'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_google',
-                            'html_label_text' => esc_html__('Google+', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="google.com/+profilename"',
-                            'default'         => $this->organization_config->get_pretty('google'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_instagram'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_instagram',
-                            'html_label_text' => esc_html__('Instagram', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="instagram.com/handle"',
-                            'default'         => $this->organization_config->get_pretty('instagram'),
-                            'required'        => false,
-                        )
-                    ),
-                ),
-            )
-        );
-        if (is_main_site()) {
-            $form->add_subsections(
-                array(
-                    'site_license_key_hdr' => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Your Event Espresso License Key', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(
-                                EEH_Template::get_help_tab_link('site_license_key_info'),
-                                'help_tour_activation'
-                            ),
-                            '',
-                            'site-license-key-hdr'
-                        )
-                    ),
-                    'site_license_key' => $this->getSiteLicenseKeyField()
-                )
-            );
-            $form->add_subsections(
-                array(
-                    'uxip_optin_hdr' => new EE_Form_Section_HTML(
-                        $this->uxipOptinText()
-                    ),
-                    'ueip_optin' => new EE_Checkbox_Multi_Input(
-                        array(
-                            true => __('Yes! I want to help improve Event Espresso!', 'event_espresso')
-                        ),
-                        array(
-                            'html_name' => EE_Core_Config::OPTION_NAME_UXIP,
-                            'html_label_text' => esc_html__(
-                                'UXIP Opt In?',
-                                'event_espresso'
-                            ),
-                            'default'         => isset($this->core_config->ee_ueip_optin)
-                                ? filter_var($this->core_config->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN)
-                                : false,
-                            'required'        => false,
-                        )
-                    ),
-                ),
-                'organization_instagram',
-                false
-            );
-        }
-        return $form;
-    }
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function generate()
+	{
+		$form = new EE_Form_Section_Proper(
+			array(
+				'name'            => 'organization_settings',
+				'html_id'         => 'organization_settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => array(
+					'contact_information_hdr'        => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Contact Information', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(EEH_Template::get_help_tab_link('contact_info_info')),
+							'',
+							'contact-information-hdr'
+						)
+					),
+					'organization_name'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_name',
+							'html_label_text' => esc_html__('Organization Name', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'Displayed on all emails and invoices.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('name'),
+							'required'        => false,
+						)
+					),
+					'organization_address_1'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_address_1',
+							'html_label_text' => esc_html__('Street Address', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('address_1'),
+							'required'        => false,
+						)
+					),
+					'organization_address_2'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_address_2',
+							'html_label_text' => esc_html__('Street Address 2', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('address_2'),
+							'required'        => false,
+						)
+					),
+					'organization_city'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_city',
+							'html_label_text' => esc_html__('City', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('city'),
+							'required'        => false,
+						)
+					),
+					'organization_state'      => new EE_State_Select_Input(
+						null,
+						array(
+							'html_name' => 'organization_state',
+							'html_label_text' => esc_html__('State/Province', 'event_espresso'),
+							'default'         => $this->organization_config->STA_ID,
+							'required'        => false,
+						)
+					),
+					'organization_country'      => new EE_Country_Select_Input(
+						null,
+						array(
+							'html_name' => 'organization_country',
+							'html_label_text' => esc_html__('Country', 'event_espresso'),
+							'default'         => $this->organization_config->CNT_ISO,
+							'required'        => false,
+						)
+					),
+					'organization_zip'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_zip',
+							'html_label_text' => esc_html__('Zip/Postal Code', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('zip'),
+							'required'        => false,
+						)
+					),
+					'organization_email'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_email',
+							'html_label_text' => esc_html__('Primary Contact Email', 'event_espresso'),
+							'html_help_text'  => sprintf(
+								esc_html__(
+									'This is where notifications go to when you use the %1$s and %2$s shortcodes in the message templates.',
+									'event_espresso'
+								),
+								'<code>[CO_FORMATTED_EMAIL]</code>',
+								'<code>[CO_EMAIL]</code>'
+							),
+							'default'         => $this->organization_config->get_pretty('email'),
+							'required'        => false,
+						)
+					),
+					'organization_phone'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_phone',
+							'html_label_text' => esc_html__('Phone Number', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'The phone number for your organization.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('phone'),
+							'required'        => false,
+						)
+					),
+					'organization_vat'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_vat',
+							'html_label_text' => esc_html__('VAT/Tax Number', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'The VAT/Tax Number may be displayed on invoices and receipts.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('vat'),
+							'required'        => false,
+						)
+					),
+					'company_logo_hdr'        => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Company Logo', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(EEH_Template::get_help_tab_link('organization_logo_info')),
+							'',
+							'company-logo-hdr'
+						)
+					),
+					'organization_logo_url'      => new EE_Admin_File_Uploader_Input(
+						array(
+							'html_name' => 'organization_logo_url',
+							'html_label_text' => esc_html__('Upload New Logo', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'Your logo will be used on custom invoices, tickets, certificates, and payment templates.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('logo_url'),
+							'required'        => false,
+						)
+					),
+					'social_links_hdr'        => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Social Links', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(EEH_Template::get_help_tab_link('social_links_info'))
+							. EEH_HTML::br()
+							. EEH_HTML::p(
+								esc_html__(
+									'Enter any links to social accounts for your organization here',
+									'event_espresso'
+								),
+								'',
+								'description'
+							),
+							'',
+							'social-links-hdr'
+						)
+					),
+					'organization_facebook'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_facebook',
+							'html_label_text' => esc_html__('Facebook', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="facebook.com/profile.name"',
+							'default'         => $this->organization_config->get_pretty('facebook'),
+							'required'        => false,
+						)
+					),
+					'organization_twitter'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_twitter',
+							'html_label_text' => esc_html__('Twitter', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="twitter.com/twitterhandle"',
+							'default'         => $this->organization_config->get_pretty('twitter'),
+							'required'        => false,
+						)
+					),
+					'organization_linkedin'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_linkedin',
+							'html_label_text' => esc_html__('LinkedIn', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="linkedin.com/in/profilename"',
+							'default'         => $this->organization_config->get_pretty('linkedin'),
+							'required'        => false,
+						)
+					),
+					'organization_pinterest'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_pinterest',
+							'html_label_text' => esc_html__('Pinterest', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="pinterest.com/profilename"',
+							'default'         => $this->organization_config->get_pretty('pinterest'),
+							'required'        => false,
+						)
+					),
+					'organization_google'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_google',
+							'html_label_text' => esc_html__('Google+', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="google.com/+profilename"',
+							'default'         => $this->organization_config->get_pretty('google'),
+							'required'        => false,
+						)
+					),
+					'organization_instagram'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_instagram',
+							'html_label_text' => esc_html__('Instagram', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="instagram.com/handle"',
+							'default'         => $this->organization_config->get_pretty('instagram'),
+							'required'        => false,
+						)
+					),
+				),
+			)
+		);
+		if (is_main_site()) {
+			$form->add_subsections(
+				array(
+					'site_license_key_hdr' => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Your Event Espresso License Key', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(
+								EEH_Template::get_help_tab_link('site_license_key_info'),
+								'help_tour_activation'
+							),
+							'',
+							'site-license-key-hdr'
+						)
+					),
+					'site_license_key' => $this->getSiteLicenseKeyField()
+				)
+			);
+			$form->add_subsections(
+				array(
+					'uxip_optin_hdr' => new EE_Form_Section_HTML(
+						$this->uxipOptinText()
+					),
+					'ueip_optin' => new EE_Checkbox_Multi_Input(
+						array(
+							true => __('Yes! I want to help improve Event Espresso!', 'event_espresso')
+						),
+						array(
+							'html_name' => EE_Core_Config::OPTION_NAME_UXIP,
+							'html_label_text' => esc_html__(
+								'UXIP Opt In?',
+								'event_espresso'
+							),
+							'default'         => isset($this->core_config->ee_ueip_optin)
+								? filter_var($this->core_config->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN)
+								: false,
+							'required'        => false,
+						)
+					),
+				),
+				'organization_instagram',
+				false
+			);
+		}
+		return $form;
+	}
 
 
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     */
-    public function display()
-    {
-        $this->form()->enqueue_js();
-        return parent::display();
-    }
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 */
+	public function display()
+	{
+		$this->form()->enqueue_js();
+		return parent::display();
+	}
 
 
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $form_data
-     * @return bool
-     * @throws InvalidFormSubmissionException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    public function process($form_data = array())
-    {
-        // process form
-        $valid_data = (array) parent::process($form_data);
-        if (empty($valid_data)) {
-            return false;
-        }
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $form_data
+	 * @return bool
+	 * @throws InvalidFormSubmissionException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	public function process($form_data = array())
+	{
+		// process form
+		$valid_data = (array) parent::process($form_data);
+		if (empty($valid_data)) {
+			return false;
+		}
 
-        if (is_main_site()) {
-            $this->network_core_config->site_license_key = isset($form_data['ee_site_license_key'])
-                ? sanitize_text_field($form_data['ee_site_license_key'])
-                : $this->network_core_config->site_license_key;
-        }
-        $this->organization_config->name = isset($form_data['organization_name'])
-            ? sanitize_text_field($form_data['organization_name'])
-            : $this->organization_config->name;
-        $this->organization_config->address_1 = isset($form_data['organization_address_1'])
-            ? sanitize_text_field($form_data['organization_address_1'])
-            : $this->organization_config->address_1;
-        $this->organization_config->address_2 = isset($form_data['organization_address_2'])
-            ? sanitize_text_field($form_data['organization_address_2'])
-            : $this->organization_config->address_2;
-        $this->organization_config->city = isset($form_data['organization_city'])
-            ? sanitize_text_field($form_data['organization_city'])
-            : $this->organization_config->city;
-        $this->organization_config->STA_ID = isset($form_data['organization_state'])
-            ? absint($form_data['organization_state'])
-            : $this->organization_config->STA_ID;
-        $this->organization_config->CNT_ISO = isset($form_data['organization_country'])
-            ? sanitize_text_field($form_data['organization_country'])
-            : $this->organization_config->CNT_ISO;
-        $this->organization_config->zip = isset($form_data['organization_zip'])
-            ? sanitize_text_field($form_data['organization_zip'])
-            : $this->organization_config->zip;
-        $this->organization_config->email = isset($form_data['organization_email'])
-            ? sanitize_email($form_data['organization_email'])
-            : $this->organization_config->email;
-        $this->organization_config->vat = isset($form_data['organization_vat'])
-            ? sanitize_text_field($form_data['organization_vat'])
-            : $this->organization_config->vat;
-        $this->organization_config->phone = isset($form_data['organization_phone'])
-            ? sanitize_text_field($form_data['organization_phone'])
-            : $this->organization_config->phone;
-        $this->organization_config->logo_url = isset($form_data['organization_logo_url'])
-            ? esc_url_raw($form_data['organization_logo_url'])
-            : $this->organization_config->logo_url;
-        $this->organization_config->facebook = isset($form_data['organization_facebook'])
-            ? esc_url_raw($form_data['organization_facebook'])
-            : $this->organization_config->facebook;
-        $this->organization_config->twitter = isset($form_data['organization_twitter'])
-            ? esc_url_raw($form_data['organization_twitter'])
-            : $this->organization_config->twitter;
-        $this->organization_config->linkedin = isset($form_data['organization_linkedin'])
-            ? esc_url_raw($form_data['organization_linkedin'])
-            : $this->organization_config->linkedin;
-        $this->organization_config->pinterest = isset($form_data['organization_pinterest'])
-            ? esc_url_raw($form_data['organization_pinterest'])
-            : $this->organization_config->pinterest;
-        $this->organization_config->google = isset($form_data['organization_google'])
-            ? esc_url_raw($form_data['organization_google'])
-            : $this->organization_config->google;
-        $this->organization_config->instagram = isset($form_data['organization_instagram'])
-            ? esc_url_raw($form_data['organization_instagram'])
-            : $this->organization_config->instagram;
-        $this->core_config->ee_ueip_optin = isset($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0])
-            ? filter_var($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0], FILTER_VALIDATE_BOOLEAN)
-            : false;
-        $this->core_config->ee_ueip_has_notified = true;
+		if (is_main_site()) {
+			$this->network_core_config->site_license_key = isset($form_data['ee_site_license_key'])
+				? sanitize_text_field($form_data['ee_site_license_key'])
+				: $this->network_core_config->site_license_key;
+		}
+		$this->organization_config->name = isset($form_data['organization_name'])
+			? sanitize_text_field($form_data['organization_name'])
+			: $this->organization_config->name;
+		$this->organization_config->address_1 = isset($form_data['organization_address_1'])
+			? sanitize_text_field($form_data['organization_address_1'])
+			: $this->organization_config->address_1;
+		$this->organization_config->address_2 = isset($form_data['organization_address_2'])
+			? sanitize_text_field($form_data['organization_address_2'])
+			: $this->organization_config->address_2;
+		$this->organization_config->city = isset($form_data['organization_city'])
+			? sanitize_text_field($form_data['organization_city'])
+			: $this->organization_config->city;
+		$this->organization_config->STA_ID = isset($form_data['organization_state'])
+			? absint($form_data['organization_state'])
+			: $this->organization_config->STA_ID;
+		$this->organization_config->CNT_ISO = isset($form_data['organization_country'])
+			? sanitize_text_field($form_data['organization_country'])
+			: $this->organization_config->CNT_ISO;
+		$this->organization_config->zip = isset($form_data['organization_zip'])
+			? sanitize_text_field($form_data['organization_zip'])
+			: $this->organization_config->zip;
+		$this->organization_config->email = isset($form_data['organization_email'])
+			? sanitize_email($form_data['organization_email'])
+			: $this->organization_config->email;
+		$this->organization_config->vat = isset($form_data['organization_vat'])
+			? sanitize_text_field($form_data['organization_vat'])
+			: $this->organization_config->vat;
+		$this->organization_config->phone = isset($form_data['organization_phone'])
+			? sanitize_text_field($form_data['organization_phone'])
+			: $this->organization_config->phone;
+		$this->organization_config->logo_url = isset($form_data['organization_logo_url'])
+			? esc_url_raw($form_data['organization_logo_url'])
+			: $this->organization_config->logo_url;
+		$this->organization_config->facebook = isset($form_data['organization_facebook'])
+			? esc_url_raw($form_data['organization_facebook'])
+			: $this->organization_config->facebook;
+		$this->organization_config->twitter = isset($form_data['organization_twitter'])
+			? esc_url_raw($form_data['organization_twitter'])
+			: $this->organization_config->twitter;
+		$this->organization_config->linkedin = isset($form_data['organization_linkedin'])
+			? esc_url_raw($form_data['organization_linkedin'])
+			: $this->organization_config->linkedin;
+		$this->organization_config->pinterest = isset($form_data['organization_pinterest'])
+			? esc_url_raw($form_data['organization_pinterest'])
+			: $this->organization_config->pinterest;
+		$this->organization_config->google = isset($form_data['organization_google'])
+			? esc_url_raw($form_data['organization_google'])
+			: $this->organization_config->google;
+		$this->organization_config->instagram = isset($form_data['organization_instagram'])
+			? esc_url_raw($form_data['organization_instagram'])
+			: $this->organization_config->instagram;
+		$this->core_config->ee_ueip_optin = isset($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0])
+			? filter_var($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0], FILTER_VALIDATE_BOOLEAN)
+			: false;
+		$this->core_config->ee_ueip_has_notified = true;
 
-        $this->registry->CFG->currency = new EE_Currency_Config(
-            $this->organization_config->CNT_ISO
-        );
-        return true;
-    }
+		$this->registry->CFG->currency = new EE_Currency_Config(
+			$this->organization_config->CNT_ISO
+		);
+		return true;
+	}
 
 
-    /**
-     * @return string
-     */
-    private function uxipOptinText()
-    {
-        ob_start();
-        Stats::optinText(false);
-        return ob_get_clean();
-    }
+	/**
+	 * @return string
+	 */
+	private function uxipOptinText()
+	{
+		ob_start();
+		Stats::optinText(false);
+		return ob_get_clean();
+	}
 
 
-    /**
-     * Return whether the site license key has been verified or not.
-     * @return bool
-     */
-    private function licenseKeyVerified()
-    {
-        if (empty($this->network_core_config->site_license_key)) {
-            return false;
-        }
-        $ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
-        $verify_fail = get_option($ver_option_key, false);
-        return $verify_fail === false
-                  || (! empty($this->network_core_config->site_license_key)
-                        && $verify_fail === false
-                  );
-    }
+	/**
+	 * Return whether the site license key has been verified or not.
+	 * @return bool
+	 */
+	private function licenseKeyVerified()
+	{
+		if (empty($this->network_core_config->site_license_key)) {
+			return false;
+		}
+		$ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
+		$verify_fail = get_option($ver_option_key, false);
+		return $verify_fail === false
+				  || (! empty($this->network_core_config->site_license_key)
+						&& $verify_fail === false
+				  );
+	}
 
 
-    /**
-     * @return EE_Text_Input
-     */
-    private function getSiteLicenseKeyField()
-    {
-        $text_input = new EE_Text_Input(
-            array(
-                'html_name' => 'ee_site_license_key',
-                'html_id' => 'site_license_key',
-                'html_label_text' => esc_html__('Support License Key', 'event_espresso'),
-                /** phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText */
-                'html_help_text'  => sprintf(
-                    esc_html__(
-                        'Adding a valid Support License Key will enable automatic update notifications and backend updates for Event Espresso Core and any installed add-ons. If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                ),
-                /** phpcs:enable */
-                'default'         => isset($this->network_core_config->site_license_key)
-                    ? $this->network_core_config->site_license_key
-                    : '',
-                'required'        => false,
-                'form_html_filter' => new VsprintfFilter(
-                    '%2$s %1$s',
-                    array($this->getValidationIndicator())
-                )
-            )
-        );
-        return $text_input;
-    }
+	/**
+	 * @return EE_Text_Input
+	 */
+	private function getSiteLicenseKeyField()
+	{
+		$text_input = new EE_Text_Input(
+			array(
+				'html_name' => 'ee_site_license_key',
+				'html_id' => 'site_license_key',
+				'html_label_text' => esc_html__('Support License Key', 'event_espresso'),
+				/** phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText */
+				'html_help_text'  => sprintf(
+					esc_html__(
+						'Adding a valid Support License Key will enable automatic update notifications and backend updates for Event Espresso Core and any installed add-ons. If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				),
+				/** phpcs:enable */
+				'default'         => isset($this->network_core_config->site_license_key)
+					? $this->network_core_config->site_license_key
+					: '',
+				'required'        => false,
+				'form_html_filter' => new VsprintfFilter(
+					'%2$s %1$s',
+					array($this->getValidationIndicator())
+				)
+			)
+		);
+		return $text_input;
+	}
 
 
-    /**
-     * @return string
-     */
-    private function getValidationIndicator()
-    {
-        $verified_class = $this->licenseKeyVerified() ? 'ee-icon-color-ee-green' : 'ee-icon-color-ee-red';
-        return '<span class="dashicons dashicons-admin-network ' . $verified_class . ' ee-icon-size-20"></span>';
-    }
+	/**
+	 * @return string
+	 */
+	private function getValidationIndicator()
+	{
+		$verified_class = $this->licenseKeyVerified() ? 'ee-icon-color-ee-green' : 'ee-icon-color-ee-red';
+		return '<span class="dashicons dashicons-admin-network ' . $verified_class . ' ee-icon-size-20"></span>';
+	}
 }

admin_pages/transactions/Transactions_Admin_Page.core.php

Indentation +2464 added lines, -2464 removed lines

@@ -14,2468 +14,2468 @@
 class Transactions_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * @var EE_Transaction
-     */
-    private $_transaction;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    /**
-     * @var array $_txn_status
-     */
-    private static $_txn_status;
-
-    /**
-     * @var array $_pay_status
-     */
-    private static $_pay_status;
-
-    /**
-     * @var array $_existing_reg_payment_REG_IDs
-     */
-    protected $_existing_reg_payment_REG_IDs = null;
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    /**
-     *    _init_page_props
-     *
-     * @return void
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug = TXN_PG_SLUG;
-        $this->page_label = esc_html__('Transactions', 'event_espresso');
-        $this->_admin_base_url = TXN_ADMIN_URL;
-        $this->_admin_base_path = TXN_ADMIN;
-    }
-
-
-    /**
-     *    _ajax_hooks
-     *
-     * @return void
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds'));
-        add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds'));
-        add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment'));
-    }
-
-
-    /**
-     *    _define_page_props
-     *
-     * @return void
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'buttons' => array(
-                'add'    => esc_html__('Add New Transaction', 'event_espresso'),
-                'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
-                'delete' => esc_html__('Delete Transaction', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _set_page_routes()
-    {
-
-        $this->_set_transaction_status_array();
-
-        $txn_id = ! empty($this->_req_data['TXN_ID'])
-                  && ! is_array($this->_req_data['TXN_ID'])
-            ? $this->_req_data['TXN_ID']
-            : 0;
-
-        $this->_page_routes = array(
-
-            'default' => array(
-                'func'       => '_transactions_overview_list_table',
-                'capability' => 'ee_read_transactions',
-            ),
-
-            'view_transaction' => array(
-                'func'       => '_transaction_details',
-                'capability' => 'ee_read_transaction',
-                'obj_id'     => $txn_id,
-            ),
-
-            'send_payment_reminder' => array(
-                'func'       => '_send_payment_reminder',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-
-            'espresso_apply_payment' => array(
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ),
-
-            'espresso_apply_refund' => array(
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ),
-
-            'espresso_delete_payment' => array(
-                'func'       => 'delete_payment',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payments',
-            ),
-
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'          => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'EE_Admin_Transactions_List_Table',
-                'help_tabs'     => array(
-                    'transactions_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Transactions Overview', 'event_espresso'),
-                        'filename' => 'transactions_overview',
-                    ),
-                    'transactions_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
-                        'filename' => 'transactions_overview_table_column_headings',
-                    ),
-                    'transactions_overview_views_filters_help_tab'         => array(
-                        'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
-                        'filename' => 'transactions_overview_views_filters_search',
-                    ),
-                ),
-                'help_tour'     => array('Transactions_Overview_Help_Tour'),
-                /**
-                 * commented out because currently we are not displaying tips for transaction list table status but this
-                 * may change in a later iteration so want to keep the code for then.
-                 */
-                // 'qtips' => array( 'Transactions_List_Table_Tips' ),
-                'require_nonce' => false,
-            ),
-            'view_transaction' => array(
-                'nav'       => array(
-                    'label'      => esc_html__('View Transaction', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => isset($this->_req_data['TXN_ID'])
-                        ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ),
-                'help_tabs' => array(
-                    'transactions_view_transaction_help_tab'                                              => array(
-                        'title'    => esc_html__('View Transaction', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction',
-                    ),
-                    'transactions_view_transaction_transaction_details_table_help_tab'                    => array(
-                        'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_transaction_details_table',
-                    ),
-                    'transactions_view_transaction_attendees_registered_help_tab'                         => array(
-                        'title'    => esc_html__('Attendees Registered', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_attendees_registered',
-                    ),
-                    'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array(
-                        'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
-                    ),
-                ),
-                'qtips'     => array('Transaction_Details_Tips'),
-                'help_tour' => array('Transaction_Details_Help_Tour'),
-                'metaboxes' => array('_transaction_details_metaboxes'),
-
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-        // noop
-    }
-
-    protected function _add_feature_pointers()
-    {
-        // noop
-    }
-
-    public function admin_init()
-    {
-        // IF a registration was JUST added via the admin...
-        if (isset(
-            $this->_req_data['redirect_from'],
-            $this->_req_data['EVT_ID'],
-            $this->_req_data['event_name']
-        )) {
-            // then set a cookie so that we can block any attempts to use
-            // the back button as a way to enter another registration.
-            setcookie(
-                'ee_registration_added',
-                $this->_req_data['EVT_ID'],
-                time() + WEEK_IN_SECONDS,
-                '/'
-            );
-            // and update the global
-            $_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID'];
-        }
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
-            'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__(
-            'An error occurred! Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['txn_status_array'] = self::$_txn_status;
-        EE_Registry::$i18n_js_strings['pay_status_array'] = self::$_pay_status;
-        EE_Registry::$i18n_js_strings['payments_total'] = esc_html__('Payments Total', 'event_espresso');
-        EE_Registry::$i18n_js_strings['transaction_overpaid'] = esc_html__(
-            'This transaction has been overpaid ! Payments Total',
-            'event_espresso'
-        );
-    }
-
-    public function admin_notices()
-    {
-        // noop
-    }
-
-    public function admin_footer_scripts()
-    {
-        // noop
-    }
-
-
-    /**
-     * _set_transaction_status_array
-     * sets list of transaction statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_transaction_status_array()
-    {
-        self::$_txn_status = EEM_Transaction::instance()->status_array(true);
-    }
-
-
-    /**
-     * get_transaction_status_array
-     * return the transaction status array for wp_list_table
-     *
-     * @access public
-     * @return array
-     */
-    public function get_transaction_status_array()
-    {
-        return self::$_txn_status;
-    }
-
-
-    /**
-     *    get list of payment statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_payment_status_array()
-    {
-        self::$_pay_status = EEM_Payment::instance()->status_array(true);
-        $this->_template_args['payment_status'] = self::$_pay_status;
-    }
-
-
-    /**
-     *    _add_screen_options_default
-     *
-     * @access protected
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * load_scripts_styles
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles()
-    {
-        // enqueue style
-        wp_register_style(
-            'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_txn');
-        // scripts
-        wp_register_script(
-            'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.js',
-            array(
-                'ee_admin_js',
-                'ee-datepicker',
-                'jquery-ui-datepicker',
-                'jquery-ui-draggable',
-                'ee-dialog',
-                'ee-accounting',
-                'ee-serialize-full-array',
-            ),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_txn');
-    }
-
-
-    /**
-     *    load_scripts_styles_view_transaction
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_view_transaction()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    load_scripts_styles_default
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_default()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    _set_list_table_views_default
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all'       => array(
-                'slug'  => 'all',
-                'label' => esc_html__('View All Transactions', 'event_espresso'),
-                'count' => 0,
-            ),
-            'abandoned' => array(
-                'slug'  => 'abandoned',
-                'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
-                'count' => 0,
-            ),
-            'failed'    => array(
-                'slug'  => 'failed',
-                'label' => esc_html__('Failed Transactions', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-    /**
-     * _set_transaction_object
-     * This sets the _transaction property for the transaction details screen
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_transaction_object()
-    {
-        if ($this->_transaction instanceof EE_Transaction) {
-            return;
-        } //get out we've already set the object
-
-        $TXN_ID = ! empty($this->_req_data['TXN_ID'])
-            ? absint($this->_req_data['TXN_ID'])
-            : false;
-
-        // get transaction object
-        $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $this->_session = $this->_transaction instanceof EE_Transaction
-            ? $this->_transaction->get('TXN_session_data')
-            : null;
-        if ($this->_transaction instanceof EE_Transaction) {
-            $this->_transaction->verify_abandoned_transaction_status();
-        }
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
-                    'event_espresso'
-                ),
-                $TXN_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     *    _transaction_legend_items
-     *
-     * @access protected
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _transaction_legend_items()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $items = array();
-
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (is_array($related_for_icon)
-                && isset($related_for_icon['css_class'], $related_for_icon['label'])
-            ) {
-                $items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-
-        $items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
-            array_merge(
-                $items,
-                array(
-                    'view_details'          => array(
-                        'class' => 'dashicons dashicons-cart',
-                        'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-                    ),
-                    'view_invoice'          => array(
-                        'class' => 'dashicons dashicons-media-spreadsheet',
-                        'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-                    ),
-                    'view_receipt'          => array(
-                        'class' => 'dashicons dashicons-media-default',
-                        'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
-                    ),
-                    'view_registration'     => array(
-                        'class' => 'dashicons dashicons-clipboard',
-                        'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-                    ),
-                    'payment_overview_link' => array(
-                        'class' => 'dashicons dashicons-money',
-                        'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
-                    ),
-                )
-            )
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_transactions_send_payment_reminder'
-        )) {
-            if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
-                $items['send_payment_reminder'] = array(
-                    'class' => 'dashicons dashicons-email-alt',
-                    'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
-                );
-            } else {
-                $items['blank*'] = array(
-                    'class' => '',
-                    'desc'  => '',
-                );
-            }
-        } else {
-            $items['blank*'] = array(
-                'class' => '',
-                'desc'  => '',
-            );
-        }
-        $more_items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
-            array(
-                'overpaid'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::overpaid_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'complete'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::complete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'incomplete' => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::incomplete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'abandoned'  => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::abandoned_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'failed'     => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::failed_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-            )
-        );
-
-        return array_merge($items, $more_items);
-    }
-
-
-    /**
-     *    _transactions_overview_list_table
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _transactions_overview_list_table()
-    {
-        $this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
-        $event = isset($this->_req_data['EVT_ID'])
-            ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID'])
-            : null;
-        $this->_template_args['admin_page_header'] = $event instanceof EE_Event
-            ? sprintf(
-                esc_html__(
-                    '%sViewing Transactions for the Event: %s%s',
-                    'event_espresso'
-                ),
-                '<h3>',
-                '<a href="'
-                . EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'edit', 'post' => $event->ID()),
-                    EVENTS_ADMIN_URL
-                )
-                . '" title="'
-                . esc_attr__(
-                    'Click to Edit event',
-                    'event_espresso'
-                )
-                . '">' . $event->get('EVT_name') . '</a>',
-                '</h3>'
-            )
-            : '';
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *    _transaction_details
-     * generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details()
-    {
-        do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
-
-        $this->_set_transaction_status_array();
-
-        $this->_template_args = array();
-        $this->_template_args['transactions_page'] = $this->_wp_page_slug;
-
-        $this->_set_transaction_object();
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            return;
-        }
-        $primary_registration = $this->_transaction->primary_registration();
-        $attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : null;
-
-        $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
-        $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
-
-        $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
-        $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
-
-        $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->get('STS_ID') ];
-        $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
-
-        $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
-        $this->_template_args['total_paid'] = $this->_transaction->get('TXN_paid');
-
-        $amount_due = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid');
-        $this->_template_args['amount_due'] = EEH_Template::format_currency(
-            $amount_due,
-            true
-        );
-        if (EE_Registry::instance()->CFG->currency->sign_b4) {
-            $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign
-                                                  . $this->_template_args['amount_due'];
-        } else {
-            $this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign;
-        }
-        $this->_template_args['amount_due_class'] = '';
-
-        if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) {
-            // paid in full
-            $this->_template_args['amount_due'] = false;
-        } elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) {
-            // overpaid
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif ($this->_transaction->get('TXN_total') > 0
-                  && $this->_transaction->get('TXN_paid') > 0
-        ) {
-            // monies owing
-            $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn';
-        } elseif ($this->_transaction->get('TXN_total') > 0
-                  && $this->_transaction->get('TXN_paid') == 0
-        ) {
-            // no payments made yet
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif ($this->_transaction->get('TXN_total') == 0) {
-            // free event
-            $this->_template_args['amount_due'] = false;
-        }
-
-        $payment_method = $this->_transaction->payment_method();
-
-        $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        // link back to overview
-        $this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER'])
-            ? $_SERVER['HTTP_REFERER']
-            : TXN_ADMIN_URL;
-
-
-        // next link
-        $next_txn = $this->_transaction->next(
-            null,
-            array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
-            'TXN_ID'
-        );
-        $this->_template_args['next_transaction'] = $next_txn
-            ? $this->_next_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']),
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-right ee-icon-size-22'
-            )
-            : '';
-        // previous link
-        $previous_txn = $this->_transaction->previous(
-            null,
-            array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
-            'TXN_ID'
-        );
-        $this->_template_args['previous_transaction'] = $previous_txn
-            ? $this->_previous_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']),
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-left ee-icon-size-22'
-            )
-            : '';
-
-        // were we just redirected here after adding a new registration ???
-        if (isset(
-            $this->_req_data['redirect_from'],
-            $this->_req_data['EVT_ID'],
-            $this->_req_data['event_name']
-        )) {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $this->_req_data['EVT_ID']
-            )) {
-                $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="';
-                $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'new_registration',
-                        'return'   => 'default',
-                        'TXN_ID'   => $this->_transaction->ID(),
-                        'event_id' => $this->_req_data['EVT_ID'],
-                    ),
-                    REG_ADMIN_URL
-                );
-                $this->_admin_page_title .= '">';
-
-                $this->_admin_page_title .= sprintf(
-                    esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
-                    htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8')
-                );
-                $this->_admin_page_title .= '</a>';
-            }
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // grab messages at the last second
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        // path to template
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
-        $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _transaction_details_metaboxes
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details_metaboxes()
-    {
-
-        $this->_set_transaction_object();
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            return;
-        }
-        add_meta_box(
-            'edit-txn-details-mbox',
-            esc_html__('Transaction Details', 'event_espresso'),
-            array($this, 'txn_details_meta_box'),
-            $this->_wp_page_slug,
-            'normal',
-            'high'
-        );
-        add_meta_box(
-            'edit-txn-attendees-mbox',
-            esc_html__('Attendees Registered in this Transaction', 'event_espresso'),
-            array($this, 'txn_attendees_meta_box'),
-            $this->_wp_page_slug,
-            'normal',
-            'high',
-            array('TXN_ID' => $this->_transaction->ID())
-        );
-        add_meta_box(
-            'edit-txn-registrant-mbox',
-            esc_html__('Primary Contact', 'event_espresso'),
-            array($this, 'txn_registrant_side_meta_box'),
-            $this->_wp_page_slug,
-            'side',
-            'high'
-        );
-        add_meta_box(
-            'edit-txn-billing-info-mbox',
-            esc_html__('Billing Information', 'event_espresso'),
-            array($this, 'txn_billing_info_side_meta_box'),
-            $this->_wp_page_slug,
-            'side',
-            'high'
-        );
-    }
-
-
-    /**
-     * Callback for transaction actions metabox.
-     *
-     * @param EE_Transaction|null $transaction
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function getActionButtons(EE_Transaction $transaction = null)
-    {
-        $content = '';
-        $actions = array();
-        if (! $transaction instanceof EE_Transaction) {
-            return $content;
-        }
-        /** @var EE_Registration $primary_registration */
-        $primary_registration = $transaction->primary_registration();
-        $attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : null;
-
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $actions['payment_reminder'] =
-                EEH_MSG_Template::is_mt_active('payment_reminder')
-                && $this->_transaction->get('STS_ID') !== EEM_Transaction::complete_status_code
-                && $this->_transaction->get('STS_ID') !== EEM_Transaction::overpaid_status_code
-                    ? EEH_Template::get_button_or_link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action'      => 'send_payment_reminder',
-                                'TXN_ID'      => $this->_transaction->ID(),
-                                'redirect_to' => 'view_transaction',
-                            ),
-                            TXN_ADMIN_URL
-                        ),
-                        esc_html__(' Send Payment Reminder', 'event_espresso'),
-                        'button secondary-button',
-                        'dashicons dashicons-email-alt'
-                    )
-                    : '';
-        }
-
-        if ($primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('receipt')
-        ) {
-            $actions['receipt'] = EEH_Template::get_button_or_link(
-                $primary_registration->receipt_url(),
-                esc_html__('View Receipt', 'event_espresso'),
-                'button secondary-button',
-                'dashicons dashicons-media-default'
-            );
-        }
-
-        if ($primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('invoice')
-        ) {
-            $actions['invoice'] = EEH_Template::get_button_or_link(
-                $primary_registration->invoice_url(),
-                esc_html__('View Invoice', 'event_espresso'),
-                'button secondary-button',
-                'dashicons dashicons-media-spreadsheet'
-            );
-        }
-        $actions = array_filter(
-            apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
-        );
-        if ($actions) {
-            $content = '<ul>';
-            $content .= '<li>' . implode('</li><li>', $actions) . '</li>';
-            $content .= '</uL>';
-        }
-        return $content;
-    }
-
-
-    /**
-     * txn_details_meta_box
-     * generates HTML for the Transaction main meta box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function txn_details_meta_box()
-    {
-        $this->_set_transaction_object();
-        $this->_template_args['TXN_ID'] = $this->_transaction->ID();
-        $this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration
-            ? $this->_transaction->primary_registration()->attendee()
-            : null;
-        $this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        $this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-
-        // get line table
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display(
-            'admin_table',
-            'EE_Admin_Table_Line_Item_Display_Strategy'
-        );
-        $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
-            $this->_transaction->total_line_item()
-        );
-        $this->_template_args['REG_code'] = $this->_transaction->get_first_related('Registration')
-                                                               ->get('REG_code');
-
-        // process taxes
-        $taxes = $this->_transaction->get_many_related(
-            'Line_Item',
-            array(array('LIN_type' => EEM_Line_Item::type_tax))
-        );
-        $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
-
-        $this->_template_args['grand_total'] = EEH_Template::format_currency(
-            $this->_transaction->get('TXN_total'),
-            false,
-            false
-        );
-        $this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total');
-        $this->_template_args['TXN_status'] = $this->_transaction->get('STS_ID');
-
-        // process payment details
-        $payments = $this->_transaction->get_many_related('Payment');
-        if (! empty($payments)) {
-            $this->_template_args['payments'] = $payments;
-            $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
-        } else {
-            $this->_template_args['payments'] = false;
-            $this->_template_args['existing_reg_payments'] = array();
-        }
-
-        $this->_template_args['edit_payment_url'] = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL);
-        $this->_template_args['delete_payment_url'] = add_query_arg(
-            array('action' => 'espresso_delete_payment'),
-            TXN_ADMIN_URL
-        );
-
-        if (isset($txn_details['invoice_number'])) {
-            $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
-            $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
-                'Invoice Number',
-                'event_espresso'
-            );
-        }
-
-        $this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction
-            ->get_first_related('Registration')
-            ->get('REG_session');
-        $this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address'])
-            ? $this->_session['ip_address']
-            : '';
-        $this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
-            'Transaction placed from IP',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent'])
-            ? $this->_session['user_agent']
-            : '';
-        $this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
-            'Registrant User Agent',
-            'event_espresso'
-        );
-
-        $reg_steps = '<ul>';
-        foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
-            if ($reg_step_status === true) {
-                $reg_steps .= '<li style="color:#70cc50">'
-                              . sprintf(
-                                  esc_html__('%1$s : Completed', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</li>';
-            } elseif (is_numeric($reg_step_status) && $reg_step_status !== false) {
-                $reg_steps .= '<li style="color:#2EA2CC">'
-                              . sprintf(
-                                  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step)),
-                                  date(
-                                      get_option('date_format') . ' ' . get_option('time_format'),
-                                      ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS))
-                                  )
-                              )
-                              . '</li>';
-            } else {
-                $reg_steps .= '<li style="color:#E76700">'
-                              . sprintf(
-                                  esc_html__('%1$s : Never Initiated', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</li>';
-            }
-        }
-        $reg_steps .= '</ul>';
-        $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
-        $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
-            'Registration Step Progress',
-            'event_espresso'
-        );
-
-
-        $this->_get_registrations_to_apply_payment_to();
-        $this->_get_payment_methods($payments);
-        $this->_get_payment_status_array();
-        $this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction.
-
-        $this->_template_args['transaction_form_url'] = add_query_arg(
-            array(
-                'action'  => 'edit_transaction',
-                'process' => 'transaction',
-            ),
-            TXN_ADMIN_URL
-        );
-        $this->_template_args['apply_payment_form_url'] = add_query_arg(
-            array(
-                'page'   => 'espresso_transactions',
-                'action' => 'espresso_apply_payment',
-            ),
-            WP_AJAX_URL
-        );
-        $this->_template_args['delete_payment_form_url'] = add_query_arg(
-            array(
-                'page'   => 'espresso_transactions',
-                'action' => 'espresso_delete_payment',
-            ),
-            WP_AJAX_URL
-        );
-
-        $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
-
-        // 'espresso_delete_payment_nonce'
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * _get_registration_payment_IDs
-     *    generates an array of Payment IDs and their corresponding Registration IDs
-     *
-     * @access protected
-     * @param EE_Payment[] $payments
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_registration_payment_IDs($payments = array())
-    {
-        $existing_reg_payments = array();
-        // get all reg payments for these payments
-        $reg_payments = EEM_Registration_Payment::instance()->get_all(
-            array(
-                array(
-                    'PAY_ID' => array(
-                        'IN',
-                        array_keys($payments),
-                    ),
-                ),
-            )
-        );
-        if (! empty($reg_payments)) {
-            foreach ($payments as $payment) {
-                if (! $payment instanceof EE_Payment) {
-                    continue;
-                } elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
-                    $existing_reg_payments[ $payment->ID() ] = array();
-                }
-                foreach ($reg_payments as $reg_payment) {
-                    if ($reg_payment instanceof EE_Registration_Payment
-                        && $reg_payment->payment_ID() === $payment->ID()
-                    ) {
-                        $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
-                    }
-                }
-            }
-        }
-
-        return $existing_reg_payments;
-    }
-
-
-    /**
-     * _get_registrations_to_apply_payment_to
-     *    generates HTML for displaying a series of checkboxes in the admin payment modal window
-     * which allows the admin to only apply the payment to the specific registrations
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _get_registrations_to_apply_payment_to()
-    {
-        // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params = array(
-            array(
-                'STS_ID' => array(
-                    'IN',
-                    array(
-                        EEM_Registration::status_id_approved,
-                        EEM_Registration::status_id_pending_payment,
-                        EEM_Registration::status_id_not_approved,
-                    ),
-                ),
-            ),
-        );
-        $registrations_to_apply_payment_to = EEH_HTML::br()
-                                             . EEH_HTML::div(
-                                                 '',
-                                                 'txn-admin-apply-payment-to-registrations-dv',
-                                                 '',
-                                                 'clear: both; margin: 1.5em 0 0; display: none;'
-                                             );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
-        $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
-        $registrations_to_apply_payment_to .= EEH_HTML::thead(
-            EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
-            )
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::tbody();
-        // get registrations for TXN
-        $registrations = $this->_transaction->registrations($query_params);
-        $existing_reg_payments = $this->_template_args['existing_reg_payments'];
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $attendee_name = $registration->attendee() instanceof EE_Attendee
-                    ? $registration->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $owing = $registration->final_price() - $registration->paid();
-                $taxable = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
-                    : '';
-                $checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
-                    ? ' checked="checked"'
-                    : '';
-                $disabled = $registration->final_price() > 0 ? '' : ' disabled';
-                $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
-                    EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
-                    EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
-                        . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
-                        '',
-                        'jst-cntr'
-                    ),
-                    'apply-payment-registration-row-' . $registration->ID()
-                );
-            }
-        }
-        $registrations_to_apply_payment_to .= EEH_HTML::tbodyx();
-        $registrations_to_apply_payment_to .= EEH_HTML::tablex();
-        $registrations_to_apply_payment_to .= EEH_HTML::divx();
-        $registrations_to_apply_payment_to .= EEH_HTML::p(
-            esc_html__(
-                'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
-                'event_espresso'
-            ),
-            '',
-            'clear description'
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::divx();
-        $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
-    }
-
-
-    /**
-     * _get_reg_status_selection
-     *
-     * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
-     *         instead of events.
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _get_reg_status_selection()
-    {
-        // first get all possible statuses
-        $statuses = EEM_Registration::reg_status_array(array(), true);
-        // let's add a "don't change" option.
-        $status_array['NAN'] = esc_html__('Leave the Same', 'event_espresso');
-        $status_array = array_merge($status_array, $statuses);
-        $this->_template_args['status_change_select'] = EEH_Form_Fields::select_input(
-            'txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'id="txn-admin-payment-reg-status-inp"',
-            'txn-reg-status-change-reg-status'
-        );
-        $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
-            'delete_txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'delete-txn-admin-payment-reg-status-inp',
-            'delete-txn-reg-status-change-reg-status'
-        );
-    }
-
-
-    /**
-     *    _get_payment_methods
-     * Gets all the payment methods available generally, or the ones that are already
-     * selected on these payments (in case their payment methods are no longer active).
-     * Has the side-effect of updating the template args' payment_methods item
-     *
-     * @access private
-     * @param EE_Payment[] to show on this page
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _get_payment_methods($payments = array())
-    {
-        $payment_methods_of_payments = array();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment) {
-                $payment_methods_of_payments[] = $payment->get('PMD_ID');
-            }
-        }
-        if ($payment_methods_of_payments) {
-            $query_args = array(
-                array(
-                    'OR*payment_method_for_payment' => array(
-                        'PMD_ID'    => array('IN', $payment_methods_of_payments),
-                        'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'),
-                    ),
-                ),
-            );
-        } else {
-            $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
-        }
-        $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
-    }
-
-
-    /**
-     * txn_attendees_meta_box
-     *    generates HTML for the Attendees Transaction main meta box
-     *
-     * @access public
-     * @param WP_Post $post
-     * @param array   $metabox
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function txn_attendees_meta_box($post, $metabox = array('args' => array()))
-    {
-
-        /** @noinspection NonSecureExtractUsageInspection */
-        extract($metabox['args']);
-        $this->_template_args['post'] = $post;
-        $this->_template_args['event_attendees'] = array();
-        // process items in cart
-        $line_items = $this->_transaction->get_many_related(
-            'Line_Item',
-            array(array('LIN_type' => 'line-item'))
-        );
-        if (! empty($line_items)) {
-            foreach ($line_items as $item) {
-                if ($item instanceof EE_Line_Item) {
-                    switch ($item->OBJ_type()) {
-                        case 'Event':
-                            break;
-                        case 'Ticket':
-                            $ticket = $item->ticket();
-                            // right now we're only handling tickets here.
-                            // Cause its expected that only tickets will have attendees right?
-                            if (! $ticket instanceof EE_Ticket) {
-                                continue;
-                            }
-                            try {
-                                $event_name = $ticket->get_event_name();
-                            } catch (Exception $e) {
-                                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                                $event_name = esc_html__('Unknown Event', 'event_espresso');
-                            }
-                            $event_name .= ' - ' . $item->get('LIN_name');
-                            $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
-                            // now get all of the registrations for this transaction that use this ticket
-                            $registrations = $ticket->get_many_related(
-                                'Registration',
-                                array(array('TXN_ID' => $this->_transaction->ID()))
-                            );
-                            foreach ($registrations as $registration) {
-                                if (! $registration instanceof EE_Registration) {
-                                    continue;
-                                }
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
-                                    = $registration->status_ID();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
-                                    = $registration->count();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
-                                    = $event_name;
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
-                                    = $ticket_price;
-                                // attendee info
-                                $attendee = $registration->get_first_related('Attendee');
-                                if ($attendee instanceof EE_Attendee) {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
-                                        = $attendee->ID();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
-                                        = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']
-                                        = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
-                                          . esc_html__(
-                                              ' Event',
-                                              'event_espresso'
-                                          )
-                                          . '">' . $attendee->email() . '</a>';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']
-                                        = EEH_Address::format($attendee, 'inline', false, false);
-                                } else {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address'] = '';
-                                }
-                            }
-                            break;
-                    }
-                }
-            }
-
-            $this->_template_args['transaction_form_url'] = add_query_arg(
-                array(
-                    'action'  => 'edit_transaction',
-                    'process' => 'attendees',
-                ),
-                TXN_ADMIN_URL
-            );
-            echo EEH_Template::display_template(
-                TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
-                $this->_template_args,
-                true
-            );
-        } else {
-            echo sprintf(
-                esc_html__(
-                    '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
-                    'event_espresso'
-                ),
-                '<p class="important-notice">',
-                '</p>'
-            );
-        }
-    }
-
-
-    /**
-     * txn_registrant_side_meta_box
-     * generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_registrant_side_meta_box()
-    {
-        $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
-            ? $this->_transaction->primary_registration()->get_first_related('Attendee')
-            : null;
-        if (! $primary_att instanceof EE_Attendee) {
-            $this->_template_args['no_attendee_message'] = esc_html__(
-                'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
-                'event_espresso'
-            );
-            $primary_att = EEM_Attendee::instance()->create_default_object();
-        }
-        $this->_template_args['ATT_ID'] = $primary_att->ID();
-        $this->_template_args['prime_reg_fname'] = $primary_att->fname();
-        $this->_template_args['prime_reg_lname'] = $primary_att->lname();
-        $this->_template_args['prime_reg_email'] = $primary_att->email();
-        $this->_template_args['prime_reg_phone'] = $primary_att->phone();
-        $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'edit_attendee',
-                'post'   => $primary_att->ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        // get formatted address for registrant
-        $this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
-        echo EEH_Template::display_template(
-            TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * txn_billing_info_side_meta_box
-     *    generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function txn_billing_info_side_meta_box()
-    {
-
-        $this->_template_args['billing_form'] = $this->_transaction->billing_info();
-        $this->_template_args['billing_form_url'] = add_query_arg(
-            array('action' => 'edit_transaction', 'process' => 'billing'),
-            TXN_ADMIN_URL
-        );
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
-    }
-
-
-    /**
-     * apply_payments_or_refunds
-     *    registers a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function apply_payments_or_refunds()
-    {
-        $json_response_data = array('return_data' => false);
-        $valid_data = $this->_validate_payment_request_data();
-        $has_access = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        if (! empty($valid_data) && $has_access) {
-            $PAY_ID = $valid_data['PAY_ID'];
-            // save  the new payment
-            $payment = $this->_create_payment_from_request_data($valid_data);
-            // get the TXN for this payment
-            $transaction = $payment->transaction();
-            // verify transaction
-            if ($transaction instanceof EE_Transaction) {
-                // calculate_total_payments_and_update_status
-                $this->_process_transaction_payments($transaction);
-                $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
-                $this->_remove_existing_registration_payments($payment, $PAY_ID);
-                // apply payment to registrations (if applicable)
-                if (! empty($REG_IDs)) {
-                    $this->_update_registration_payments($transaction, $payment, $REG_IDs);
-                    $this->_maybe_send_notifications();
-                    // now process status changes for the same registrations
-                    $this->_process_registration_status_change($transaction, $REG_IDs);
-                }
-                $this->_maybe_send_notifications($payment);
-                // prepare to render page
-                $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs);
-                do_action(
-                    'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
-                    $transaction,
-                    $payment
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Transaction for this payment could not be retrieved.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            if ($has_access) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The payment form data could not be processed. Please try again.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'You do not have access to apply payments or refunds to a registration.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $notices = EE_Error::get_notices(
-            false,
-            false,
-            false
-        );
-        $this->_template_args = array(
-            'data'    => $json_response_data,
-            'error'   => $notices['errors'],
-            'success' => $notices['success'],
-        );
-        $this->_return_json();
-    }
-
-
-    /**
-     * _validate_payment_request_data
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _validate_payment_request_data()
-    {
-        if (! isset($this->_req_data['txn_admin_payment'])) {
-            return false;
-        }
-        $payment_form = $this->_generate_payment_form_section();
-        try {
-            if ($payment_form->was_submitted()) {
-                $payment_form->receive_form_submission();
-                if (! $payment_form->is_valid()) {
-                    $submission_error_messages = array();
-                    foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
-                        if ($validation_error instanceof EE_Validation_Error) {
-                            $submission_error_messages[] = sprintf(
-                                _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
-                                $validation_error->get_form_section()->html_label_text(),
-                                $validation_error->getMessage()
-                            );
-                        }
-                    }
-                    EE_Error::add_error(
-                        implode('<br />', $submission_error_messages),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-
-                    return array();
-                }
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-
-            return array();
-        }
-
-        return $payment_form->valid_data();
-    }
-
-
-    /**
-     * _generate_payment_form_section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _generate_payment_form_section()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'        => 'txn_admin_payment',
-                'subsections' => array(
-                    'PAY_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'TXN_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'type'            => new EE_Text_Input(
-                        array(
-                            'default'               => 1,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'amount'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Float_Normalization()),
-                        )
-                    ),
-                    'status'          => new EE_Text_Input(
-                        array(
-                            'default'         => EEM_Payment::status_id_approved,
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment status', 'event_espresso'),
-                        )
-                    ),
-                    'PMD_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 2,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'date'            => new EE_Text_Input(
-                        array(
-                            'default'         => time(),
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment date', 'event_espresso'),
-                        )
-                    ),
-                    'txn_id_chq_nmbr' => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ),
-                        )
-                    ),
-                    'po_number'       => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ),
-                        )
-                    ),
-                    'accounting'      => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ),
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _create_payment_from_request_data
-     *
-     * @param array $valid_data
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    protected function _create_payment_from_request_data($valid_data)
-    {
-        $PAY_ID = $valid_data['PAY_ID'];
-        // get payment amount
-        $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
-        // payments have a type value of 1 and refunds have a type value of -1
-        // so multiplying amount by type will give a positive value for payments, and negative values for refunds
-        $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
-        // for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
-        $date = $valid_data['date']
-            ? preg_replace('/\s+/', ' ', $valid_data['date'])
-            : date('Y-m-d g:i a', current_time('timestamp'));
-        $payment = EE_Payment::new_instance(
-            array(
-                'TXN_ID'              => $valid_data['TXN_ID'],
-                'STS_ID'              => $valid_data['status'],
-                'PAY_timestamp'       => $date,
-                'PAY_source'          => EEM_Payment_Method::scope_admin,
-                'PMD_ID'              => $valid_data['PMD_ID'],
-                'PAY_amount'          => $amount,
-                'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
-                'PAY_po_number'       => $valid_data['po_number'],
-                'PAY_extra_accntng'   => $valid_data['accounting'],
-                'PAY_details'         => $valid_data,
-                'PAY_ID'              => $PAY_ID,
-            ),
-            '',
-            array('Y-m-d', 'g:i a')
-        );
-
-        if (! $payment->save()) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
-                    $payment->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * _process_transaction_payments
-     *
-     * @param \EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_transaction_payments(EE_Transaction $transaction)
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        // update the transaction with this payment
-        if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_success(
-                esc_html__(
-                    'The payment has been processed successfully.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'The payment was processed successfully but the amount paid for the transaction was not updated.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _get_REG_IDs_to_apply_payment_to
-     * returns a list of registration IDs that the payment will apply to
-     *
-     * @param \EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
-    {
-        $REG_IDs = array();
-        // grab array of IDs for specific registrations to apply changes to
-        if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
-            $REG_IDs = (array) $this->_req_data['txn_admin_payment']['registrations'];
-        }
-        // nothing specified ? then get all reg IDs
-        if (empty($REG_IDs)) {
-            $registrations = $payment->transaction()->registrations();
-            $REG_IDs = ! empty($registrations)
-                ? array_keys($registrations)
-                : $this->_get_existing_reg_payment_REG_IDs($payment);
-        }
-
-        // ensure that REG_IDs are integers and NOT strings
-        return array_map('intval', $REG_IDs);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function existing_reg_payment_REG_IDs()
-    {
-        return $this->_existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * @param array $existing_reg_payment_REG_IDs
-     */
-    public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
-    {
-        $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * _get_existing_reg_payment_REG_IDs
-     * returns a list of registration IDs that the payment is currently related to
-     * as recorded in the database
-     *
-     * @param \EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
-    {
-        if ($this->existing_reg_payment_REG_IDs() === null) {
-            // let's get any existing reg payment records for this payment
-            $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
-            // but we only want the REG IDs, so grab the array keys
-            $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
-                ? array_keys($existing_reg_payment_REG_IDs)
-                : array();
-            $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
-        }
-
-        return $this->existing_reg_payment_REG_IDs();
-    }
-
-
-    /**
-     * _remove_existing_registration_payments
-     * this calculates the difference between existing relations
-     * to the supplied payment and the new list registration IDs,
-     * removes any related registrations that no longer apply,
-     * and then updates the registration paid fields
-     *
-     * @param \EE_Payment $payment
-     * @param int         $PAY_ID
-     * @return bool;
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
-    {
-        // newly created payments will have nothing recorded for $PAY_ID
-        if ($PAY_ID == 0) {
-            return false;
-        }
-        $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-        if (empty($existing_reg_payment_REG_IDs)) {
-            return false;
-        }
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-
-        return $transaction_payments->delete_registration_payments_and_update_registrations(
-            $payment,
-            array(
-                array(
-                    'PAY_ID' => $payment->ID(),
-                    'REG_ID' => array('IN', $existing_reg_payment_REG_IDs),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _update_registration_payments
-     * this applies the payments to the selected registrations
-     * but only if they have not already been paid for
-     *
-     * @param  EE_Transaction $transaction
-     * @param \EE_Payment     $payment
-     * @param array           $REG_IDs
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $REG_IDs = array()
-    ) {
-        // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
-        // so let's do that using our set of REG_IDs from the form
-        $registration_query_where_params = array(
-            'REG_ID' => array('IN', $REG_IDs),
-        );
-        // but add in some conditions regarding payment,
-        // so that we don't apply payments to registrations that are free or have already been paid for
-        // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if (! $payment->is_a_refund()) {
-            $registration_query_where_params['REG_final_price'] = array('!=', 0);
-            $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
-        }
-        $registrations = $transaction->registrations(array($registration_query_where_params));
-        if (! empty($registrations)) {
-            /** @type EE_Payment_Processor $payment_processor */
-            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-            $payment_processor->process_registration_payments($transaction, $payment, $registrations);
-        }
-    }
-
-
-    /**
-     * _process_registration_status_change
-     * This processes requested registration status changes for all the registrations
-     * on a given transaction and (optionally) sends out notifications for the changes.
-     *
-     * @param  EE_Transaction $transaction
-     * @param array           $REG_IDs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array())
-    {
-        // first if there is no change in status then we get out.
-        if (! isset($this->_req_data['txn_reg_status_change']['reg_status'])
-            || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN'
-        ) {
-            // no error message, no change requested, just nothing to do man.
-            return false;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        // made it here dude?  Oh WOW.  K, let's take care of changing the statuses
-        return $transaction_processor->manually_update_registration_statuses(
-            $transaction,
-            sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']),
-            array(array('REG_ID' => array('IN', $REG_IDs)))
-        );
-    }
-
-
-    /**
-     * _build_payment_json_response
-     *
-     * @access public
-     * @param \EE_Payment $payment
-     * @param array       $REG_IDs
-     * @param bool | null $delete_txn_reg_status_change
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _build_payment_json_response(
-        EE_Payment $payment,
-        $REG_IDs = array(),
-        $delete_txn_reg_status_change = null
-    ) {
-        // was the payment deleted ?
-        if (is_bool($delete_txn_reg_status_change)) {
-            return array(
-                'PAY_ID'                       => $payment->ID(),
-                'amount'                       => $payment->amount(),
-                'total_paid'                   => $payment->transaction()->paid(),
-                'txn_status'                   => $payment->transaction()->status_ID(),
-                'pay_status'                   => $payment->STS_ID(),
-                'registrations'                => $this->_registration_payment_data_array($REG_IDs),
-                'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
-            );
-        } else {
-            $this->_get_payment_status_array();
-
-            return array(
-                'amount'           => $payment->amount(),
-                'total_paid'       => $payment->transaction()->paid(),
-                'txn_status'       => $payment->transaction()->status_ID(),
-                'pay_status'       => $payment->STS_ID(),
-                'PAY_ID'           => $payment->ID(),
-                'STS_ID'           => $payment->STS_ID(),
-                'status'           => self::$_pay_status[ $payment->STS_ID() ],
-                'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
-                'method'           => strtoupper($payment->source()),
-                'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
-                'gateway'          => $payment->payment_method()
-                    ? $payment->payment_method()->admin_name()
-                    : esc_html__("Unknown", 'event_espresso'),
-                'gateway_response' => $payment->gateway_response(),
-                'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
-                'po_number'        => $payment->po_number(),
-                'extra_accntng'    => $payment->extra_accntng(),
-                'registrations'    => $this->_registration_payment_data_array($REG_IDs),
-            );
-        }
-    }
-
-
-    /**
-     * delete_payment
-     *    delete a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_payment()
-    {
-        $json_response_data = array('return_data' => false);
-        $PAY_ID = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
-            ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
-            : 0;
-        $can_delete = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-        if ($PAY_ID && $can_delete) {
-            $delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change'])
-                ? $this->_req_data['delete_txn_reg_status_change']
-                : false;
-            $payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            if ($payment instanceof EE_Payment) {
-                $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
-                    $json_response_data['return_data'] = $this->_build_payment_json_response(
-                        $payment,
-                        $REG_IDs,
-                        $delete_txn_reg_status_change
-                    );
-                    if ($delete_txn_reg_status_change) {
-                        $this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change;
-                        // MAKE sure we also add the delete_txn_req_status_change to the
-                        // $_REQUEST global because that's how messages will be looking for it.
-                        $_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change;
-                        $this->_maybe_send_notifications();
-                        $this->_process_registration_status_change($payment->transaction(), $REG_IDs);
-                    }
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            if ($can_delete) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Payment ID was not received, therefore payment form data could not be loaded.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'You do not have access to delete a payment.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $notices = EE_Error::get_notices(false, false, false);
-        $this->_template_args = array(
-            'data'      => $json_response_data,
-            'success'   => $notices['success'],
-            'error'     => $notices['errors'],
-            'attention' => $notices['attention'],
-        );
-        $this->_return_json();
-    }
-
-
-    /**
-     * _registration_payment_data_array
-     * adds info for 'owing' and 'paid' for each registration to the json response
-     *
-     * @access protected
-     * @param array $REG_IDs
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _registration_payment_data_array($REG_IDs)
-    {
-        $registration_payment_data = array();
-        // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if (! empty($REG_IDs)) {
-            $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration_payment_data[ $registration->ID() ] = array(
-                        'paid'  => $registration->pretty_paid(),
-                        'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
-                    );
-                }
-            }
-        }
-
-        return $registration_payment_data;
-    }
-
-
-    /**
-     * _maybe_send_notifications
-     * determines whether or not the admin has indicated that notifications should be sent.
-     * If so, will toggle a filter switch for delivering registration notices.
-     * If passed an EE_Payment object, then it will trigger payment notifications instead.
-     *
-     * @access protected
-     * @param \EE_Payment | null $payment
-     */
-    protected function _maybe_send_notifications($payment = null)
-    {
-        switch ($payment instanceof EE_Payment) {
-            // payment notifications
-            case true:
-                if (isset(
-                    $this->_req_data['txn_payments'],
-                    $this->_req_data['txn_payments']['send_notifications']
-                )
-                    && filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
-                ) {
-                    $this->_process_payment_notification($payment);
-                }
-                break;
-            // registration notifications
-            case false:
-                if (isset(
-                    $this->_req_data['txn_reg_status_change'],
-                    $this->_req_data['txn_reg_status_change']['send_notifications']
-                )
-                    && filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
-                ) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                }
-                break;
-        }
-    }
-
-
-    /**
-     * _send_payment_reminder
-     *    generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _send_payment_reminder()
-    {
-        $TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false;
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $query_args = isset($this->_req_data['redirect_to']) ? array(
-            'action' => $this->_req_data['redirect_to'],
-            'TXN_ID' => $this->_req_data['TXN_ID'],
-        ) : array();
-        do_action(
-            'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            $transaction
-        );
-        $this->_redirect_after_action(
-            false,
-            esc_html__('payment reminder', 'event_espresso'),
-            esc_html__('sent', 'event_espresso'),
-            $query_args,
-            true
-        );
-    }
-
-
-    /**
-     *  get_transactions
-     *    get transactions for given parameters (used by list table)
-     *
-     * @param  int     $perpage how many transactions displayed per page
-     * @param  boolean $count   return the count or objects
-     * @param string   $view
-     * @return mixed int = count || array of transaction objects
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transactions($perpage, $count = false, $view = '')
-    {
-
-        $TXN = EEM_Transaction::instance();
-
-        $start_date = isset($this->_req_data['txn-filter-start-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
-            : date(
-                'm/d/Y',
-                strtotime('-10 year')
-            );
-        $end_date = isset($this->_req_data['txn-filter-end-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
-            : date('m/d/Y');
-
-        // make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-
-
-        // convert to timestamps
-        $start_date = strtotime($start_date);
-        $end_date = strtotime($end_date);
-
-        // makes sure start date is the lowest value and vice versa
-        $start_date = min($start_date, $end_date);
-        $end_date = max($start_date, $end_date);
-
-        // convert to correct format for query
-        $start_date = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $start_date),
-            'Y-m-d H:i:s'
-        );
-        $end_date = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $end_date),
-            'Y-m-d H:i:s'
-        );
-
-
-        // set orderby
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-
-        switch ($this->_req_data['orderby']) {
-            case 'TXN_ID':
-                $orderby = 'TXN_ID';
-                break;
-            case 'ATT_fname':
-                $orderby = 'Registration.Attendee.ATT_fname';
-                break;
-            case 'event_name':
-                $orderby = 'Registration.Event.EVT_name';
-                break;
-            default: // 'TXN_timestamp'
-                $orderby = 'TXN_timestamp';
-        }
-
-        $sort = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        $current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
-        $per_page = ! empty($perpage) ? $perpage : 10;
-        $per_page = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page;
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit = array($offset, $per_page);
-
-        $_where = array(
-            'TXN_timestamp'          => array('BETWEEN', array($start_date, $end_date)),
-            'Registration.REG_count' => 1,
-        );
-
-        if (isset($this->_req_data['EVT_ID'])) {
-            $_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID'];
-        }
-
-        if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'Registration.Event.EVT_name'         => array('LIKE', $search_string),
-                'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
-                'Registration.Event.EVT_short_desc'   => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_fname'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_lname'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_email'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_address'   => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_address2'  => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_city'      => array('LIKE', $search_string),
-                'Registration.REG_final_price'        => array('LIKE', $search_string),
-                'Registration.REG_code'               => array('LIKE', $search_string),
-                'Registration.REG_count'              => array('LIKE', $search_string),
-                'Registration.REG_group_size'         => array('LIKE', $search_string),
-                'Registration.Ticket.TKT_name'        => array('LIKE', $search_string),
-                'Registration.Ticket.TKT_description' => array('LIKE', $search_string),
-                'Payment.PAY_source'                  => array('LIKE', $search_string),
-                'Payment.Payment_Method.PMD_name'     => array('LIKE', $search_string),
-                'TXN_session_data'                    => array('LIKE', $search_string),
-                'Payment.PAY_txn_id_chq_nmbr'         => array('LIKE', $search_string),
-            );
-        }
-
-        // failed transactions
-        $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
-                  || ($count && $view === 'failed');
-        $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
-                     || ($count && $view === 'abandoned');
-
-        if ($failed) {
-            $_where['STS_ID'] = EEM_Transaction::failed_status_code;
-        } elseif ($abandoned) {
-            $_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
-        } else {
-            $_where['STS_ID'] = array('!=', EEM_Transaction::failed_status_code);
-            $_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code);
-        }
-
-        $query_params = array(
-            $_where,
-            'order_by'                 => array($orderby => $sort),
-            'limit'                    => $limit,
-            'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
-        );
-
-        $transactions = $count
-            ? $TXN->count(array($_where), 'TXN_ID', true)
-            : $TXN->get_all($query_params);
-
-        return $transactions;
-    }
+	/**
+	 * @var EE_Transaction
+	 */
+	private $_transaction;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	/**
+	 * @var array $_txn_status
+	 */
+	private static $_txn_status;
+
+	/**
+	 * @var array $_pay_status
+	 */
+	private static $_pay_status;
+
+	/**
+	 * @var array $_existing_reg_payment_REG_IDs
+	 */
+	protected $_existing_reg_payment_REG_IDs = null;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	/**
+	 *    _init_page_props
+	 *
+	 * @return void
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug = TXN_PG_SLUG;
+		$this->page_label = esc_html__('Transactions', 'event_espresso');
+		$this->_admin_base_url = TXN_ADMIN_URL;
+		$this->_admin_base_path = TXN_ADMIN;
+	}
+
+
+	/**
+	 *    _ajax_hooks
+	 *
+	 * @return void
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds'));
+		add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds'));
+		add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment'));
+	}
+
+
+	/**
+	 *    _define_page_props
+	 *
+	 * @return void
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'buttons' => array(
+				'add'    => esc_html__('Add New Transaction', 'event_espresso'),
+				'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
+				'delete' => esc_html__('Delete Transaction', 'event_espresso'),
+			),
+		);
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _set_page_routes()
+	{
+
+		$this->_set_transaction_status_array();
+
+		$txn_id = ! empty($this->_req_data['TXN_ID'])
+				  && ! is_array($this->_req_data['TXN_ID'])
+			? $this->_req_data['TXN_ID']
+			: 0;
+
+		$this->_page_routes = array(
+
+			'default' => array(
+				'func'       => '_transactions_overview_list_table',
+				'capability' => 'ee_read_transactions',
+			),
+
+			'view_transaction' => array(
+				'func'       => '_transaction_details',
+				'capability' => 'ee_read_transaction',
+				'obj_id'     => $txn_id,
+			),
+
+			'send_payment_reminder' => array(
+				'func'       => '_send_payment_reminder',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+
+			'espresso_apply_payment' => array(
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			),
+
+			'espresso_apply_refund' => array(
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			),
+
+			'espresso_delete_payment' => array(
+				'func'       => 'delete_payment',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payments',
+			),
+
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'          => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'EE_Admin_Transactions_List_Table',
+				'help_tabs'     => array(
+					'transactions_overview_help_tab'                       => array(
+						'title'    => esc_html__('Transactions Overview', 'event_espresso'),
+						'filename' => 'transactions_overview',
+					),
+					'transactions_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
+						'filename' => 'transactions_overview_table_column_headings',
+					),
+					'transactions_overview_views_filters_help_tab'         => array(
+						'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
+						'filename' => 'transactions_overview_views_filters_search',
+					),
+				),
+				'help_tour'     => array('Transactions_Overview_Help_Tour'),
+				/**
+				 * commented out because currently we are not displaying tips for transaction list table status but this
+				 * may change in a later iteration so want to keep the code for then.
+				 */
+				// 'qtips' => array( 'Transactions_List_Table_Tips' ),
+				'require_nonce' => false,
+			),
+			'view_transaction' => array(
+				'nav'       => array(
+					'label'      => esc_html__('View Transaction', 'event_espresso'),
+					'order'      => 5,
+					'url'        => isset($this->_req_data['TXN_ID'])
+						? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				),
+				'help_tabs' => array(
+					'transactions_view_transaction_help_tab'                                              => array(
+						'title'    => esc_html__('View Transaction', 'event_espresso'),
+						'filename' => 'transactions_view_transaction',
+					),
+					'transactions_view_transaction_transaction_details_table_help_tab'                    => array(
+						'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_transaction_details_table',
+					),
+					'transactions_view_transaction_attendees_registered_help_tab'                         => array(
+						'title'    => esc_html__('Attendees Registered', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_attendees_registered',
+					),
+					'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array(
+						'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
+					),
+				),
+				'qtips'     => array('Transaction_Details_Tips'),
+				'help_tour' => array('Transaction_Details_Help_Tour'),
+				'metaboxes' => array('_transaction_details_metaboxes'),
+
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+		// noop
+	}
+
+	protected function _add_feature_pointers()
+	{
+		// noop
+	}
+
+	public function admin_init()
+	{
+		// IF a registration was JUST added via the admin...
+		if (isset(
+			$this->_req_data['redirect_from'],
+			$this->_req_data['EVT_ID'],
+			$this->_req_data['event_name']
+		)) {
+			// then set a cookie so that we can block any attempts to use
+			// the back button as a way to enter another registration.
+			setcookie(
+				'ee_registration_added',
+				$this->_req_data['EVT_ID'],
+				time() + WEEK_IN_SECONDS,
+				'/'
+			);
+			// and update the global
+			$_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID'];
+		}
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
+			'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__(
+			'An error occurred! Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['txn_status_array'] = self::$_txn_status;
+		EE_Registry::$i18n_js_strings['pay_status_array'] = self::$_pay_status;
+		EE_Registry::$i18n_js_strings['payments_total'] = esc_html__('Payments Total', 'event_espresso');
+		EE_Registry::$i18n_js_strings['transaction_overpaid'] = esc_html__(
+			'This transaction has been overpaid ! Payments Total',
+			'event_espresso'
+		);
+	}
+
+	public function admin_notices()
+	{
+		// noop
+	}
+
+	public function admin_footer_scripts()
+	{
+		// noop
+	}
+
+
+	/**
+	 * _set_transaction_status_array
+	 * sets list of transaction statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_transaction_status_array()
+	{
+		self::$_txn_status = EEM_Transaction::instance()->status_array(true);
+	}
+
+
+	/**
+	 * get_transaction_status_array
+	 * return the transaction status array for wp_list_table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_transaction_status_array()
+	{
+		return self::$_txn_status;
+	}
+
+
+	/**
+	 *    get list of payment statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_payment_status_array()
+	{
+		self::$_pay_status = EEM_Payment::instance()->status_array(true);
+		$this->_template_args['payment_status'] = self::$_pay_status;
+	}
+
+
+	/**
+	 *    _add_screen_options_default
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * load_scripts_styles
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles()
+	{
+		// enqueue style
+		wp_register_style(
+			'espresso_txn',
+			TXN_ASSETS_URL . 'espresso_transactions_admin.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_txn');
+		// scripts
+		wp_register_script(
+			'espresso_txn',
+			TXN_ASSETS_URL . 'espresso_transactions_admin.js',
+			array(
+				'ee_admin_js',
+				'ee-datepicker',
+				'jquery-ui-datepicker',
+				'jquery-ui-draggable',
+				'ee-dialog',
+				'ee-accounting',
+				'ee-serialize-full-array',
+			),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_txn');
+	}
+
+
+	/**
+	 *    load_scripts_styles_view_transaction
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_view_transaction()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    load_scripts_styles_default
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_default()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    _set_list_table_views_default
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all'       => array(
+				'slug'  => 'all',
+				'label' => esc_html__('View All Transactions', 'event_espresso'),
+				'count' => 0,
+			),
+			'abandoned' => array(
+				'slug'  => 'abandoned',
+				'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
+				'count' => 0,
+			),
+			'failed'    => array(
+				'slug'  => 'failed',
+				'label' => esc_html__('Failed Transactions', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+	/**
+	 * _set_transaction_object
+	 * This sets the _transaction property for the transaction details screen
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_transaction_object()
+	{
+		if ($this->_transaction instanceof EE_Transaction) {
+			return;
+		} //get out we've already set the object
+
+		$TXN_ID = ! empty($this->_req_data['TXN_ID'])
+			? absint($this->_req_data['TXN_ID'])
+			: false;
+
+		// get transaction object
+		$this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$this->_session = $this->_transaction instanceof EE_Transaction
+			? $this->_transaction->get('TXN_session_data')
+			: null;
+		if ($this->_transaction instanceof EE_Transaction) {
+			$this->_transaction->verify_abandoned_transaction_status();
+		}
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
+					'event_espresso'
+				),
+				$TXN_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 *    _transaction_legend_items
+	 *
+	 * @access protected
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _transaction_legend_items()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$items = array();
+
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (is_array($related_for_icon)
+				&& isset($related_for_icon['css_class'], $related_for_icon['label'])
+			) {
+				$items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+
+		$items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
+			array_merge(
+				$items,
+				array(
+					'view_details'          => array(
+						'class' => 'dashicons dashicons-cart',
+						'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+					),
+					'view_invoice'          => array(
+						'class' => 'dashicons dashicons-media-spreadsheet',
+						'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+					),
+					'view_receipt'          => array(
+						'class' => 'dashicons dashicons-media-default',
+						'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
+					),
+					'view_registration'     => array(
+						'class' => 'dashicons dashicons-clipboard',
+						'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+					),
+					'payment_overview_link' => array(
+						'class' => 'dashicons dashicons-money',
+						'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
+					),
+				)
+			)
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_transactions_send_payment_reminder'
+		)) {
+			if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
+				$items['send_payment_reminder'] = array(
+					'class' => 'dashicons dashicons-email-alt',
+					'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
+				);
+			} else {
+				$items['blank*'] = array(
+					'class' => '',
+					'desc'  => '',
+				);
+			}
+		} else {
+			$items['blank*'] = array(
+				'class' => '',
+				'desc'  => '',
+			);
+		}
+		$more_items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
+			array(
+				'overpaid'   => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::overpaid_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'complete'   => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::complete_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'incomplete' => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::incomplete_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'abandoned'  => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::abandoned_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'failed'     => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::failed_status_code,
+						false,
+						'sentence'
+					),
+				),
+			)
+		);
+
+		return array_merge($items, $more_items);
+	}
+
+
+	/**
+	 *    _transactions_overview_list_table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _transactions_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
+		$event = isset($this->_req_data['EVT_ID'])
+			? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID'])
+			: null;
+		$this->_template_args['admin_page_header'] = $event instanceof EE_Event
+			? sprintf(
+				esc_html__(
+					'%sViewing Transactions for the Event: %s%s',
+					'event_espresso'
+				),
+				'<h3>',
+				'<a href="'
+				. EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'edit', 'post' => $event->ID()),
+					EVENTS_ADMIN_URL
+				)
+				. '" title="'
+				. esc_attr__(
+					'Click to Edit event',
+					'event_espresso'
+				)
+				. '">' . $event->get('EVT_name') . '</a>',
+				'</h3>'
+			)
+			: '';
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *    _transaction_details
+	 * generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details()
+	{
+		do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
+
+		$this->_set_transaction_status_array();
+
+		$this->_template_args = array();
+		$this->_template_args['transactions_page'] = $this->_wp_page_slug;
+
+		$this->_set_transaction_object();
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			return;
+		}
+		$primary_registration = $this->_transaction->primary_registration();
+		$attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: null;
+
+		$this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
+		$this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
+
+		$this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
+		$this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
+
+		$this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->get('STS_ID') ];
+		$this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
+		$this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
+
+		$this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
+		$this->_template_args['total_paid'] = $this->_transaction->get('TXN_paid');
+
+		$amount_due = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid');
+		$this->_template_args['amount_due'] = EEH_Template::format_currency(
+			$amount_due,
+			true
+		);
+		if (EE_Registry::instance()->CFG->currency->sign_b4) {
+			$this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign
+												  . $this->_template_args['amount_due'];
+		} else {
+			$this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign;
+		}
+		$this->_template_args['amount_due_class'] = '';
+
+		if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) {
+			// paid in full
+			$this->_template_args['amount_due'] = false;
+		} elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) {
+			// overpaid
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif ($this->_transaction->get('TXN_total') > 0
+				  && $this->_transaction->get('TXN_paid') > 0
+		) {
+			// monies owing
+			$this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn';
+		} elseif ($this->_transaction->get('TXN_total') > 0
+				  && $this->_transaction->get('TXN_paid') == 0
+		) {
+			// no payments made yet
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif ($this->_transaction->get('TXN_total') == 0) {
+			// free event
+			$this->_template_args['amount_due'] = false;
+		}
+
+		$payment_method = $this->_transaction->payment_method();
+
+		$this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		// link back to overview
+		$this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER'])
+			? $_SERVER['HTTP_REFERER']
+			: TXN_ADMIN_URL;
+
+
+		// next link
+		$next_txn = $this->_transaction->next(
+			null,
+			array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
+			'TXN_ID'
+		);
+		$this->_template_args['next_transaction'] = $next_txn
+			? $this->_next_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']),
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-right ee-icon-size-22'
+			)
+			: '';
+		// previous link
+		$previous_txn = $this->_transaction->previous(
+			null,
+			array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
+			'TXN_ID'
+		);
+		$this->_template_args['previous_transaction'] = $previous_txn
+			? $this->_previous_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']),
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-left ee-icon-size-22'
+			)
+			: '';
+
+		// were we just redirected here after adding a new registration ???
+		if (isset(
+			$this->_req_data['redirect_from'],
+			$this->_req_data['EVT_ID'],
+			$this->_req_data['event_name']
+		)) {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$this->_req_data['EVT_ID']
+			)) {
+				$this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="';
+				$this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page'     => 'espresso_registrations',
+						'action'   => 'new_registration',
+						'return'   => 'default',
+						'TXN_ID'   => $this->_transaction->ID(),
+						'event_id' => $this->_req_data['EVT_ID'],
+					),
+					REG_ADMIN_URL
+				);
+				$this->_admin_page_title .= '">';
+
+				$this->_admin_page_title .= sprintf(
+					esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
+					htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8')
+				);
+				$this->_admin_page_title .= '</a>';
+			}
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// grab messages at the last second
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		// path to template
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+		$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _transaction_details_metaboxes
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details_metaboxes()
+	{
+
+		$this->_set_transaction_object();
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			return;
+		}
+		add_meta_box(
+			'edit-txn-details-mbox',
+			esc_html__('Transaction Details', 'event_espresso'),
+			array($this, 'txn_details_meta_box'),
+			$this->_wp_page_slug,
+			'normal',
+			'high'
+		);
+		add_meta_box(
+			'edit-txn-attendees-mbox',
+			esc_html__('Attendees Registered in this Transaction', 'event_espresso'),
+			array($this, 'txn_attendees_meta_box'),
+			$this->_wp_page_slug,
+			'normal',
+			'high',
+			array('TXN_ID' => $this->_transaction->ID())
+		);
+		add_meta_box(
+			'edit-txn-registrant-mbox',
+			esc_html__('Primary Contact', 'event_espresso'),
+			array($this, 'txn_registrant_side_meta_box'),
+			$this->_wp_page_slug,
+			'side',
+			'high'
+		);
+		add_meta_box(
+			'edit-txn-billing-info-mbox',
+			esc_html__('Billing Information', 'event_espresso'),
+			array($this, 'txn_billing_info_side_meta_box'),
+			$this->_wp_page_slug,
+			'side',
+			'high'
+		);
+	}
+
+
+	/**
+	 * Callback for transaction actions metabox.
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function getActionButtons(EE_Transaction $transaction = null)
+	{
+		$content = '';
+		$actions = array();
+		if (! $transaction instanceof EE_Transaction) {
+			return $content;
+		}
+		/** @var EE_Registration $primary_registration */
+		$primary_registration = $transaction->primary_registration();
+		$attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: null;
+
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$actions['payment_reminder'] =
+				EEH_MSG_Template::is_mt_active('payment_reminder')
+				&& $this->_transaction->get('STS_ID') !== EEM_Transaction::complete_status_code
+				&& $this->_transaction->get('STS_ID') !== EEM_Transaction::overpaid_status_code
+					? EEH_Template::get_button_or_link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action'      => 'send_payment_reminder',
+								'TXN_ID'      => $this->_transaction->ID(),
+								'redirect_to' => 'view_transaction',
+							),
+							TXN_ADMIN_URL
+						),
+						esc_html__(' Send Payment Reminder', 'event_espresso'),
+						'button secondary-button',
+						'dashicons dashicons-email-alt'
+					)
+					: '';
+		}
+
+		if ($primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('receipt')
+		) {
+			$actions['receipt'] = EEH_Template::get_button_or_link(
+				$primary_registration->receipt_url(),
+				esc_html__('View Receipt', 'event_espresso'),
+				'button secondary-button',
+				'dashicons dashicons-media-default'
+			);
+		}
+
+		if ($primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('invoice')
+		) {
+			$actions['invoice'] = EEH_Template::get_button_or_link(
+				$primary_registration->invoice_url(),
+				esc_html__('View Invoice', 'event_espresso'),
+				'button secondary-button',
+				'dashicons dashicons-media-spreadsheet'
+			);
+		}
+		$actions = array_filter(
+			apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
+		);
+		if ($actions) {
+			$content = '<ul>';
+			$content .= '<li>' . implode('</li><li>', $actions) . '</li>';
+			$content .= '</uL>';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * txn_details_meta_box
+	 * generates HTML for the Transaction main meta box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function txn_details_meta_box()
+	{
+		$this->_set_transaction_object();
+		$this->_template_args['TXN_ID'] = $this->_transaction->ID();
+		$this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration
+			? $this->_transaction->primary_registration()->attendee()
+			: null;
+		$this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		$this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+
+		// get line table
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display(
+			'admin_table',
+			'EE_Admin_Table_Line_Item_Display_Strategy'
+		);
+		$this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
+			$this->_transaction->total_line_item()
+		);
+		$this->_template_args['REG_code'] = $this->_transaction->get_first_related('Registration')
+															   ->get('REG_code');
+
+		// process taxes
+		$taxes = $this->_transaction->get_many_related(
+			'Line_Item',
+			array(array('LIN_type' => EEM_Line_Item::type_tax))
+		);
+		$this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
+
+		$this->_template_args['grand_total'] = EEH_Template::format_currency(
+			$this->_transaction->get('TXN_total'),
+			false,
+			false
+		);
+		$this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total');
+		$this->_template_args['TXN_status'] = $this->_transaction->get('STS_ID');
+
+		// process payment details
+		$payments = $this->_transaction->get_many_related('Payment');
+		if (! empty($payments)) {
+			$this->_template_args['payments'] = $payments;
+			$this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
+		} else {
+			$this->_template_args['payments'] = false;
+			$this->_template_args['existing_reg_payments'] = array();
+		}
+
+		$this->_template_args['edit_payment_url'] = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL);
+		$this->_template_args['delete_payment_url'] = add_query_arg(
+			array('action' => 'espresso_delete_payment'),
+			TXN_ADMIN_URL
+		);
+
+		if (isset($txn_details['invoice_number'])) {
+			$this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
+			$this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
+				'Invoice Number',
+				'event_espresso'
+			);
+		}
+
+		$this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction
+			->get_first_related('Registration')
+			->get('REG_session');
+		$this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address'])
+			? $this->_session['ip_address']
+			: '';
+		$this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
+			'Transaction placed from IP',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent'])
+			? $this->_session['user_agent']
+			: '';
+		$this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
+			'Registrant User Agent',
+			'event_espresso'
+		);
+
+		$reg_steps = '<ul>';
+		foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
+			if ($reg_step_status === true) {
+				$reg_steps .= '<li style="color:#70cc50">'
+							  . sprintf(
+								  esc_html__('%1$s : Completed', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</li>';
+			} elseif (is_numeric($reg_step_status) && $reg_step_status !== false) {
+				$reg_steps .= '<li style="color:#2EA2CC">'
+							  . sprintf(
+								  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step)),
+								  date(
+									  get_option('date_format') . ' ' . get_option('time_format'),
+									  ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS))
+								  )
+							  )
+							  . '</li>';
+			} else {
+				$reg_steps .= '<li style="color:#E76700">'
+							  . sprintf(
+								  esc_html__('%1$s : Never Initiated', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</li>';
+			}
+		}
+		$reg_steps .= '</ul>';
+		$this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
+		$this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
+			'Registration Step Progress',
+			'event_espresso'
+		);
+
+
+		$this->_get_registrations_to_apply_payment_to();
+		$this->_get_payment_methods($payments);
+		$this->_get_payment_status_array();
+		$this->_get_reg_status_selection(); // sets up the template args for the reg status array for the transaction.
+
+		$this->_template_args['transaction_form_url'] = add_query_arg(
+			array(
+				'action'  => 'edit_transaction',
+				'process' => 'transaction',
+			),
+			TXN_ADMIN_URL
+		);
+		$this->_template_args['apply_payment_form_url'] = add_query_arg(
+			array(
+				'page'   => 'espresso_transactions',
+				'action' => 'espresso_apply_payment',
+			),
+			WP_AJAX_URL
+		);
+		$this->_template_args['delete_payment_form_url'] = add_query_arg(
+			array(
+				'page'   => 'espresso_transactions',
+				'action' => 'espresso_delete_payment',
+			),
+			WP_AJAX_URL
+		);
+
+		$this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
+
+		// 'espresso_delete_payment_nonce'
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * _get_registration_payment_IDs
+	 *    generates an array of Payment IDs and their corresponding Registration IDs
+	 *
+	 * @access protected
+	 * @param EE_Payment[] $payments
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_registration_payment_IDs($payments = array())
+	{
+		$existing_reg_payments = array();
+		// get all reg payments for these payments
+		$reg_payments = EEM_Registration_Payment::instance()->get_all(
+			array(
+				array(
+					'PAY_ID' => array(
+						'IN',
+						array_keys($payments),
+					),
+				),
+			)
+		);
+		if (! empty($reg_payments)) {
+			foreach ($payments as $payment) {
+				if (! $payment instanceof EE_Payment) {
+					continue;
+				} elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
+					$existing_reg_payments[ $payment->ID() ] = array();
+				}
+				foreach ($reg_payments as $reg_payment) {
+					if ($reg_payment instanceof EE_Registration_Payment
+						&& $reg_payment->payment_ID() === $payment->ID()
+					) {
+						$existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
+					}
+				}
+			}
+		}
+
+		return $existing_reg_payments;
+	}
+
+
+	/**
+	 * _get_registrations_to_apply_payment_to
+	 *    generates HTML for displaying a series of checkboxes in the admin payment modal window
+	 * which allows the admin to only apply the payment to the specific registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _get_registrations_to_apply_payment_to()
+	{
+		// we want any registration with an active status (ie: not deleted or cancelled)
+		$query_params = array(
+			array(
+				'STS_ID' => array(
+					'IN',
+					array(
+						EEM_Registration::status_id_approved,
+						EEM_Registration::status_id_pending_payment,
+						EEM_Registration::status_id_not_approved,
+					),
+				),
+			),
+		);
+		$registrations_to_apply_payment_to = EEH_HTML::br()
+											 . EEH_HTML::div(
+												 '',
+												 'txn-admin-apply-payment-to-registrations-dv',
+												 '',
+												 'clear: both; margin: 1.5em 0 0; display: none;'
+											 );
+		$registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+		$registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
+		$registrations_to_apply_payment_to .= EEH_HTML::thead(
+			EEH_HTML::tr(
+				EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
+			)
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::tbody();
+		// get registrations for TXN
+		$registrations = $this->_transaction->registrations($query_params);
+		$existing_reg_payments = $this->_template_args['existing_reg_payments'];
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$attendee_name = $registration->attendee() instanceof EE_Attendee
+					? $registration->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$owing = $registration->final_price() - $registration->paid();
+				$taxable = $registration->ticket()->taxable()
+					? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+					: '';
+				$checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
+					? ' checked="checked"'
+					: '';
+				$disabled = $registration->final_price() > 0 ? '' : ' disabled';
+				$registrations_to_apply_payment_to .= EEH_HTML::tr(
+					EEH_HTML::td($registration->ID()) .
+					EEH_HTML::td($attendee_name) .
+					EEH_HTML::td(
+						$registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
+					) .
+					EEH_HTML::td($registration->event_name()) .
+					EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
+					EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
+					EEH_HTML::td(
+						'<input type="checkbox" value="' . $registration->ID()
+						. '" name="txn_admin_payment[registrations]"'
+						. $checked . $disabled . '>',
+						'',
+						'jst-cntr'
+					),
+					'apply-payment-registration-row-' . $registration->ID()
+				);
+			}
+		}
+		$registrations_to_apply_payment_to .= EEH_HTML::tbodyx();
+		$registrations_to_apply_payment_to .= EEH_HTML::tablex();
+		$registrations_to_apply_payment_to .= EEH_HTML::divx();
+		$registrations_to_apply_payment_to .= EEH_HTML::p(
+			esc_html__(
+				'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
+				'event_espresso'
+			),
+			'',
+			'clear description'
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::divx();
+		$this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
+	}
+
+
+	/**
+	 * _get_reg_status_selection
+	 *
+	 * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
+	 *         instead of events.
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _get_reg_status_selection()
+	{
+		// first get all possible statuses
+		$statuses = EEM_Registration::reg_status_array(array(), true);
+		// let's add a "don't change" option.
+		$status_array['NAN'] = esc_html__('Leave the Same', 'event_espresso');
+		$status_array = array_merge($status_array, $statuses);
+		$this->_template_args['status_change_select'] = EEH_Form_Fields::select_input(
+			'txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'id="txn-admin-payment-reg-status-inp"',
+			'txn-reg-status-change-reg-status'
+		);
+		$this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
+			'delete_txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'delete-txn-admin-payment-reg-status-inp',
+			'delete-txn-reg-status-change-reg-status'
+		);
+	}
+
+
+	/**
+	 *    _get_payment_methods
+	 * Gets all the payment methods available generally, or the ones that are already
+	 * selected on these payments (in case their payment methods are no longer active).
+	 * Has the side-effect of updating the template args' payment_methods item
+	 *
+	 * @access private
+	 * @param EE_Payment[] to show on this page
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _get_payment_methods($payments = array())
+	{
+		$payment_methods_of_payments = array();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment) {
+				$payment_methods_of_payments[] = $payment->get('PMD_ID');
+			}
+		}
+		if ($payment_methods_of_payments) {
+			$query_args = array(
+				array(
+					'OR*payment_method_for_payment' => array(
+						'PMD_ID'    => array('IN', $payment_methods_of_payments),
+						'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'),
+					),
+				),
+			);
+		} else {
+			$query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
+		}
+		$this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
+	}
+
+
+	/**
+	 * txn_attendees_meta_box
+	 *    generates HTML for the Attendees Transaction main meta box
+	 *
+	 * @access public
+	 * @param WP_Post $post
+	 * @param array   $metabox
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function txn_attendees_meta_box($post, $metabox = array('args' => array()))
+	{
+
+		/** @noinspection NonSecureExtractUsageInspection */
+		extract($metabox['args']);
+		$this->_template_args['post'] = $post;
+		$this->_template_args['event_attendees'] = array();
+		// process items in cart
+		$line_items = $this->_transaction->get_many_related(
+			'Line_Item',
+			array(array('LIN_type' => 'line-item'))
+		);
+		if (! empty($line_items)) {
+			foreach ($line_items as $item) {
+				if ($item instanceof EE_Line_Item) {
+					switch ($item->OBJ_type()) {
+						case 'Event':
+							break;
+						case 'Ticket':
+							$ticket = $item->ticket();
+							// right now we're only handling tickets here.
+							// Cause its expected that only tickets will have attendees right?
+							if (! $ticket instanceof EE_Ticket) {
+								continue;
+							}
+							try {
+								$event_name = $ticket->get_event_name();
+							} catch (Exception $e) {
+								EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+								$event_name = esc_html__('Unknown Event', 'event_espresso');
+							}
+							$event_name .= ' - ' . $item->get('LIN_name');
+							$ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
+							// now get all of the registrations for this transaction that use this ticket
+							$registrations = $ticket->get_many_related(
+								'Registration',
+								array(array('TXN_ID' => $this->_transaction->ID()))
+							);
+							foreach ($registrations as $registration) {
+								if (! $registration instanceof EE_Registration) {
+									continue;
+								}
+								$this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
+									= $registration->status_ID();
+								$this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
+									= $registration->count();
+								$this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
+									= $event_name;
+								$this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
+									= $ticket_price;
+								// attendee info
+								$attendee = $registration->get_first_related('Attendee');
+								if ($attendee instanceof EE_Attendee) {
+									$this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
+										= $attendee->ID();
+									$this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
+										= $attendee->full_name();
+									$this->_template_args['event_attendees'][ $registration->ID() ]['email']
+										= '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
+										  . esc_html__(
+											  ' Event',
+											  'event_espresso'
+										  )
+										  . '">' . $attendee->email() . '</a>';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['address']
+										= EEH_Address::format($attendee, 'inline', false, false);
+								} else {
+									$this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['email'] = '';
+									$this->_template_args['event_attendees'][ $registration->ID() ]['address'] = '';
+								}
+							}
+							break;
+					}
+				}
+			}
+
+			$this->_template_args['transaction_form_url'] = add_query_arg(
+				array(
+					'action'  => 'edit_transaction',
+					'process' => 'attendees',
+				),
+				TXN_ADMIN_URL
+			);
+			echo EEH_Template::display_template(
+				TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+				$this->_template_args,
+				true
+			);
+		} else {
+			echo sprintf(
+				esc_html__(
+					'%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
+					'event_espresso'
+				),
+				'<p class="important-notice">',
+				'</p>'
+			);
+		}
+	}
+
+
+	/**
+	 * txn_registrant_side_meta_box
+	 * generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_registrant_side_meta_box()
+	{
+		$primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
+			? $this->_transaction->primary_registration()->get_first_related('Attendee')
+			: null;
+		if (! $primary_att instanceof EE_Attendee) {
+			$this->_template_args['no_attendee_message'] = esc_html__(
+				'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
+				'event_espresso'
+			);
+			$primary_att = EEM_Attendee::instance()->create_default_object();
+		}
+		$this->_template_args['ATT_ID'] = $primary_att->ID();
+		$this->_template_args['prime_reg_fname'] = $primary_att->fname();
+		$this->_template_args['prime_reg_lname'] = $primary_att->lname();
+		$this->_template_args['prime_reg_email'] = $primary_att->email();
+		$this->_template_args['prime_reg_phone'] = $primary_att->phone();
+		$this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'edit_attendee',
+				'post'   => $primary_att->ID(),
+			),
+			REG_ADMIN_URL
+		);
+		// get formatted address for registrant
+		$this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
+		echo EEH_Template::display_template(
+			TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * txn_billing_info_side_meta_box
+	 *    generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function txn_billing_info_side_meta_box()
+	{
+
+		$this->_template_args['billing_form'] = $this->_transaction->billing_info();
+		$this->_template_args['billing_form_url'] = add_query_arg(
+			array('action' => 'edit_transaction', 'process' => 'billing'),
+			TXN_ADMIN_URL
+		);
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
+	}
+
+
+	/**
+	 * apply_payments_or_refunds
+	 *    registers a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function apply_payments_or_refunds()
+	{
+		$json_response_data = array('return_data' => false);
+		$valid_data = $this->_validate_payment_request_data();
+		$has_access = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		if (! empty($valid_data) && $has_access) {
+			$PAY_ID = $valid_data['PAY_ID'];
+			// save  the new payment
+			$payment = $this->_create_payment_from_request_data($valid_data);
+			// get the TXN for this payment
+			$transaction = $payment->transaction();
+			// verify transaction
+			if ($transaction instanceof EE_Transaction) {
+				// calculate_total_payments_and_update_status
+				$this->_process_transaction_payments($transaction);
+				$REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
+				$this->_remove_existing_registration_payments($payment, $PAY_ID);
+				// apply payment to registrations (if applicable)
+				if (! empty($REG_IDs)) {
+					$this->_update_registration_payments($transaction, $payment, $REG_IDs);
+					$this->_maybe_send_notifications();
+					// now process status changes for the same registrations
+					$this->_process_registration_status_change($transaction, $REG_IDs);
+				}
+				$this->_maybe_send_notifications($payment);
+				// prepare to render page
+				$json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs);
+				do_action(
+					'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
+					$transaction,
+					$payment
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Transaction for this payment could not be retrieved.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			if ($has_access) {
+				EE_Error::add_error(
+					esc_html__(
+						'The payment form data could not be processed. Please try again.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'You do not have access to apply payments or refunds to a registration.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$notices = EE_Error::get_notices(
+			false,
+			false,
+			false
+		);
+		$this->_template_args = array(
+			'data'    => $json_response_data,
+			'error'   => $notices['errors'],
+			'success' => $notices['success'],
+		);
+		$this->_return_json();
+	}
+
+
+	/**
+	 * _validate_payment_request_data
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _validate_payment_request_data()
+	{
+		if (! isset($this->_req_data['txn_admin_payment'])) {
+			return false;
+		}
+		$payment_form = $this->_generate_payment_form_section();
+		try {
+			if ($payment_form->was_submitted()) {
+				$payment_form->receive_form_submission();
+				if (! $payment_form->is_valid()) {
+					$submission_error_messages = array();
+					foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
+						if ($validation_error instanceof EE_Validation_Error) {
+							$submission_error_messages[] = sprintf(
+								_x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
+								$validation_error->get_form_section()->html_label_text(),
+								$validation_error->getMessage()
+							);
+						}
+					}
+					EE_Error::add_error(
+						implode('<br />', $submission_error_messages),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+
+					return array();
+				}
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+
+			return array();
+		}
+
+		return $payment_form->valid_data();
+	}
+
+
+	/**
+	 * _generate_payment_form_section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _generate_payment_form_section()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'        => 'txn_admin_payment',
+				'subsections' => array(
+					'PAY_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => false,
+							'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'TXN_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'type'            => new EE_Text_Input(
+						array(
+							'default'               => 1,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'amount'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
+							'validation_strategies' => array(new EE_Float_Normalization()),
+						)
+					),
+					'status'          => new EE_Text_Input(
+						array(
+							'default'         => EEM_Payment::status_id_approved,
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment status', 'event_espresso'),
+						)
+					),
+					'PMD_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 2,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'date'            => new EE_Text_Input(
+						array(
+							'default'         => time(),
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment date', 'event_espresso'),
+						)
+					),
+					'txn_id_chq_nmbr' => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							),
+						)
+					),
+					'po_number'       => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							),
+						)
+					),
+					'accounting'      => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							),
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _create_payment_from_request_data
+	 *
+	 * @param array $valid_data
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	protected function _create_payment_from_request_data($valid_data)
+	{
+		$PAY_ID = $valid_data['PAY_ID'];
+		// get payment amount
+		$amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
+		// payments have a type value of 1 and refunds have a type value of -1
+		// so multiplying amount by type will give a positive value for payments, and negative values for refunds
+		$amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
+		// for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
+		$date = $valid_data['date']
+			? preg_replace('/\s+/', ' ', $valid_data['date'])
+			: date('Y-m-d g:i a', current_time('timestamp'));
+		$payment = EE_Payment::new_instance(
+			array(
+				'TXN_ID'              => $valid_data['TXN_ID'],
+				'STS_ID'              => $valid_data['status'],
+				'PAY_timestamp'       => $date,
+				'PAY_source'          => EEM_Payment_Method::scope_admin,
+				'PMD_ID'              => $valid_data['PMD_ID'],
+				'PAY_amount'          => $amount,
+				'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
+				'PAY_po_number'       => $valid_data['po_number'],
+				'PAY_extra_accntng'   => $valid_data['accounting'],
+				'PAY_details'         => $valid_data,
+				'PAY_ID'              => $PAY_ID,
+			),
+			'',
+			array('Y-m-d', 'g:i a')
+		);
+
+		if (! $payment->save()) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
+					$payment->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * _process_transaction_payments
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_transaction_payments(EE_Transaction $transaction)
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		// update the transaction with this payment
+		if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_success(
+				esc_html__(
+					'The payment has been processed successfully.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'The payment was processed successfully but the amount paid for the transaction was not updated.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _get_REG_IDs_to_apply_payment_to
+	 * returns a list of registration IDs that the payment will apply to
+	 *
+	 * @param \EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
+	{
+		$REG_IDs = array();
+		// grab array of IDs for specific registrations to apply changes to
+		if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
+			$REG_IDs = (array) $this->_req_data['txn_admin_payment']['registrations'];
+		}
+		// nothing specified ? then get all reg IDs
+		if (empty($REG_IDs)) {
+			$registrations = $payment->transaction()->registrations();
+			$REG_IDs = ! empty($registrations)
+				? array_keys($registrations)
+				: $this->_get_existing_reg_payment_REG_IDs($payment);
+		}
+
+		// ensure that REG_IDs are integers and NOT strings
+		return array_map('intval', $REG_IDs);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function existing_reg_payment_REG_IDs()
+	{
+		return $this->_existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * @param array $existing_reg_payment_REG_IDs
+	 */
+	public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
+	{
+		$this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * _get_existing_reg_payment_REG_IDs
+	 * returns a list of registration IDs that the payment is currently related to
+	 * as recorded in the database
+	 *
+	 * @param \EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
+	{
+		if ($this->existing_reg_payment_REG_IDs() === null) {
+			// let's get any existing reg payment records for this payment
+			$existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
+			// but we only want the REG IDs, so grab the array keys
+			$existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
+				? array_keys($existing_reg_payment_REG_IDs)
+				: array();
+			$this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
+		}
+
+		return $this->existing_reg_payment_REG_IDs();
+	}
+
+
+	/**
+	 * _remove_existing_registration_payments
+	 * this calculates the difference between existing relations
+	 * to the supplied payment and the new list registration IDs,
+	 * removes any related registrations that no longer apply,
+	 * and then updates the registration paid fields
+	 *
+	 * @param \EE_Payment $payment
+	 * @param int         $PAY_ID
+	 * @return bool;
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
+	{
+		// newly created payments will have nothing recorded for $PAY_ID
+		if ($PAY_ID == 0) {
+			return false;
+		}
+		$existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+		if (empty($existing_reg_payment_REG_IDs)) {
+			return false;
+		}
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+
+		return $transaction_payments->delete_registration_payments_and_update_registrations(
+			$payment,
+			array(
+				array(
+					'PAY_ID' => $payment->ID(),
+					'REG_ID' => array('IN', $existing_reg_payment_REG_IDs),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _update_registration_payments
+	 * this applies the payments to the selected registrations
+	 * but only if they have not already been paid for
+	 *
+	 * @param  EE_Transaction $transaction
+	 * @param \EE_Payment     $payment
+	 * @param array           $REG_IDs
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$REG_IDs = array()
+	) {
+		// we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
+		// so let's do that using our set of REG_IDs from the form
+		$registration_query_where_params = array(
+			'REG_ID' => array('IN', $REG_IDs),
+		);
+		// but add in some conditions regarding payment,
+		// so that we don't apply payments to registrations that are free or have already been paid for
+		// but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
+		if (! $payment->is_a_refund()) {
+			$registration_query_where_params['REG_final_price'] = array('!=', 0);
+			$registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
+		}
+		$registrations = $transaction->registrations(array($registration_query_where_params));
+		if (! empty($registrations)) {
+			/** @type EE_Payment_Processor $payment_processor */
+			$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+			$payment_processor->process_registration_payments($transaction, $payment, $registrations);
+		}
+	}
+
+
+	/**
+	 * _process_registration_status_change
+	 * This processes requested registration status changes for all the registrations
+	 * on a given transaction and (optionally) sends out notifications for the changes.
+	 *
+	 * @param  EE_Transaction $transaction
+	 * @param array           $REG_IDs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array())
+	{
+		// first if there is no change in status then we get out.
+		if (! isset($this->_req_data['txn_reg_status_change']['reg_status'])
+			|| $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN'
+		) {
+			// no error message, no change requested, just nothing to do man.
+			return false;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		// made it here dude?  Oh WOW.  K, let's take care of changing the statuses
+		return $transaction_processor->manually_update_registration_statuses(
+			$transaction,
+			sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']),
+			array(array('REG_ID' => array('IN', $REG_IDs)))
+		);
+	}
+
+
+	/**
+	 * _build_payment_json_response
+	 *
+	 * @access public
+	 * @param \EE_Payment $payment
+	 * @param array       $REG_IDs
+	 * @param bool | null $delete_txn_reg_status_change
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _build_payment_json_response(
+		EE_Payment $payment,
+		$REG_IDs = array(),
+		$delete_txn_reg_status_change = null
+	) {
+		// was the payment deleted ?
+		if (is_bool($delete_txn_reg_status_change)) {
+			return array(
+				'PAY_ID'                       => $payment->ID(),
+				'amount'                       => $payment->amount(),
+				'total_paid'                   => $payment->transaction()->paid(),
+				'txn_status'                   => $payment->transaction()->status_ID(),
+				'pay_status'                   => $payment->STS_ID(),
+				'registrations'                => $this->_registration_payment_data_array($REG_IDs),
+				'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
+			);
+		} else {
+			$this->_get_payment_status_array();
+
+			return array(
+				'amount'           => $payment->amount(),
+				'total_paid'       => $payment->transaction()->paid(),
+				'txn_status'       => $payment->transaction()->status_ID(),
+				'pay_status'       => $payment->STS_ID(),
+				'PAY_ID'           => $payment->ID(),
+				'STS_ID'           => $payment->STS_ID(),
+				'status'           => self::$_pay_status[ $payment->STS_ID() ],
+				'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
+				'method'           => strtoupper($payment->source()),
+				'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
+				'gateway'          => $payment->payment_method()
+					? $payment->payment_method()->admin_name()
+					: esc_html__("Unknown", 'event_espresso'),
+				'gateway_response' => $payment->gateway_response(),
+				'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
+				'po_number'        => $payment->po_number(),
+				'extra_accntng'    => $payment->extra_accntng(),
+				'registrations'    => $this->_registration_payment_data_array($REG_IDs),
+			);
+		}
+	}
+
+
+	/**
+	 * delete_payment
+	 *    delete a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_payment()
+	{
+		$json_response_data = array('return_data' => false);
+		$PAY_ID = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
+			? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
+			: 0;
+		$can_delete = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+		if ($PAY_ID && $can_delete) {
+			$delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change'])
+				? $this->_req_data['delete_txn_reg_status_change']
+				: false;
+			$payment = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			if ($payment instanceof EE_Payment) {
+				$REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
+					$json_response_data['return_data'] = $this->_build_payment_json_response(
+						$payment,
+						$REG_IDs,
+						$delete_txn_reg_status_change
+					);
+					if ($delete_txn_reg_status_change) {
+						$this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change;
+						// MAKE sure we also add the delete_txn_req_status_change to the
+						// $_REQUEST global because that's how messages will be looking for it.
+						$_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change;
+						$this->_maybe_send_notifications();
+						$this->_process_registration_status_change($payment->transaction(), $REG_IDs);
+					}
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			if ($can_delete) {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Payment ID was not received, therefore payment form data could not be loaded.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'You do not have access to delete a payment.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$notices = EE_Error::get_notices(false, false, false);
+		$this->_template_args = array(
+			'data'      => $json_response_data,
+			'success'   => $notices['success'],
+			'error'     => $notices['errors'],
+			'attention' => $notices['attention'],
+		);
+		$this->_return_json();
+	}
+
+
+	/**
+	 * _registration_payment_data_array
+	 * adds info for 'owing' and 'paid' for each registration to the json response
+	 *
+	 * @access protected
+	 * @param array $REG_IDs
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _registration_payment_data_array($REG_IDs)
+	{
+		$registration_payment_data = array();
+		// if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
+		if (! empty($REG_IDs)) {
+			$registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration_payment_data[ $registration->ID() ] = array(
+						'paid'  => $registration->pretty_paid(),
+						'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
+					);
+				}
+			}
+		}
+
+		return $registration_payment_data;
+	}
+
+
+	/**
+	 * _maybe_send_notifications
+	 * determines whether or not the admin has indicated that notifications should be sent.
+	 * If so, will toggle a filter switch for delivering registration notices.
+	 * If passed an EE_Payment object, then it will trigger payment notifications instead.
+	 *
+	 * @access protected
+	 * @param \EE_Payment | null $payment
+	 */
+	protected function _maybe_send_notifications($payment = null)
+	{
+		switch ($payment instanceof EE_Payment) {
+			// payment notifications
+			case true:
+				if (isset(
+					$this->_req_data['txn_payments'],
+					$this->_req_data['txn_payments']['send_notifications']
+				)
+					&& filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
+				) {
+					$this->_process_payment_notification($payment);
+				}
+				break;
+			// registration notifications
+			case false:
+				if (isset(
+					$this->_req_data['txn_reg_status_change'],
+					$this->_req_data['txn_reg_status_change']['send_notifications']
+				)
+					&& filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
+				) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				}
+				break;
+		}
+	}
+
+
+	/**
+	 * _send_payment_reminder
+	 *    generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _send_payment_reminder()
+	{
+		$TXN_ID = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false;
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$query_args = isset($this->_req_data['redirect_to']) ? array(
+			'action' => $this->_req_data['redirect_to'],
+			'TXN_ID' => $this->_req_data['TXN_ID'],
+		) : array();
+		do_action(
+			'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			$transaction
+		);
+		$this->_redirect_after_action(
+			false,
+			esc_html__('payment reminder', 'event_espresso'),
+			esc_html__('sent', 'event_espresso'),
+			$query_args,
+			true
+		);
+	}
+
+
+	/**
+	 *  get_transactions
+	 *    get transactions for given parameters (used by list table)
+	 *
+	 * @param  int     $perpage how many transactions displayed per page
+	 * @param  boolean $count   return the count or objects
+	 * @param string   $view
+	 * @return mixed int = count || array of transaction objects
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transactions($perpage, $count = false, $view = '')
+	{
+
+		$TXN = EEM_Transaction::instance();
+
+		$start_date = isset($this->_req_data['txn-filter-start-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
+			: date(
+				'm/d/Y',
+				strtotime('-10 year')
+			);
+		$end_date = isset($this->_req_data['txn-filter-end-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
+			: date('m/d/Y');
+
+		// make sure our timestamps start and end right at the boundaries for each day
+		$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+		$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+
+
+		// convert to timestamps
+		$start_date = strtotime($start_date);
+		$end_date = strtotime($end_date);
+
+		// makes sure start date is the lowest value and vice versa
+		$start_date = min($start_date, $end_date);
+		$end_date = max($start_date, $end_date);
+
+		// convert to correct format for query
+		$start_date = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $start_date),
+			'Y-m-d H:i:s'
+		);
+		$end_date = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $end_date),
+			'Y-m-d H:i:s'
+		);
+
+
+		// set orderby
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+
+		switch ($this->_req_data['orderby']) {
+			case 'TXN_ID':
+				$orderby = 'TXN_ID';
+				break;
+			case 'ATT_fname':
+				$orderby = 'Registration.Attendee.ATT_fname';
+				break;
+			case 'event_name':
+				$orderby = 'Registration.Event.EVT_name';
+				break;
+			default: // 'TXN_timestamp'
+				$orderby = 'TXN_timestamp';
+		}
+
+		$sort = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		$current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
+		$per_page = ! empty($perpage) ? $perpage : 10;
+		$per_page = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page;
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit = array($offset, $per_page);
+
+		$_where = array(
+			'TXN_timestamp'          => array('BETWEEN', array($start_date, $end_date)),
+			'Registration.REG_count' => 1,
+		);
+
+		if (isset($this->_req_data['EVT_ID'])) {
+			$_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID'];
+		}
+
+		if (isset($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'Registration.Event.EVT_name'         => array('LIKE', $search_string),
+				'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
+				'Registration.Event.EVT_short_desc'   => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_fname'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_lname'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_email'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_address'   => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_address2'  => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_city'      => array('LIKE', $search_string),
+				'Registration.REG_final_price'        => array('LIKE', $search_string),
+				'Registration.REG_code'               => array('LIKE', $search_string),
+				'Registration.REG_count'              => array('LIKE', $search_string),
+				'Registration.REG_group_size'         => array('LIKE', $search_string),
+				'Registration.Ticket.TKT_name'        => array('LIKE', $search_string),
+				'Registration.Ticket.TKT_description' => array('LIKE', $search_string),
+				'Payment.PAY_source'                  => array('LIKE', $search_string),
+				'Payment.Payment_Method.PMD_name'     => array('LIKE', $search_string),
+				'TXN_session_data'                    => array('LIKE', $search_string),
+				'Payment.PAY_txn_id_chq_nmbr'         => array('LIKE', $search_string),
+			);
+		}
+
+		// failed transactions
+		$failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
+				  || ($count && $view === 'failed');
+		$abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
+					 || ($count && $view === 'abandoned');
+
+		if ($failed) {
+			$_where['STS_ID'] = EEM_Transaction::failed_status_code;
+		} elseif ($abandoned) {
+			$_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
+		} else {
+			$_where['STS_ID'] = array('!=', EEM_Transaction::failed_status_code);
+			$_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code);
+		}
+
+		$query_params = array(
+			$_where,
+			'order_by'                 => array($orderby => $sort),
+			'limit'                    => $limit,
+			'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
+		);
+
+		$transactions = $count
+			? $TXN->count(array($_where), 'TXN_ID', true)
+			: $TXN->get_all($query_params);
+
+		return $transactions;
+	}
 }

Spacing +83 added lines, -83 removed lines

@@ -363,7 +363,7 @@ 
         // enqueue style
         wp_register_style(
             'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.css',
+            TXN_ASSETS_URL.'espresso_transactions_admin.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
@@ -371,7 +371,7 @@ 
         // scripts
         wp_register_script(
             'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.js',
+            TXN_ASSETS_URL.'espresso_transactions_admin.js',
             array(
                 'ee_admin_js',
                 'ee-datepicker',
@@ -474,7 +474,7 @@ 
             $this->_transaction->verify_abandoned_transaction_status();
         }
 
-        if (! $this->_transaction instanceof EE_Transaction) {
+        if ( ! $this->_transaction instanceof EE_Transaction) {
             $error_msg = sprintf(
                 esc_html__(
                     'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
@@ -572,7 +572,7 @@ 
             'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
             array(
                 'overpaid'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::overpaid_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::overpaid_status_code,
                         false,
@@ -580,7 +580,7 @@ 
                     ),
                 ),
                 'complete'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::complete_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::complete_status_code,
                         false,
@@ -588,7 +588,7 @@ 
                     ),
                 ),
                 'incomplete' => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::incomplete_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::incomplete_status_code,
                         false,
@@ -596,7 +596,7 @@ 
                     ),
                 ),
                 'abandoned'  => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::abandoned_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::abandoned_status_code,
                         false,
@@ -604,7 +604,7 @@ 
                     ),
                 ),
                 'failed'     => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::failed_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::failed_status_code,
                         false,
@@ -653,7 +653,7 @@ 
                     'Click to Edit event',
                     'event_espresso'
                 )
-                . '">' . $event->get('EVT_name') . '</a>',
+                . '">'.$event->get('EVT_name').'</a>',
                 '</h3>'
             )
             : '';
@@ -687,7 +687,7 @@ 
 
         $this->_set_transaction_object();
 
-        if (! $this->_transaction instanceof EE_Transaction) {
+        if ( ! $this->_transaction instanceof EE_Transaction) {
             return;
         }
         $primary_registration = $this->_transaction->primary_registration();
@@ -701,9 +701,9 @@ 
         $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
         $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
 
-        $this->_template_args['txn_status']['value'] = self::$_txn_status[ $this->_transaction->get('STS_ID') ];
+        $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')];
         $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
+        $this->_template_args['txn_status']['class'] = 'status-'.$this->_transaction->get('STS_ID');
 
         $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
         $this->_template_args['total_paid'] = $this->_transaction->get('TXN_paid');
@@ -821,7 +821,7 @@ 
         // grab messages at the last second
         $this->_template_args['notices'] = EE_Error::get_notices();
         // path to template
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_header.template.php';
         $this->_template_args['admin_page_header'] = EEH_Template::display_template(
             $template_path,
             $this->_template_args,
@@ -850,7 +850,7 @@ 
 
         $this->_set_transaction_object();
 
-        if (! $this->_transaction instanceof EE_Transaction) {
+        if ( ! $this->_transaction instanceof EE_Transaction) {
             return;
         }
         add_meta_box(
@@ -905,7 +905,7 @@ 
     {
         $content = '';
         $actions = array();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return $content;
         }
         /** @var EE_Registration $primary_registration */
@@ -966,7 +966,7 @@ 
         );
         if ($actions) {
             $content = '<ul>';
-            $content .= '<li>' . implode('</li><li>', $actions) . '</li>';
+            $content .= '<li>'.implode('</li><li>', $actions).'</li>';
             $content .= '</uL>';
         }
         return $content;
@@ -1031,7 +1031,7 @@ 
 
         // process payment details
         $payments = $this->_transaction->get_many_related('Payment');
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             $this->_template_args['payments'] = $payments;
             $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
         } else {
@@ -1092,7 +1092,7 @@ 
                                   esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
                                   ucwords(str_replace('_', ' ', $reg_step)),
                                   date(
-                                      get_option('date_format') . ' ' . get_option('time_format'),
+                                      get_option('date_format').' '.get_option('time_format'),
                                       ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS))
                                   )
                               )
@@ -1145,7 +1145,7 @@ 
 
         // 'espresso_delete_payment_nonce'
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_txn_details.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -1177,18 +1177,18 @@ 
                 ),
             )
         );
-        if (! empty($reg_payments)) {
+        if ( ! empty($reg_payments)) {
             foreach ($payments as $payment) {
-                if (! $payment instanceof EE_Payment) {
+                if ( ! $payment instanceof EE_Payment) {
                     continue;
-                } elseif (! isset($existing_reg_payments[ $payment->ID() ])) {
-                    $existing_reg_payments[ $payment->ID() ] = array();
+                } elseif ( ! isset($existing_reg_payments[$payment->ID()])) {
+                    $existing_reg_payments[$payment->ID()] = array();
                 }
                 foreach ($reg_payments as $reg_payment) {
                     if ($reg_payment instanceof EE_Registration_Payment
                         && $reg_payment->payment_ID() === $payment->ID()
                     ) {
-                        $existing_reg_payments[ $payment->ID() ][] = $reg_payment->registration_ID();
+                        $existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID();
                     }
                 }
             }
@@ -1229,16 +1229,16 @@ 
                                                  '',
                                                  'clear: both; margin: 1.5em 0 0; display: none;'
                                              );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+        $registrations_to_apply_payment_to .= EEH_HTML::br().EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
         $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
         $registrations_to_apply_payment_to .= EEH_HTML::thead(
             EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+                EEH_HTML::th(esc_html__('ID', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Event', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr').
+                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr').
                 EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
             )
         );
@@ -1253,29 +1253,29 @@ 
                     : esc_html__('Unknown Attendee', 'event_espresso');
                 $owing = $registration->final_price() - $registration->paid();
                 $taxable = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+                    ? ' <span class="smaller-text lt-grey-text"> '.esc_html__('+ tax', 'event_espresso').'</span>'
                     : '';
                 $checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
                     ? ' checked="checked"'
                     : '';
                 $disabled = $registration->final_price() > 0 ? '' : ' disabled';
                 $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
+                    EEH_HTML::td($registration->ID()).
+                    EEH_HTML::td($attendee_name).
                     EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
+                        $registration->ticket()->name().' : '.$registration->ticket()->pretty_price().$taxable
+                    ).
+                    EEH_HTML::td($registration->event_name()).
+                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr').
+                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr').
                     EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
+                        '<input type="checkbox" value="'.$registration->ID()
                         . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
+                        . $checked.$disabled.'>',
                         '',
                         'jst-cntr'
                     ),
-                    'apply-payment-registration-row-' . $registration->ID()
+                    'apply-payment-registration-row-'.$registration->ID()
                 );
             }
         }
@@ -1356,12 +1356,12 @@ 
                 array(
                     'OR*payment_method_for_payment' => array(
                         'PMD_ID'    => array('IN', $payment_methods_of_payments),
-                        'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'),
+                        'PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%'),
                     ),
                 ),
             );
         } else {
-            $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
+            $query_args = array(array('PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%')));
         }
         $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
     }
@@ -1390,7 +1390,7 @@ 
             'Line_Item',
             array(array('LIN_type' => 'line-item'))
         );
-        if (! empty($line_items)) {
+        if ( ! empty($line_items)) {
             foreach ($line_items as $item) {
                 if ($item instanceof EE_Line_Item) {
                     switch ($item->OBJ_type()) {
@@ -1400,7 +1400,7 @@ 
                             $ticket = $item->ticket();
                             // right now we're only handling tickets here.
                             // Cause its expected that only tickets will have attendees right?
-                            if (! $ticket instanceof EE_Ticket) {
+                            if ( ! $ticket instanceof EE_Ticket) {
                                 continue;
                             }
                             try {
@@ -1409,7 +1409,7 @@ 
                                 EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                                 $event_name = esc_html__('Unknown Event', 'event_espresso');
                             }
-                            $event_name .= ' - ' . $item->get('LIN_name');
+                            $event_name .= ' - '.$item->get('LIN_name');
                             $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
                             // now get all of the registrations for this transaction that use this ticket
                             $registrations = $ticket->get_many_related(
@@ -1417,38 +1417,38 @@ 
                                 array(array('TXN_ID' => $this->_transaction->ID()))
                             );
                             foreach ($registrations as $registration) {
-                                if (! $registration instanceof EE_Registration) {
+                                if ( ! $registration instanceof EE_Registration) {
                                     continue;
                                 }
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['STS_ID']
+                                $this->_template_args['event_attendees'][$registration->ID()]['STS_ID']
                                     = $registration->status_ID();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['att_num']
+                                $this->_template_args['event_attendees'][$registration->ID()]['att_num']
                                     = $registration->count();
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['event_ticket_name']
+                                $this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name']
                                     = $event_name;
-                                $this->_template_args['event_attendees'][ $registration->ID() ]['ticket_price']
+                                $this->_template_args['event_attendees'][$registration->ID()]['ticket_price']
                                     = $ticket_price;
                                 // attendee info
                                 $attendee = $registration->get_first_related('Attendee');
                                 if ($attendee instanceof EE_Attendee) {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id']
+                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id']
                                         = $attendee->ID();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee']
+                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee']
                                         = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email']
-                                        = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
+                                    $this->_template_args['event_attendees'][$registration->ID()]['email']
+                                        = '<a href="mailto:'.$attendee->email().'?subject='.$event_name
                                           . esc_html__(
                                               ' Event',
                                               'event_espresso'
                                           )
-                                          . '">' . $attendee->email() . '</a>';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address']
+                                          . '">'.$attendee->email().'</a>';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['address']
                                         = EEH_Address::format($attendee, 'inline', false, false);
                                 } else {
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['att_id'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['attendee'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['email'] = '';
-                                    $this->_template_args['event_attendees'][ $registration->ID() ]['address'] = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id'] = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['email'] = '';
+                                    $this->_template_args['event_attendees'][$registration->ID()]['address'] = '';
                                 }
                             }
                             break;
@@ -1464,7 +1464,7 @@ 
                 TXN_ADMIN_URL
             );
             echo EEH_Template::display_template(
-                TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+                TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_attendees.template.php',
                 $this->_template_args,
                 true
             );
@@ -1499,7 +1499,7 @@ 
         $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
             ? $this->_transaction->primary_registration()->get_first_related('Attendee')
             : null;
-        if (! $primary_att instanceof EE_Attendee) {
+        if ( ! $primary_att instanceof EE_Attendee) {
             $this->_template_args['no_attendee_message'] = esc_html__(
                 'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
                 'event_espresso'
@@ -1521,7 +1521,7 @@ 
         // get formatted address for registrant
         $this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
         echo EEH_Template::display_template(
-            TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+            TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_registrant.template.php',
             $this->_template_args,
             true
         );
@@ -1546,8 +1546,8 @@ 
             TXN_ADMIN_URL
         );
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_billing_info.template.php';
+        echo EEH_Template::display_template($template_path, $this->_template_args, true); /**/
     }
 
 
@@ -1572,7 +1572,7 @@ 
             'ee_edit_payments',
             'apply_payment_or_refund_from_registration_details'
         );
-        if (! empty($valid_data) && $has_access) {
+        if ( ! empty($valid_data) && $has_access) {
             $PAY_ID = $valid_data['PAY_ID'];
             // save  the new payment
             $payment = $this->_create_payment_from_request_data($valid_data);
@@ -1585,7 +1585,7 @@ 
                 $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
                 $this->_remove_existing_registration_payments($payment, $PAY_ID);
                 // apply payment to registrations (if applicable)
-                if (! empty($REG_IDs)) {
+                if ( ! empty($REG_IDs)) {
                     $this->_update_registration_payments($transaction, $payment, $REG_IDs);
                     $this->_maybe_send_notifications();
                     // now process status changes for the same registrations
@@ -1655,14 +1655,14 @@ 
      */
     protected function _validate_payment_request_data()
     {
-        if (! isset($this->_req_data['txn_admin_payment'])) {
+        if ( ! isset($this->_req_data['txn_admin_payment'])) {
             return false;
         }
         $payment_form = $this->_generate_payment_form_section();
         try {
             if ($payment_form->was_submitted()) {
                 $payment_form->receive_form_submission();
-                if (! $payment_form->is_valid()) {
+                if ( ! $payment_form->is_valid()) {
                     $submission_error_messages = array();
                     foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
                         if ($validation_error instanceof EE_Validation_Error) {
@@ -1841,7 +1841,7 @@ 
             array('Y-m-d', 'g:i a')
         );
 
-        if (! $payment->save()) {
+        if ( ! $payment->save()) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
@@ -2038,12 +2038,12 @@ 
         // but add in some conditions regarding payment,
         // so that we don't apply payments to registrations that are free or have already been paid for
         // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if (! $payment->is_a_refund()) {
+        if ( ! $payment->is_a_refund()) {
             $registration_query_where_params['REG_final_price'] = array('!=', 0);
             $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
         }
         $registrations = $transaction->registrations(array($registration_query_where_params));
-        if (! empty($registrations)) {
+        if ( ! empty($registrations)) {
             /** @type EE_Payment_Processor $payment_processor */
             $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
             $payment_processor->process_registration_payments($transaction, $payment, $registrations);
@@ -2068,7 +2068,7 @@ 
     protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array())
     {
         // first if there is no change in status then we get out.
-        if (! isset($this->_req_data['txn_reg_status_change']['reg_status'])
+        if ( ! isset($this->_req_data['txn_reg_status_change']['reg_status'])
             || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN'
         ) {
             // no error message, no change requested, just nothing to do man.
@@ -2126,7 +2126,7 @@ 
                 'pay_status'       => $payment->STS_ID(),
                 'PAY_ID'           => $payment->ID(),
                 'STS_ID'           => $payment->STS_ID(),
-                'status'           => self::$_pay_status[ $payment->STS_ID() ],
+                'status'           => self::$_pay_status[$payment->STS_ID()],
                 'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
                 'method'           => strtoupper($payment->source()),
                 'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
@@ -2248,11 +2248,11 @@ 
     {
         $registration_payment_data = array();
         // if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if (! empty($REG_IDs)) {
+        if ( ! empty($REG_IDs)) {
             $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
             foreach ($registrations as $registration) {
                 if ($registration instanceof EE_Registration) {
-                    $registration_payment_data[ $registration->ID() ] = array(
+                    $registration_payment_data[$registration->ID()] = array(
                         'paid'  => $registration->pretty_paid(),
                         'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
                     );
@@ -2364,8 +2364,8 @@ 
             : date('m/d/Y');
 
         // make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+        $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+        $end_date = date('Y-m-d', strtotime($end_date)).' 23:59:59';
 
 
         // convert to timestamps
@@ -2424,7 +2424,7 @@ 
         }
 
         if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
+            $search_string = '%'.$this->_req_data['s'].'%';
             $_where['OR'] = array(
                 'Registration.Event.EVT_name'         => array('LIKE', $search_string),
                 'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
@@ -2451,9 +2451,9 @@ 
         }
 
         // failed transactions
-        $failed = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
+        $failed = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
                   || ($count && $view === 'failed');
-        $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
+        $abandoned = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
                      || ($count && $view === 'abandoned');
 
         if ($failed) {

modules/messages/EED_Messages.module.php

Indentation +1322 added lines, -1322 removed lines

@@ -16,1335 +16,1335 @@
 class EED_Messages extends EED_Module
 {
 
-    /**
-     * This holds the EE_messages controller
-     *
-     * @deprecated 4.9.0
-     * @var EE_messages $_EEMSG
-     */
-    protected static $_EEMSG;
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected static $_message_resource_manager;
-
-    /**
-     * This holds the EE_Messages_Processor business class.
-     *
-     * @type EE_Messages_Processor
-     */
-    protected static $_MSG_PROCESSOR;
-
-    /**
-     * holds all the paths for various messages components.
-     * Utilized by autoloader registry
-     *
-     * @var array
-     */
-    protected static $_MSG_PATHS;
-
-
-    /**
-     * This will hold an array of messages template packs that are registered in the messages system.
-     * Format is:
-     * array(
-     *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
-     * )
-     *
-     * @var EE_Messages_Template_Pack[]
-     */
-    protected static $_TMP_PACKS = array();
-
-
-    /**
-     * @return EED_Messages
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *  set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @since 4.5.0
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action(
-            'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'),
-            10,
-            2
-        );
-        // filters
-        add_filter(
-            'FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        // register routes
-        self::_register_routes();
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        // actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action(
-            'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            array('EED_Messages', 'payment_reminder'),
-            10
-        );
-        add_action(
-            'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'),
-            10,
-            3
-        );
-        add_action(
-            'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-            array('EED_Messages', 'send_newsletter_message'),
-            10,
-            2
-        );
-        add_action(
-            'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
-            array('EED_Messages', 'cancelled_registration'),
-            10
-        );
-        add_action(
-            'AHEE__EE_Admin_Page___process_admin_payment_notification',
-            array('EED_Messages', 'process_admin_payment'),
-            10,
-            1
-        );
-        // filters
-        add_filter(
-            'FHEE__EE_Admin_Page___process_resend_registration__success',
-            array('EED_Messages', 'process_resend'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-    }
-
-
-    /**
-     * All the message triggers done by route go in here.
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected static function _register_routes()
-    {
-        EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
-        EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
-        EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
-        EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
-        do_action('AHEE__EED_Messages___register_routes');
-    }
-
-
-    /**
-     * This is called when a browser display trigger is executed.
-     * The browser display trigger is typically used when a already generated message is displayed directly in the
-     * browser.
-     *
-     * @since 4.9.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_trigger($WP)
-    {
-        // ensure controller is loaded
-        self::_load_controller();
-        $token = EE_Registry::instance()->REQ->get('token');
-        try {
-            $mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
-            self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
-        } catch (EE_Error $e) {
-            $error_msg = __(
-                'Please note that a system message failed to send due to a technical issue.',
-                'event_espresso'
-            );
-            // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * This is called when a browser error trigger is executed.
-     * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
-     * message and display it.
-     *
-     * @since 4.9.0
-     * @param $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_error_trigger($WP)
-    {
-        $token = EE_Registry::instance()->REQ->get('token');
-        if ($token) {
-            $message = EEM_Message::instance()->get_one_by_token($token);
-            if ($message instanceof EE_Message) {
-                header('HTTP/1.1 200 OK');
-                $error_msg = nl2br($message->error_message());
-                ?>
+	/**
+	 * This holds the EE_messages controller
+	 *
+	 * @deprecated 4.9.0
+	 * @var EE_messages $_EEMSG
+	 */
+	protected static $_EEMSG;
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected static $_message_resource_manager;
+
+	/**
+	 * This holds the EE_Messages_Processor business class.
+	 *
+	 * @type EE_Messages_Processor
+	 */
+	protected static $_MSG_PROCESSOR;
+
+	/**
+	 * holds all the paths for various messages components.
+	 * Utilized by autoloader registry
+	 *
+	 * @var array
+	 */
+	protected static $_MSG_PATHS;
+
+
+	/**
+	 * This will hold an array of messages template packs that are registered in the messages system.
+	 * Format is:
+	 * array(
+	 *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
+	 * )
+	 *
+	 * @var EE_Messages_Template_Pack[]
+	 */
+	protected static $_TMP_PACKS = array();
+
+
+	/**
+	 * @return EED_Messages
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *  set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @since 4.5.0
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action(
+			'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'),
+			10,
+			2
+		);
+		// filters
+		add_filter(
+			'FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		// register routes
+		self::_register_routes();
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		// actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action(
+			'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			array('EED_Messages', 'payment_reminder'),
+			10
+		);
+		add_action(
+			'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'),
+			10,
+			3
+		);
+		add_action(
+			'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+			array('EED_Messages', 'send_newsletter_message'),
+			10,
+			2
+		);
+		add_action(
+			'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
+			array('EED_Messages', 'cancelled_registration'),
+			10
+		);
+		add_action(
+			'AHEE__EE_Admin_Page___process_admin_payment_notification',
+			array('EED_Messages', 'process_admin_payment'),
+			10,
+			1
+		);
+		// filters
+		add_filter(
+			'FHEE__EE_Admin_Page___process_resend_registration__success',
+			array('EED_Messages', 'process_resend'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+	}
+
+
+	/**
+	 * All the message triggers done by route go in here.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected static function _register_routes()
+	{
+		EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
+		EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
+		EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
+		EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
+		do_action('AHEE__EED_Messages___register_routes');
+	}
+
+
+	/**
+	 * This is called when a browser display trigger is executed.
+	 * The browser display trigger is typically used when a already generated message is displayed directly in the
+	 * browser.
+	 *
+	 * @since 4.9.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_trigger($WP)
+	{
+		// ensure controller is loaded
+		self::_load_controller();
+		$token = EE_Registry::instance()->REQ->get('token');
+		try {
+			$mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
+			self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
+		} catch (EE_Error $e) {
+			$error_msg = __(
+				'Please note that a system message failed to send due to a technical issue.',
+				'event_espresso'
+			);
+			// add specific message for developers if WP_DEBUG in on
+			$error_msg .= '||' . $e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * This is called when a browser error trigger is executed.
+	 * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
+	 * message and display it.
+	 *
+	 * @since 4.9.0
+	 * @param $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_error_trigger($WP)
+	{
+		$token = EE_Registry::instance()->REQ->get('token');
+		if ($token) {
+			$message = EEM_Message::instance()->get_one_by_token($token);
+			if ($message instanceof EE_Message) {
+				header('HTTP/1.1 200 OK');
+				$error_msg = nl2br($message->error_message());
+				?>
                 <!DOCTYPE html>
                 <html>
                 <head></head>
                 <body>
                 <?php echo empty($error_msg)
-                    ? esc_html__(
-                        'Unfortunately, we were unable to capture the error message for this message.',
-                        'event_espresso'
-                    )
-                    : wp_kses(
-                        $error_msg,
-                        array(
-                            'a'      => array(
-                                'href'  => array(),
-                                'title' => array(),
-                            ),
-                            'span'   => array(),
-                            'div'    => array(),
-                            'p'      => array(),
-                            'strong' => array(),
-                            'em'     => array(),
-                            'br'     => array(),
-                        )
-                    ); ?>
+					? esc_html__(
+						'Unfortunately, we were unable to capture the error message for this message.',
+						'event_espresso'
+					)
+					: wp_kses(
+						$error_msg,
+						array(
+							'a'      => array(
+								'href'  => array(),
+								'title' => array(),
+							),
+							'span'   => array(),
+							'div'    => array(),
+							'p'      => array(),
+							'strong' => array(),
+							'em'     => array(),
+							'br'     => array(),
+						)
+					); ?>
                 </body>
                 </html>
                 <?php
-                exit;
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *  This runs when the msg_url_trigger route has initiated.
-     *
-     * @since 4.5.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function run($WP)
-    {
-        // ensure controller is loaded
-        self::_load_controller();
-        // attempt to process message
-        try {
-            /** @type EE_Message_To_Generate_From_Request $message_to_generate */
-            $message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-            self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
-        } catch (EE_Error $e) {
-            $error_msg = __(
-                'Please note that a system message failed to send due to a technical issue.',
-                'event_espresso'
-            );
-            // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * This is triggered by the 'msg_cron_trigger' route.
-     *
-     * @param WP $WP
-     */
-    public function execute_batch_request($WP)
-    {
-        $this->run_cron();
-        header('HTTP/1.1 200 OK');
-        exit();
-    }
-
-
-    /**
-     * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
-     * request.
-     */
-    public function run_cron()
-    {
-        self::_load_controller();
-        // get required vars
-        $cron_type = EE_Registry::instance()->REQ->get('type');
-        $transient_key = EE_Registry::instance()->REQ->get('key');
-
-        // now let's verify transient, if not valid exit immediately
-        if (! get_transient($transient_key)) {
-            /**
-             * trigger error so this gets in the error logs.  This is important because it happens on a non-user
-             * request.
-             */
-            trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
-        }
-
-        // if made it here, lets' delete the transient to keep the db clean
-        delete_transient($transient_key);
-
-        if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
-            $method = 'batch_' . $cron_type . '_from_queue';
-            if (method_exists(self::$_MSG_PROCESSOR, $method)) {
-                self::$_MSG_PROCESSOR->$method();
-            } else {
-                // no matching task
-                /**
-                 * trigger error so this gets in the error logs.  This is important because it happens on a non user
-                 * request.
-                 */
-                trigger_error(
-                    esc_attr(
-                        sprintf(
-                            __('There is no task corresponding to this route %s', 'event_espresso'),
-                            $cron_type
-                        )
-                    )
-                );
-            }
-        }
-
-        do_action('FHEE__EED_Messages__run_cron__end');
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
-     * the default template pack is returned.
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
-     * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
-     *                                   in generating the Pack class name).
-     * @return EE_Messages_Template_Pack
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($template_pack_name);
-    }
-
-
-    /**
-     * Retrieves an array of all template packs.
-     * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
-     * @return EE_Messages_Template_Pack[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_packs()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-
-        // for backward compat, let's make sure this returns in the same format as originally.
-        $template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
-        $template_pack_collection->rewind();
-        $template_packs = array();
-        while ($template_pack_collection->valid()) {
-            $template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
-            $template_pack_collection->next();
-        }
-        return $template_packs;
-    }
-
-
-    /**
-     * This simply makes sure the autoloaders are registered for the EE_messages system.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    public static function set_autoloaders()
-    {
-        if (empty(self::$_MSG_PATHS)) {
-            self::_set_messages_paths();
-            foreach (self::$_MSG_PATHS as $path) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
-            }
-            // add aliases
-            EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
-            EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
-        }
-    }
-
-
-    /**
-     * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
-     * for use by the Messages Autoloaders
-     *
-     * @since 4.5.0
-     * @return void.
-     */
-    protected static function _set_messages_paths()
-    {
-        $dir_ref = array(
-            'messages/message_type',
-            'messages/messenger',
-            'messages/defaults',
-            'messages/defaults/email',
-            'messages/data_class',
-            'messages/validators',
-            'messages/validators/email',
-            'messages/validators/html',
-            'shortcodes',
-        );
-        $paths = array();
-        foreach ($dir_ref as $index => $dir) {
-            $paths[ $index ] = EE_LIBRARIES . $dir;
-        }
-        self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
-    }
-
-
-    /**
-     * Takes care of loading dependencies
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _load_controller()
-    {
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
-            EE_Registry::instance()->load_core('Request_Handler');
-            self::set_autoloaders();
-            self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
-            self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib('Messages_Processor');
-            self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        }
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function payment_reminder(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
-    }
-
-
-    /**
-     * Any messages triggers for after successful gateway payments should go in here.
-     *
-     * @param EE_Transaction  $transaction object
-     * @param EE_Payment|null $payment     object
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
-    {
-        // if there's no payment object, then we cannot do a payment type message!
-        if (! $payment instanceof EE_Payment) {
-            return;
-        }
-        self::_load_controller();
-        $data = array($transaction, $payment);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-        // if payment amount is less than 0 then switch to payment_refund message type.
-        $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function cancelled_registration(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
-    }
-
-
-    /**
-     * Trigger for Registration messages
-     * Note that what registration message type is sent depends on what the reg status is for the registrations on the
-     * incoming transaction.
-     *
-     * @param EE_Registration $registration
-     * @param array           $extra_details
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     */
-    public static function maybe_registration(EE_Registration $registration, $extra_details = array())
-    {
-
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
-            // no messages please
-            return;
-        }
-
-        // get all non-trashed registrations so we make sure we send messages for the right status.
-        $all_registrations = $registration->transaction()->registrations(
-            array(
-                array('REG_deleted' => false),
-                'order_by' => array(
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                ),
-            )
-        );
-        // cached array of statuses so we only trigger messages once per status.
-        $statuses_sent = array();
-        self::_load_controller();
-        $mtgs = array();
-
-        // loop through registrations and trigger messages once per status.
-        foreach ($all_registrations as $reg) {
-            // already triggered?
-            if (in_array($reg->status_ID(), $statuses_sent)) {
-                continue;
-            }
-
-            $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
-            $mtgs = array_merge(
-                $mtgs,
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                    $message_type,
-                    array($registration->transaction(), null, $reg->status_ID())
-                )
-            );
-            $statuses_sent[] = $reg->status_ID();
-        }
-
-        if (count($statuses_sent) > 1) {
-            $mtgs = array_merge(
-                $mtgs,
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                    'registration_summary',
-                    array($registration->transaction(), null)
-                )
-            );
-        }
-
-        // batch queue and initiate request
-        self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
-        self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-    }
-
-
-    /**
-     * This is a helper method used to very whether a registration notification should be sent or
-     * not.  Prevents duplicate notifications going out for registration context notifications.
-     *
-     * @param EE_Registration $registration  [description]
-     * @param array           $extra_details [description]
-     * @return bool          true = send away, false = nope halt the presses.
-     */
-    protected static function _verify_registration_notification_send(
-        EE_Registration $registration,
-        $extra_details = array()
-    ) {
-        if (! $registration->is_primary_registrant()) {
-            return false;
-        }
-        // first we check if we're in admin and not doing front ajax
-        if (is_admin() && ! EE_FRONT_AJAX) {
-            // make sure appropriate admin params are set for sending messages
-            if (empty($_REQUEST['txn_reg_status_change']['send_notifications'])
-                || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])
-            ) {
-                // no messages sent please.
-                return false;
-            }
-        } else {
-            // frontend request (either regular or via AJAX)
-            // TXN is NOT finalized ?
-            if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
-                return false;
-            }
-            // return visit but nothing changed ???
-            if (isset($extra_details['revisit'], $extra_details['status_updates']) &&
-                $extra_details['revisit'] && ! $extra_details['status_updates']
-            ) {
-                return false;
-            }
-            // NOT sending messages && reg status is something other than "Not-Approved"
-            if (! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
-                $registration->status_ID() !== EEM_Registration::status_id_not_approved
-            ) {
-                return false;
-            }
-        }
-        // release the kraken
-        return true;
-    }
-
-
-    /**
-     * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
-     * status id.
-     *
-     * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
-     *                    or EEH_MSG_Template::convert_reg_status_to_message_type
-     * @param string $reg_status
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_reg_status_array($reg_status = '')
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            ? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            : EEH_MSG_Template::reg_status_to_message_type_array();
-    }
-
-
-    /**
-     * Simply returns the payment message type for the given payment status.
-     *
-     * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
-     *                   or EEH_MSG_Template::convert_payment_status_to_message_type
-     * @param string $payment_status The payment status being matched.
-     * @return bool|string The payment message type slug matching the status or false if no match.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_payment_message_type($payment_status)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            ? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            : false;
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @access public
-     * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function process_resend($req_data)
-    {
-        self::_load_controller();
-
-        // if $msgID in this request then skip to the new resend_message
-        if (EE_Registry::instance()->REQ->get('MSG_ID')) {
-            return self::resend_message();
-        }
-
-        // make sure any incoming request data is set on the REQ so that it gets picked up later.
-        $req_data = (array) $req_data;
-        foreach ($req_data as $request_key => $request_value) {
-            EE_Registry::instance()->REQ->set($request_key, $request_value);
-        }
-
-        if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request(
-        )) {
-            return false;
-        }
-
-        try {
-            self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
-            self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Error::add_success(
-            __('Messages have been successfully queued for generation and sending.', 'event_espresso')
-        );
-        return true; // everything got queued.
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function resend_message()
-    {
-        self::_load_controller();
-
-        $msgID = EE_Registry::instance()->REQ->get('MSG_ID');
-        if (! $msgID) {
-            EE_Error::add_error(
-                __(
-                    'Something went wrong because there is no "MSG_ID" value in the request',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
-
-        // setup success message.
-        $count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-        EE_Error::add_success(
-            sprintf(
-                _n(
-                    'There was %d message queued for resending.',
-                    'There were %d messages queued for resending.',
-                    $count_ready_for_resend,
-                    'event_espresso'
-                ),
-                $count_ready_for_resend
-            )
-        );
-        return true;
-    }
-
-
-    /**
-     * Message triggers for manual payment applied by admin
-     *
-     * @param  EE_Payment $payment EE_payment object
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function process_admin_payment(EE_Payment $payment)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        // we need to get the transaction object
-        $transaction = $payment->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $data = array($transaction, $payment);
-            $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-
-            // if payment amount is less than 0 then switch to payment_refund message type.
-            $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-
-            // if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
-            $message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved
-                ? false : $message_type;
-
-            self::_load_controller();
-
-            self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-
-            // get count of queued for generation
-            $count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
-                array(
-                    EEM_Message::status_incomplete,
-                    EEM_Message::status_idle,
-                )
-            );
-
-            if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
-                add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                return true;
-            } else {
-                $count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
-                    EEM_Message::instance()->stati_indicating_failed_sending()
-                );
-                /**
-                 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
-                 * IMMEDIATE generation.
-                 */
-                if ($count_failed > 0) {
-                    EE_Error::add_error(
-                        sprintf(
-                            _n(
-                                'The payment notification generation failed.',
-                                '%d payment notifications failed being sent.',
-                                $count_failed,
-                                'event_espresso'
-                            ),
-                            $count_failed
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-
-                    return false;
-                } else {
-                    add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                    return true;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                'Unable to generate the payment notification because the given value for the transaction is invalid.',
-                'event_espresso'
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
-     *
-     * @since   4.3.0
-     * @param  EE_Registration[] $registrations an array of EE_Registration objects
-     * @param  int               $grp_id        a specific message template group id.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_newsletter_message($registrations, $grp_id)
-    {
-        // make sure mtp is id and set it in the EE_Request Handler later messages setup.
-        EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
-     *
-     * @since   4.3.0
-     * @param    string          $registration_message_trigger_url
-     * @param    EE_Registration $registration
-     * @param string             $messenger
-     * @param string             $message_type
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function registration_message_trigger_url(
-        $registration_message_trigger_url,
-        EE_Registration $registration,
-        $messenger = 'html',
-        $message_type = 'invoice'
-    ) {
-        // whitelist $messenger
-        switch ($messenger) {
-            case 'pdf':
-                $sending_messenger = 'pdf';
-                $generating_messenger = 'html';
-                break;
-            case 'html':
-            default:
-                $sending_messenger = 'html';
-                $generating_messenger = 'html';
-                break;
-        }
-        // whitelist $message_type
-        switch ($message_type) {
-            case 'receipt':
-                $message_type = 'receipt';
-                break;
-            case 'invoice':
-            default:
-                $message_type = 'invoice';
-                break;
-        }
-        // verify that both the messenger AND the message type are active
-        if (EEH_MSG_Template::is_messenger_active($sending_messenger)
-            && EEH_MSG_Template::is_mt_active($message_type)
-        ) {
-            // need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
-            $template_query_params = array(
-                'MTP_is_active'    => true,
-                'MTP_messenger'    => $generating_messenger,
-                'MTP_message_type' => $message_type,
-                'Event.EVT_ID'     => $registration->event_ID(),
-            );
-            // get the message template group.
-            $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                // remove EVT_ID from query params so that global templates get picked up
-                unset($template_query_params['Event.EVT_ID']);
-                // get global template as the fallback
-                $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            }
-            // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                return '';
-            }
-            // generate the URL
-            $registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
-                $sending_messenger,
-                $generating_messenger,
-                'purchaser',
-                $message_type,
-                $registration,
-                $msg_template_group->ID(),
-                $registration->transaction_ID()
-            );
-        }
-        return $registration_message_trigger_url;
-    }
-
-
-    /**
-     * Use to generate and return a message preview!
-     *
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return bool|string The body of the message or if send is requested, sends.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function preview_message($type, $context, $messenger, $send = false)
-    {
-        self::_load_controller();
-        $mtg = new EE_Message_To_Generate(
-            $messenger,
-            $type,
-            array(),
-            $context,
-            true
-        );
-        $generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
-        if ($generated_preview_queue instanceof EE_Messages_Queue) {
-            // loop through all content for the preview and remove any persisted records.
-            $content = '';
-            foreach ($generated_preview_queue->get_message_repository() as $message) {
-                $content = $message->content();
-                if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
-                    $message->delete();
-                }
-            }
-            return $content;
-        } else {
-            return $generated_preview_queue;
-        }
-    }
-
-
-    /**
-     * This is a method that allows for sending a message using a messenger matching the string given and the provided
-     * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
-     * content found in the EE_Message objects in the queue.
-     *
-     * @since 4.9.0
-     * @param string            $messenger            a string matching a valid active messenger in the system
-     * @param string            $message_type         Although it seems contrary to the name of the method, a message
-     *                                                type name is still required to send along the message type to the
-     *                                                messenger because this is used for determining what specific
-     *                                                variations might be loaded for the generated message.
-     * @param EE_Messages_Queue $queue
-     * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
-     *                                                aggregate EE_Message object.
-     * @return bool success or fail.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function send_message_with_messenger_only(
-        $messenger,
-        $message_type,
-        EE_Messages_Queue $queue,
-        $custom_subject = ''
-    ) {
-        self::_load_controller();
-        /** @type EE_Message_To_Generate_From_Queue $message_to_generate */
-        $message_to_generate = EE_Registry::instance()->load_lib(
-            'Message_To_Generate_From_Queue',
-            array(
-                $messenger,
-                $message_type,
-                $queue,
-                $custom_subject,
-            )
-        );
-        return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
-    }
-
-
-    /**
-     * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of message ids
-     * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
-     *                           messages.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_now($message_ids)
-    {
-        self::_load_controller();
-        $messages = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => EEM_Message::status_incomplete,
-                ),
-            )
-        );
-        $generated_queue = false;
-        if ($messages) {
-            $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
-        }
-
-        if (! $generated_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __(
-                    'The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $generated_queue;
-    }
-
-
-    /**
-     * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
-     * EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     * @param $message_ids
-     * @return bool|EE_Messages_Queue false if no messages sent.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_now($message_ids)
-    {
-        self::_load_controller();
-        $messages = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
-                    ),
-                ),
-            )
-        );
-        $sent_queue = false;
-        if ($messages) {
-            $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
-        }
-
-        if (! $sent_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __(
-                    'The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            // can count how many sent by using the messages in the queue
-            $sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
-            if ($sent_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully sent.',
-                            'There were %d messages successfully sent.',
-                            $sent_count,
-                            'event_espresso'
-                        ),
-                        $sent_count
-                    )
-                );
-            } else {
-                EE_Error::overwrite_errors();
-                EE_Error::add_error(
-                    __(
-                        'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
+				exit;
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *  This runs when the msg_url_trigger route has initiated.
+	 *
+	 * @since 4.5.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function run($WP)
+	{
+		// ensure controller is loaded
+		self::_load_controller();
+		// attempt to process message
+		try {
+			/** @type EE_Message_To_Generate_From_Request $message_to_generate */
+			$message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+			self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
+		} catch (EE_Error $e) {
+			$error_msg = __(
+				'Please note that a system message failed to send due to a technical issue.',
+				'event_espresso'
+			);
+			// add specific message for developers if WP_DEBUG in on
+			$error_msg .= '||' . $e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * This is triggered by the 'msg_cron_trigger' route.
+	 *
+	 * @param WP $WP
+	 */
+	public function execute_batch_request($WP)
+	{
+		$this->run_cron();
+		header('HTTP/1.1 200 OK');
+		exit();
+	}
+
+
+	/**
+	 * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
+	 * request.
+	 */
+	public function run_cron()
+	{
+		self::_load_controller();
+		// get required vars
+		$cron_type = EE_Registry::instance()->REQ->get('type');
+		$transient_key = EE_Registry::instance()->REQ->get('key');
+
+		// now let's verify transient, if not valid exit immediately
+		if (! get_transient($transient_key)) {
+			/**
+			 * trigger error so this gets in the error logs.  This is important because it happens on a non-user
+			 * request.
+			 */
+			trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
+		}
+
+		// if made it here, lets' delete the transient to keep the db clean
+		delete_transient($transient_key);
+
+		if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
+			$method = 'batch_' . $cron_type . '_from_queue';
+			if (method_exists(self::$_MSG_PROCESSOR, $method)) {
+				self::$_MSG_PROCESSOR->$method();
+			} else {
+				// no matching task
+				/**
+				 * trigger error so this gets in the error logs.  This is important because it happens on a non user
+				 * request.
+				 */
+				trigger_error(
+					esc_attr(
+						sprintf(
+							__('There is no task corresponding to this route %s', 'event_espresso'),
+							$cron_type
+						)
+					)
+				);
+			}
+		}
+
+		do_action('FHEE__EED_Messages__run_cron__end');
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
+	 * the default template pack is returned.
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
+	 * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
+	 *                                   in generating the Pack class name).
+	 * @return EE_Messages_Template_Pack
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($template_pack_name);
+	}
+
+
+	/**
+	 * Retrieves an array of all template packs.
+	 * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
+	 * @return EE_Messages_Template_Pack[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_packs()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+
+		// for backward compat, let's make sure this returns in the same format as originally.
+		$template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
+		$template_pack_collection->rewind();
+		$template_packs = array();
+		while ($template_pack_collection->valid()) {
+			$template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
+			$template_pack_collection->next();
+		}
+		return $template_packs;
+	}
+
+
+	/**
+	 * This simply makes sure the autoloaders are registered for the EE_messages system.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function set_autoloaders()
+	{
+		if (empty(self::$_MSG_PATHS)) {
+			self::_set_messages_paths();
+			foreach (self::$_MSG_PATHS as $path) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
+			}
+			// add aliases
+			EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
+			EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
+		}
+	}
+
+
+	/**
+	 * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
+	 * for use by the Messages Autoloaders
+	 *
+	 * @since 4.5.0
+	 * @return void.
+	 */
+	protected static function _set_messages_paths()
+	{
+		$dir_ref = array(
+			'messages/message_type',
+			'messages/messenger',
+			'messages/defaults',
+			'messages/defaults/email',
+			'messages/data_class',
+			'messages/validators',
+			'messages/validators/email',
+			'messages/validators/html',
+			'shortcodes',
+		);
+		$paths = array();
+		foreach ($dir_ref as $index => $dir) {
+			$paths[ $index ] = EE_LIBRARIES . $dir;
+		}
+		self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
+	}
+
+
+	/**
+	 * Takes care of loading dependencies
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _load_controller()
+	{
+		if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+			EE_Registry::instance()->load_core('Request_Handler');
+			self::set_autoloaders();
+			self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
+			self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib('Messages_Processor');
+			self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		}
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function payment_reminder(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
+	}
+
+
+	/**
+	 * Any messages triggers for after successful gateway payments should go in here.
+	 *
+	 * @param EE_Transaction  $transaction object
+	 * @param EE_Payment|null $payment     object
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
+	{
+		// if there's no payment object, then we cannot do a payment type message!
+		if (! $payment instanceof EE_Payment) {
+			return;
+		}
+		self::_load_controller();
+		$data = array($transaction, $payment);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+		// if payment amount is less than 0 then switch to payment_refund message type.
+		$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function cancelled_registration(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
+	}
+
+
+	/**
+	 * Trigger for Registration messages
+	 * Note that what registration message type is sent depends on what the reg status is for the registrations on the
+	 * incoming transaction.
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $extra_details
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 */
+	public static function maybe_registration(EE_Registration $registration, $extra_details = array())
+	{
+
+		if (! self::_verify_registration_notification_send($registration, $extra_details)) {
+			// no messages please
+			return;
+		}
+
+		// get all non-trashed registrations so we make sure we send messages for the right status.
+		$all_registrations = $registration->transaction()->registrations(
+			array(
+				array('REG_deleted' => false),
+				'order_by' => array(
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+				),
+			)
+		);
+		// cached array of statuses so we only trigger messages once per status.
+		$statuses_sent = array();
+		self::_load_controller();
+		$mtgs = array();
+
+		// loop through registrations and trigger messages once per status.
+		foreach ($all_registrations as $reg) {
+			// already triggered?
+			if (in_array($reg->status_ID(), $statuses_sent)) {
+				continue;
+			}
+
+			$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
+			$mtgs = array_merge(
+				$mtgs,
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+					$message_type,
+					array($registration->transaction(), null, $reg->status_ID())
+				)
+			);
+			$statuses_sent[] = $reg->status_ID();
+		}
+
+		if (count($statuses_sent) > 1) {
+			$mtgs = array_merge(
+				$mtgs,
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+					'registration_summary',
+					array($registration->transaction(), null)
+				)
+			);
+		}
+
+		// batch queue and initiate request
+		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
+		self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+	}
+
+
+	/**
+	 * This is a helper method used to very whether a registration notification should be sent or
+	 * not.  Prevents duplicate notifications going out for registration context notifications.
+	 *
+	 * @param EE_Registration $registration  [description]
+	 * @param array           $extra_details [description]
+	 * @return bool          true = send away, false = nope halt the presses.
+	 */
+	protected static function _verify_registration_notification_send(
+		EE_Registration $registration,
+		$extra_details = array()
+	) {
+		if (! $registration->is_primary_registrant()) {
+			return false;
+		}
+		// first we check if we're in admin and not doing front ajax
+		if (is_admin() && ! EE_FRONT_AJAX) {
+			// make sure appropriate admin params are set for sending messages
+			if (empty($_REQUEST['txn_reg_status_change']['send_notifications'])
+				|| ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])
+			) {
+				// no messages sent please.
+				return false;
+			}
+		} else {
+			// frontend request (either regular or via AJAX)
+			// TXN is NOT finalized ?
+			if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
+				return false;
+			}
+			// return visit but nothing changed ???
+			if (isset($extra_details['revisit'], $extra_details['status_updates']) &&
+				$extra_details['revisit'] && ! $extra_details['status_updates']
+			) {
+				return false;
+			}
+			// NOT sending messages && reg status is something other than "Not-Approved"
+			if (! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
+				$registration->status_ID() !== EEM_Registration::status_id_not_approved
+			) {
+				return false;
+			}
+		}
+		// release the kraken
+		return true;
+	}
+
+
+	/**
+	 * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
+	 * status id.
+	 *
+	 * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
+	 *                    or EEH_MSG_Template::convert_reg_status_to_message_type
+	 * @param string $reg_status
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_reg_status_array($reg_status = '')
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			: EEH_MSG_Template::reg_status_to_message_type_array();
+	}
+
+
+	/**
+	 * Simply returns the payment message type for the given payment status.
+	 *
+	 * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
+	 *                   or EEH_MSG_Template::convert_payment_status_to_message_type
+	 * @param string $payment_status The payment status being matched.
+	 * @return bool|string The payment message type slug matching the status or false if no match.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_payment_message_type($payment_status)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			: false;
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @access public
+	 * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function process_resend($req_data)
+	{
+		self::_load_controller();
+
+		// if $msgID in this request then skip to the new resend_message
+		if (EE_Registry::instance()->REQ->get('MSG_ID')) {
+			return self::resend_message();
+		}
+
+		// make sure any incoming request data is set on the REQ so that it gets picked up later.
+		$req_data = (array) $req_data;
+		foreach ($req_data as $request_key => $request_value) {
+			EE_Registry::instance()->REQ->set($request_key, $request_value);
+		}
+
+		if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request(
+		)) {
+			return false;
+		}
+
+		try {
+			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
+			self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Error::add_success(
+			__('Messages have been successfully queued for generation and sending.', 'event_espresso')
+		);
+		return true; // everything got queued.
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function resend_message()
+	{
+		self::_load_controller();
+
+		$msgID = EE_Registry::instance()->REQ->get('MSG_ID');
+		if (! $msgID) {
+			EE_Error::add_error(
+				__(
+					'Something went wrong because there is no "MSG_ID" value in the request',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
+
+		// setup success message.
+		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+		EE_Error::add_success(
+			sprintf(
+				_n(
+					'There was %d message queued for resending.',
+					'There were %d messages queued for resending.',
+					$count_ready_for_resend,
+					'event_espresso'
+				),
+				$count_ready_for_resend
+			)
+		);
+		return true;
+	}
+
+
+	/**
+	 * Message triggers for manual payment applied by admin
+	 *
+	 * @param  EE_Payment $payment EE_payment object
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function process_admin_payment(EE_Payment $payment)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		// we need to get the transaction object
+		$transaction = $payment->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$data = array($transaction, $payment);
+			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+
+			// if payment amount is less than 0 then switch to payment_refund message type.
+			$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+
+			// if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
+			$message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved
+				? false : $message_type;
+
+			self::_load_controller();
+
+			self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+
+			// get count of queued for generation
+			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
+				array(
+					EEM_Message::status_incomplete,
+					EEM_Message::status_idle,
+				)
+			);
+
+			if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
+				add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+				return true;
+			} else {
+				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
+					EEM_Message::instance()->stati_indicating_failed_sending()
+				);
+				/**
+				 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
+				 * IMMEDIATE generation.
+				 */
+				if ($count_failed > 0) {
+					EE_Error::add_error(
+						sprintf(
+							_n(
+								'The payment notification generation failed.',
+								'%d payment notifications failed being sent.',
+								$count_failed,
+								'event_espresso'
+							),
+							$count_failed
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+
+					return false;
+				} else {
+					add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+					return true;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				'Unable to generate the payment notification because the given value for the transaction is invalid.',
+				'event_espresso'
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
+	 *
+	 * @since   4.3.0
+	 * @param  EE_Registration[] $registrations an array of EE_Registration objects
+	 * @param  int               $grp_id        a specific message template group id.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_newsletter_message($registrations, $grp_id)
+	{
+		// make sure mtp is id and set it in the EE_Request Handler later messages setup.
+		EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
+	 *
+	 * @since   4.3.0
+	 * @param    string          $registration_message_trigger_url
+	 * @param    EE_Registration $registration
+	 * @param string             $messenger
+	 * @param string             $message_type
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function registration_message_trigger_url(
+		$registration_message_trigger_url,
+		EE_Registration $registration,
+		$messenger = 'html',
+		$message_type = 'invoice'
+	) {
+		// whitelist $messenger
+		switch ($messenger) {
+			case 'pdf':
+				$sending_messenger = 'pdf';
+				$generating_messenger = 'html';
+				break;
+			case 'html':
+			default:
+				$sending_messenger = 'html';
+				$generating_messenger = 'html';
+				break;
+		}
+		// whitelist $message_type
+		switch ($message_type) {
+			case 'receipt':
+				$message_type = 'receipt';
+				break;
+			case 'invoice':
+			default:
+				$message_type = 'invoice';
+				break;
+		}
+		// verify that both the messenger AND the message type are active
+		if (EEH_MSG_Template::is_messenger_active($sending_messenger)
+			&& EEH_MSG_Template::is_mt_active($message_type)
+		) {
+			// need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
+			$template_query_params = array(
+				'MTP_is_active'    => true,
+				'MTP_messenger'    => $generating_messenger,
+				'MTP_message_type' => $message_type,
+				'Event.EVT_ID'     => $registration->event_ID(),
+			);
+			// get the message template group.
+			$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			// if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				// remove EVT_ID from query params so that global templates get picked up
+				unset($template_query_params['Event.EVT_ID']);
+				// get global template as the fallback
+				$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			}
+			// if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				return '';
+			}
+			// generate the URL
+			$registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
+				$sending_messenger,
+				$generating_messenger,
+				'purchaser',
+				$message_type,
+				$registration,
+				$msg_template_group->ID(),
+				$registration->transaction_ID()
+			);
+		}
+		return $registration_message_trigger_url;
+	}
+
+
+	/**
+	 * Use to generate and return a message preview!
+	 *
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return bool|string The body of the message or if send is requested, sends.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function preview_message($type, $context, $messenger, $send = false)
+	{
+		self::_load_controller();
+		$mtg = new EE_Message_To_Generate(
+			$messenger,
+			$type,
+			array(),
+			$context,
+			true
+		);
+		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
+		if ($generated_preview_queue instanceof EE_Messages_Queue) {
+			// loop through all content for the preview and remove any persisted records.
+			$content = '';
+			foreach ($generated_preview_queue->get_message_repository() as $message) {
+				$content = $message->content();
+				if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
+					$message->delete();
+				}
+			}
+			return $content;
+		} else {
+			return $generated_preview_queue;
+		}
+	}
+
+
+	/**
+	 * This is a method that allows for sending a message using a messenger matching the string given and the provided
+	 * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
+	 * content found in the EE_Message objects in the queue.
+	 *
+	 * @since 4.9.0
+	 * @param string            $messenger            a string matching a valid active messenger in the system
+	 * @param string            $message_type         Although it seems contrary to the name of the method, a message
+	 *                                                type name is still required to send along the message type to the
+	 *                                                messenger because this is used for determining what specific
+	 *                                                variations might be loaded for the generated message.
+	 * @param EE_Messages_Queue $queue
+	 * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
+	 *                                                aggregate EE_Message object.
+	 * @return bool success or fail.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function send_message_with_messenger_only(
+		$messenger,
+		$message_type,
+		EE_Messages_Queue $queue,
+		$custom_subject = ''
+	) {
+		self::_load_controller();
+		/** @type EE_Message_To_Generate_From_Queue $message_to_generate */
+		$message_to_generate = EE_Registry::instance()->load_lib(
+			'Message_To_Generate_From_Queue',
+			array(
+				$messenger,
+				$message_type,
+				$queue,
+				$custom_subject,
+			)
+		);
+		return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
+	}
+
+
+	/**
+	 * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of message ids
+	 * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
+	 *                           messages.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_now($message_ids)
+	{
+		self::_load_controller();
+		$messages = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => EEM_Message::status_incomplete,
+				),
+			)
+		);
+		$generated_queue = false;
+		if ($messages) {
+			$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
+		}
+
+		if (! $generated_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__(
+					'The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $generated_queue;
+	}
+
+
+	/**
+	 * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
+	 * EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 * @param $message_ids
+	 * @return bool|EE_Messages_Queue false if no messages sent.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_now($message_ids)
+	{
+		self::_load_controller();
+		$messages = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
+					),
+				),
+			)
+		);
+		$sent_queue = false;
+		if ($messages) {
+			$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
+		}
+
+		if (! $sent_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__(
+					'The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			// can count how many sent by using the messages in the queue
+			$sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
+			if ($sent_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'There was %d message successfully sent.',
+							'There were %d messages successfully sent.',
+							$sent_count,
+							'event_espresso'
+						),
+						$sent_count
+					)
+				);
+			} else {
+				EE_Error::overwrite_errors();
+				EE_Error::add_error(
+					__(
+						'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
 					If there was an error, you can look at the messages in the message activity list table for any error messages.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return $sent_queue;
-    }
-
-
-    /**
-     * Generate and send immediately from the given $message_ids
-     *
-     * @param array $message_ids EE_Message entity ids.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_and_send_now(array $message_ids)
-    {
-        $generated_queue = self::generate_now($message_ids);
-        // now let's just trigger sending immediately from this queue.
-        $messages_sent = $generated_queue instanceof EE_Messages_Queue
-            ? $generated_queue->execute()
-            : 0;
-        if ($messages_sent) {
-            EE_Error::add_success(
-                esc_html(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully generated and sent.',
-                            'There were %d messages successfully generated and sent.',
-                            $messages_sent,
-                            'event_espresso'
-                        ),
-                        $messages_sent
-                    )
-                )
-            );
-            // errors would be added via the generate_now method.
-        }
-    }
-
-
-    /**
-     * This will queue the incoming message ids for resending.
-     * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of EE_Message IDs
-     * @return bool true means messages were successfully queued for resending, false means none were queued for
-     *                           resending.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function queue_for_resending($message_ids)
-    {
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
-
-        // get queue and count
-        $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-
-        if ($queue_count > 0
-        ) {
-            EE_Error::add_success(
-                sprintf(
-                    _n(
-                        '%d message successfully queued for resending.',
-                        '%d messages successfully queued for resending.',
-                        $queue_count,
-                        'event_espresso'
-                    ),
-                    $queue_count
-                )
-            );
-            /**
-             * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
-             */
-        } elseif (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
-            if ($queue_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            '%d message successfully sent.',
-                            '%d messages successfully sent.',
-                            $queue_count,
-                            'event_espresso'
-                        ),
-                        $queue_count
-                    )
-                );
-            } else {
-                EE_Error::add_error(
-                    __(
-                        'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return (bool) $queue_count;
-    }
-
-
-    /**
-     * debug
-     *
-     * @param string          $class
-     * @param string          $func
-     * @param string          $line
-     * @param \EE_Transaction $transaction
-     * @param array           $info
-     * @param bool            $display_request
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    protected static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        EE_Transaction $transaction,
-        $info = array(),
-        $display_request = false
-    ) {
-        if (defined('EE_DEBUG') && EE_DEBUG) {
-            if ($transaction instanceof EE_Transaction) {
-                // don't serialize objects
-                $info = EEH_Debug_Tools::strip_objects($info);
-                $info['TXN_status'] = $transaction->status_ID();
-                $info['TXN_reg_steps'] = $transaction->reg_steps();
-                if ($transaction->ID()) {
-                    $index = 'EE_Transaction: ' . $transaction->ID();
-                    EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
-                }
-            }
-        }
-    }
-
-
-    /**
-     *  Resets all the static properties in this class when called.
-     */
-    public static function reset()
-    {
-        self::$_EEMSG = null;
-        self::$_message_resource_manager = null;
-        self::$_MSG_PROCESSOR = null;
-        self::$_MSG_PATHS = null;
-        self::$_TMP_PACKS = array();
-    }
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return $sent_queue;
+	}
+
+
+	/**
+	 * Generate and send immediately from the given $message_ids
+	 *
+	 * @param array $message_ids EE_Message entity ids.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_and_send_now(array $message_ids)
+	{
+		$generated_queue = self::generate_now($message_ids);
+		// now let's just trigger sending immediately from this queue.
+		$messages_sent = $generated_queue instanceof EE_Messages_Queue
+			? $generated_queue->execute()
+			: 0;
+		if ($messages_sent) {
+			EE_Error::add_success(
+				esc_html(
+					sprintf(
+						_n(
+							'There was %d message successfully generated and sent.',
+							'There were %d messages successfully generated and sent.',
+							$messages_sent,
+							'event_espresso'
+						),
+						$messages_sent
+					)
+				)
+			);
+			// errors would be added via the generate_now method.
+		}
+	}
+
+
+	/**
+	 * This will queue the incoming message ids for resending.
+	 * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of EE_Message IDs
+	 * @return bool true means messages were successfully queued for resending, false means none were queued for
+	 *                           resending.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function queue_for_resending($message_ids)
+	{
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
+
+		// get queue and count
+		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+
+		if ($queue_count > 0
+		) {
+			EE_Error::add_success(
+				sprintf(
+					_n(
+						'%d message successfully queued for resending.',
+						'%d messages successfully queued for resending.',
+						$queue_count,
+						'event_espresso'
+					),
+					$queue_count
+				)
+			);
+			/**
+			 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
+			 */
+		} elseif (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
+			if ($queue_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'%d message successfully sent.',
+							'%d messages successfully sent.',
+							$queue_count,
+							'event_espresso'
+						),
+						$queue_count
+					)
+				);
+			} else {
+				EE_Error::add_error(
+					__(
+						'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return (bool) $queue_count;
+	}
+
+
+	/**
+	 * debug
+	 *
+	 * @param string          $class
+	 * @param string          $func
+	 * @param string          $line
+	 * @param \EE_Transaction $transaction
+	 * @param array           $info
+	 * @param bool            $display_request
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	protected static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		EE_Transaction $transaction,
+		$info = array(),
+		$display_request = false
+	) {
+		if (defined('EE_DEBUG') && EE_DEBUG) {
+			if ($transaction instanceof EE_Transaction) {
+				// don't serialize objects
+				$info = EEH_Debug_Tools::strip_objects($info);
+				$info['TXN_status'] = $transaction->status_ID();
+				$info['TXN_reg_steps'] = $transaction->reg_steps();
+				if ($transaction->ID()) {
+					$index = 'EE_Transaction: ' . $transaction->ID();
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *  Resets all the static properties in this class when called.
+	 */
+	public static function reset()
+	{
+		self::$_EEMSG = null;
+		self::$_message_resource_manager = null;
+		self::$_MSG_PROCESSOR = null;
+		self::$_MSG_PATHS = null;
+		self::$_TMP_PACKS = array();
+	}
 }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.68.rc.008');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.68.rc.008');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/EE_Session.core.php

Indentation +1261 added lines, -1261 removed lines

@@ -25,1259 +25,1259 @@ 
 class EE_Session implements SessionIdentifierInterface
 {
 
-    const session_id_prefix = 'ee_ssn_';
-
-    const hash_check_prefix = 'ee_shc_';
-
-    const OPTION_NAME_SETTINGS = 'ee_session_settings';
-
-    const STATUS_CLOSED = 0;
-
-    const STATUS_OPEN = 1;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session
-     */
-    private static $_instance;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    protected $cache_storage;
-
-    /**
-     * @var EE_Encryption $encryption
-     */
-    protected $encryption;
-
-    /**
-     * @var SessionStartHandler $session_start_handler
-     */
-    protected $session_start_handler;
-
-    /**
-     * the session id
-     *
-     * @var string
-     */
-    private $_sid;
-
-    /**
-     * session id salt
-     *
-     * @var string
-     */
-    private $_sid_salt;
-
-    /**
-     * session data
-     *
-     * @var array
-     */
-    private $_session_data = array();
-
-    /**
-     * how long an EE session lasts
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    /**
-     * session expiration time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_expiration;
-
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
-
-    /**
-     * current time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_time;
-
-    /**
-     * whether to encrypt session data
-     *
-     * @var bool
-     */
-    private $_use_encryption;
-
-    /**
-     * well... according to the server...
-     *
-     * @var null
-     */
-    private $_user_agent;
-
-    /**
-     * do you really trust the server ?
-     *
-     * @var null
-     */
-    private $_ip_address;
-
-    /**
-     * current WP user_id
-     *
-     * @var null
-     */
-    private $_wp_user_id;
-
-    /**
-     * array for defining default session vars
-     *
-     * @var array
-     */
-    private $_default_session_vars = array(
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
-    );
-
-    /**
-     * timestamp for when last garbage collection cycle was performed
-     *
-     * @var int $_last_gc
-     */
-    private $_last_gc;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * whether session is active or not
-     *
-     * @var int $status
-     */
-    private $status = EE_Session::STATUS_CLOSED;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan|null  $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @return EE_Session
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        SessionLifespan $lifespan = null,
-        RequestInterface $request = null,
-        SessionStartHandler $session_start_handler = null,
-        EE_Encryption $encryption = null
-    ) {
-        // check if class object is instantiated
-        // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
-        // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
-            self::$_instance = new self(
-                $cache_storage,
-                $lifespan,
-                $request,
-                $session_start_handler,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        SessionStartHandler $session_start_handler,
-        EE_Encryption $encryption = null
-    ) {
-        // session loading is turned ON by default,
-        // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
-        // (which currently fires on the init hook at priority 9),
-        // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
-            return;
-        }
-        $this->session_start_handler = $session_start_handler;
-        $this->session_lifespan = $lifespan;
-        $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
-            define('ESPRESSO_SESSION', true);
-        }
-        // retrieve session options from db
-        $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
-            // cycle though existing session options
-            foreach ($session_settings as $var_name => $session_setting) {
-                // set values for class properties
-                $var_name = '_' . $var_name;
-                $this->{$var_name} = $session_setting;
-            }
-        }
-        $this->cache_storage = $cache_storage;
-        // are we using encryption?
-        $this->_use_encryption = $encryption instanceof EE_Encryption
-                                 && EE_Registry::instance()->CFG->admin->encode_session_data();
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
-        // filter hook allows outside functions/classes/plugins to change default empty cart
-        $extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
-        array_merge($this->_default_session_vars, $extra_default_session_vars);
-        // apply default session vars
-        $this->_set_defaults();
-        add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
-        // check request for 'clear_session' param
-        add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
-        // once everything is all said and done,
-        add_action('shutdown', array($this, 'update'), 100);
-        add_action('shutdown', array($this, 'garbageCollection'), 1000);
-        $this->configure_garbage_collection_filters();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function isLoadedAndActive()
-    {
-        return did_action('AHEE__EE_System__core_loaded_and_ready')
-               && EE_Session::instance() instanceof EE_Session
-               && EE_Session::instance()->isActive();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->status === EE_Session::STATUS_OPEN;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     */
-    public function open_session()
-    {
-        // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
-            // or just start a new one
-            $this->_create_espresso_session();
-        }
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function expiration()
-    {
-        return $this->_expiration;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
-    }
-
-
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function lifespan()
-    {
-        return $this->session_lifespan->inSeconds();
-    }
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        // set some defaults
-        foreach ($this->_default_session_vars as $key => $default_var) {
-            if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
-            } else {
-                $this->_session_data[ $key ] = '';
-            }
-        }
-    }
-
-
-    /**
-     * @retrieve  session data
-     * @access    public
-     * @return    string
-     */
-    public function id()
-    {
-        return $this->_sid;
-    }
-
-
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        return true;
-    }
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-    }
-
-
-    /**
-     * @return \EE_Cart
-     */
-    public function cart()
-    {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Checkout $checkout
-     * @return bool
-     */
-    public function set_checkout(EE_Checkout $checkout)
-    {
-        $this->_session_data['checkout'] = $checkout;
-        return true;
-    }
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-    }
-
-
-    /**
-     * @return \EE_Checkout
-     */
-    public function checkout()
-    {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return bool
-     * @throws EE_Error
-     */
-    public function set_transaction(EE_Transaction $transaction)
-    {
-        // first remove the session from the transaction before we save the transaction in the session
-        $transaction->set_txn_session_data(null);
-        $this->_session_data['transaction'] = $transaction;
-        return true;
-    }
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-    }
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param null $key
-     * @param bool $reset_cache
-     * @return array
-     */
-    public function get_session_data($key = null, $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data($data)
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data) || ! is_array($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-        }
-        return true;
-    }
-
-
-    /**
-     * @initiate session
-     * @access   private
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     */
-    private function _espresso_session()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->session_start_handler->startSession();
-        $this->status = EE_Session::STATUS_OPEN;
-        // get our modified session ID
-        $this->_sid = $this->_generate_session_id();
-        // and the visitors IP
-        $this->_ip_address = $this->request->ipAddress();
-        // set the "user agent"
-        $this->_user_agent = $this->request->userAgent();
-        // now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
-            // get the current time in UTC
-            $this->_time = $this->_time !== null ? $this->_time : time();
-            // and reset the session expiration
-            $this->_expiration = isset($session_data['expiration'])
-                ? $session_data['expiration']
-                : $this->_time + $this->session_lifespan->inSeconds();
-        } else {
-            // set initial site access time and the session expiration
-            $this->_set_init_access_and_expiration();
-            // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
-                ? esc_attr($_SERVER['HTTP_REFERER'])
-                : '';
-            // no previous session = go back and create one (on top of the data above)
-            return false;
-        }
-        // now the user agent
-        if ($session_data['user_agent'] !== $this->_user_agent) {
-            return false;
-        }
-        // wait a minute... how old are you?
-        if ($this->_time > $this->_expiration) {
-            // yer too old fer me!
-            $this->_expired = true;
-            // wipe out everything that isn't a default session datum
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // make event espresso session data available to plugin
-        $this->_session_data = array_merge($this->_session_data, $session_data);
-        return true;
-    }
-
-
-    /**
-     * _get_session_data
-     * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
-     * databases
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidSessionDataException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _retrieve_session_data()
-    {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-        try {
-            // we're using WP's Transient API to store session data using the PHP session ID as the option name
-            $session_data = $this->cache_storage->get($ssn_key, false);
-            if (empty($session_data)) {
-                return array();
-            }
-            if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
-                    false
-                );
-                if ($hash_check && $hash_check !== md5($session_data)) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
-                                'event_espresso'
-                            ),
-                            EE_Session::session_id_prefix . $this->_sid
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } catch (Exception $e) {
-            // let's just eat that error for now and attempt to correct any corrupted data
-            global $wpdb;
-            $row = $wpdb->get_row(
-                $wpdb->prepare(
-                    "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
-                )
-            );
-            $session_data = is_object($row) ? $row->option_value : null;
-            if ($session_data) {
-                $session_data = preg_replace_callback(
-                    '!s:(d+):"(.*?)";!',
-                    function ($match) {
-                        return $match[1] === strlen($match[2])
-                            ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                    },
-                    $session_data
-                );
-            }
-            $session_data = maybe_unserialize($session_data);
-        }
-        // in case the data is encoded... try to decode it
-        $session_data = $this->encryption instanceof EE_Encryption
-            ? $this->encryption->base64_string_decode($session_data)
-            : $session_data;
-        if (! is_array($session_data)) {
-            try {
-                $session_data = maybe_unserialize($session_data);
-            } catch (Exception $e) {
-                $msg = esc_html__(
-                    'An error occurred while attempting to unserialize the session data.',
-                    'event_espresso'
-                );
-                $msg .= WP_DEBUG
-                    ? '<br><pre>'
-                      . print_r($session_data, true)
-                      . '</pre><br>'
-                      . $this->find_serialize_error($session_data)
-                    : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-                throw new InvalidSessionDataException($msg, 0, $e);
-            }
-        }
-        // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
-            // no?!?! then something is wrong
-            $msg = esc_html__(
-                'The session data is missing, invalid, or corrupted.',
-                'event_espresso'
-            );
-            $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-            throw new InvalidSessionDataException($msg);
-        }
-        if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
-            $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-                $session_data['transaction']
-            );
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * _generate_session_id
-     * Retrieves the PHP session id either directly from the PHP session,
-     * or from the $_REQUEST array if it was passed in from an AJAX request.
-     * The session id is then salted and hashed (mmm sounds tasty)
-     * so that it can be safely used as a $_REQUEST param
-     *
-     * @return string
-     */
-    protected function _generate_session_id()
-    {
-        // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-        if (isset($_REQUEST['EESID'])) {
-            $session_id = sanitize_text_field($_REQUEST['EESID']);
-        } else {
-            $session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
-        }
-        return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
-    }
-
-
-    /**
-     * _get_sid_salt
-     *
-     * @return string
-     */
-    protected function _get_sid_salt()
-    {
-        // was session id salt already saved to db ?
-        if (empty($this->_sid_salt)) {
-            // no?  then maybe use WP defined constant
-            if (defined('AUTH_SALT')) {
-                $this->_sid_salt = AUTH_SALT;
-            }
-            // if salt doesn't exist or is too short
-            if (strlen($this->_sid_salt) < 32) {
-                // create a new one
-                $this->_sid_salt = wp_generate_password(64);
-            }
-            // and save it as a permanent session setting
-            $this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
-        }
-        return $this->_sid_salt;
-    }
-
-
-    /**
-     * _set_init_access_and_expiration
-     *
-     * @return void
-     */
-    protected function _set_init_access_and_expiration()
-    {
-        $this->_time = time();
-        $this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
-        // set initial site access time
-        $this->_session_data['init_access'] = $this->_time;
-        // and the session expiration
-        $this->_session_data['expiration'] = $this->_expiration;
-    }
-
-
-    /**
-     * @update session data  prior to saving to the db
-     * @access public
-     * @param bool $new_session
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update($new_session = false)
-    {
-        $this->_session_data = $this->_session_data !== null
-                               && is_array($this->_session_data)
-                               && isset($this->_session_data['id'])
-            ? $this->_session_data
-            : array();
-        if (empty($this->_session_data)) {
-            $this->_set_defaults();
-        }
-        $session_data = array();
-        foreach ($this->_session_data as $key => $value) {
-            switch ($key) {
-                case 'id':
-                    // session ID
-                    $session_data['id'] = $this->_sid;
-                    break;
-                case 'ip_address':
-                    // visitor ip address
-                    $session_data['ip_address'] = $this->request->ipAddress();
-                    break;
-                case 'user_agent':
-                    // visitor user_agent
-                    $session_data['user_agent'] = $this->_user_agent;
-                    break;
-                case 'init_access':
-                    $session_data['init_access'] = absint($value);
-                    break;
-                case 'last_access':
-                    // current access time
-                    $session_data['last_access'] = $this->_time;
-                    break;
-                case 'expiration':
-                    // when the session expires
-                    $session_data['expiration'] = ! empty($this->_expiration)
-                        ? $this->_expiration
-                        : $session_data['init_access'] + $this->session_lifespan->inSeconds();
-                    break;
-                case 'user_id':
-                    // current user if logged in
-                    $session_data['user_id'] = $this->_wp_user_id();
-                    break;
-                case 'pages_visited':
-                    $page_visit = $this->_get_page_visit();
-                    if ($page_visit) {
-                        // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
-                        // we'll only save the last 10 page visits.
-                        $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
-                    }
-                    break;
-                default:
-                    // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
-            }
-        }
-        $this->_session_data = $session_data;
-        // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
-            // ready? let's save
-            if ($this->_save_session_to_db()) {
-                return true;
-            }
-            return false;
-        }
-        // meh, why not?
-        return true;
-    }
-
-
-    /**
-     * @create session data array
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        return $this->update(true) ? true : false;
-    }
-
-    /**
-     * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
-     * too). This is used when determining if we want to save the session or not.
-     * @since 4.9.67.p
-     * @return bool
-     */
-    private function sessionHasStuffWorthSaving()
-    {
-        return $this->cart() instanceof EE_Cart
-            || (
-                isset($this->_session_data['ee_notices'])
-                && (
-                    ! empty($this->_session_data['ee_notices']['attention'])
-                    || !empty($this->_session_data['ee_notices']['errors'])
-                    || !empty($this->_session_data['ee_notices']['success'])
-                )
-            );
-    }
-    /**
-     * _save_session_to_db
-     *
-     * @param bool $clear_session
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _save_session_to_db($clear_session = false)
-    {
-        // don't save sessions for crawlers
-        // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if ($this->request->isBot()
-            || (
-                ! $clear_session
-                && ! $this->sessionHasStuffWorthSaving()
-                && apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
-            )
-        ) {
-            return false;
-        }
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
-                $transaction->save();
-            }
-            $this->_session_data['transaction'] = $transaction->ID();
-        }
-        // then serialize all of our session data
-        $session_data = serialize($this->_session_data);
-        // do we need to also encode it to avoid corrupted data when saved to the db?
-        $session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode($session_data)
-            : $session_data;
-        // maybe save hash check
-        if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-            $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
-                md5($session_data),
-                $this->session_lifespan->inSeconds()
-            );
-        }
-        // we're using the Transient API for storing session data,
-        return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @access public
-     * @return string
-     */
-    public function _get_page_visit()
-    {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
-        // check for request url
-        if (isset($_SERVER['REQUEST_URI'])) {
-            $http_host = '';
-            $page_id = '?';
-            $e_reg = '';
-            $request_uri = esc_url($_SERVER['REQUEST_URI']);
-            $ru_bits = explode('?', $request_uri);
-            $request_uri = $ru_bits[0];
-            // check for and grab host as well
-            if (isset($_SERVER['HTTP_HOST'])) {
-                $http_host = esc_url($_SERVER['HTTP_HOST']);
-            }
-            // check for page_id in SERVER REQUEST
-            if (isset($_REQUEST['page_id'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
-            }
-            // check for $e_reg in SERVER REQUEST
-            if (isset($_REQUEST['ee'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
-            }
-            $page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
-        }
-        return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
-    }
-
-
-    /**
-     * @the    current wp user id
-     * @access public
-     * @return int
-     */
-    public function _wp_user_id()
-    {
-        // if I need to explain the following lines of code, then you shouldn't be looking at this!
-        $this->_wp_user_id = get_current_user_id();
-        return $this->_wp_user_id;
-    }
-
-
-    /**
-     * Clear EE_Session data
-     *
-     * @access public
-     * @param string $class
-     * @param string $function
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function clear_session($class = '', $function = '')
-    {
+	const session_id_prefix = 'ee_ssn_';
+
+	const hash_check_prefix = 'ee_shc_';
+
+	const OPTION_NAME_SETTINGS = 'ee_session_settings';
+
+	const STATUS_CLOSED = 0;
+
+	const STATUS_OPEN = 1;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session
+	 */
+	private static $_instance;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	protected $cache_storage;
+
+	/**
+	 * @var EE_Encryption $encryption
+	 */
+	protected $encryption;
+
+	/**
+	 * @var SessionStartHandler $session_start_handler
+	 */
+	protected $session_start_handler;
+
+	/**
+	 * the session id
+	 *
+	 * @var string
+	 */
+	private $_sid;
+
+	/**
+	 * session id salt
+	 *
+	 * @var string
+	 */
+	private $_sid_salt;
+
+	/**
+	 * session data
+	 *
+	 * @var array
+	 */
+	private $_session_data = array();
+
+	/**
+	 * how long an EE session lasts
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	/**
+	 * session expiration time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_expiration;
+
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
+
+	/**
+	 * current time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_time;
+
+	/**
+	 * whether to encrypt session data
+	 *
+	 * @var bool
+	 */
+	private $_use_encryption;
+
+	/**
+	 * well... according to the server...
+	 *
+	 * @var null
+	 */
+	private $_user_agent;
+
+	/**
+	 * do you really trust the server ?
+	 *
+	 * @var null
+	 */
+	private $_ip_address;
+
+	/**
+	 * current WP user_id
+	 *
+	 * @var null
+	 */
+	private $_wp_user_id;
+
+	/**
+	 * array for defining default session vars
+	 *
+	 * @var array
+	 */
+	private $_default_session_vars = array(
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
+	);
+
+	/**
+	 * timestamp for when last garbage collection cycle was performed
+	 *
+	 * @var int $_last_gc
+	 */
+	private $_last_gc;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * whether session is active or not
+	 *
+	 * @var int $status
+	 */
+	private $status = EE_Session::STATUS_CLOSED;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan|null  $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @return EE_Session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance(
+		CacheStorageInterface $cache_storage = null,
+		SessionLifespan $lifespan = null,
+		RequestInterface $request = null,
+		SessionStartHandler $session_start_handler = null,
+		EE_Encryption $encryption = null
+	) {
+		// check if class object is instantiated
+		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
+		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+			self::$_instance = new self(
+				$cache_storage,
+				$lifespan,
+				$request,
+				$session_start_handler,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		SessionStartHandler $session_start_handler,
+		EE_Encryption $encryption = null
+	) {
+		// session loading is turned ON by default,
+		// but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
+		// (which currently fires on the init hook at priority 9),
+		// can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! apply_filters('FHEE_load_EE_Session', true)) {
+			return;
+		}
+		$this->session_start_handler = $session_start_handler;
+		$this->session_lifespan = $lifespan;
+		$this->request = $request;
+		if (! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
+		}
+		// retrieve session options from db
+		$session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		if (! empty($session_settings)) {
+			// cycle though existing session options
+			foreach ($session_settings as $var_name => $session_setting) {
+				// set values for class properties
+				$var_name = '_' . $var_name;
+				$this->{$var_name} = $session_setting;
+			}
+		}
+		$this->cache_storage = $cache_storage;
+		// are we using encryption?
+		$this->_use_encryption = $encryption instanceof EE_Encryption
+								 && EE_Registry::instance()->CFG->admin->encode_session_data();
+		// encrypt data via: $this->encryption->encrypt();
+		$this->encryption = $encryption;
+		// filter hook allows outside functions/classes/plugins to change default empty cart
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
+		// apply default session vars
+		$this->_set_defaults();
+		add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
+		// check request for 'clear_session' param
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
+		// once everything is all said and done,
+		add_action('shutdown', array($this, 'update'), 100);
+		add_action('shutdown', array($this, 'garbageCollection'), 1000);
+		$this->configure_garbage_collection_filters();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function isLoadedAndActive()
+	{
+		return did_action('AHEE__EE_System__core_loaded_and_ready')
+			   && EE_Session::instance() instanceof EE_Session
+			   && EE_Session::instance()->isActive();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->status === EE_Session::STATUS_OPEN;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 */
+	public function open_session()
+	{
+		// check for existing session and retrieve it from db
+		if (! $this->_espresso_session()) {
+			// or just start a new one
+			$this->_create_espresso_session();
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function expiration()
+	{
+		return $this->_expiration;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
+	}
+
+
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function lifespan()
+	{
+		return $this->session_lifespan->inSeconds();
+	}
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		// set some defaults
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[ $key ] = array();
+			} else {
+				$this->_session_data[ $key ] = '';
+			}
+		}
+	}
+
+
+	/**
+	 * @retrieve  session data
+	 * @access    public
+	 * @return    string
+	 */
+	public function id()
+	{
+		return $this->_sid;
+	}
+
+
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		return true;
+	}
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+	}
+
+
+	/**
+	 * @return \EE_Cart
+	 */
+	public function cart()
+	{
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Checkout $checkout
+	 * @return bool
+	 */
+	public function set_checkout(EE_Checkout $checkout)
+	{
+		$this->_session_data['checkout'] = $checkout;
+		return true;
+	}
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+	}
+
+
+	/**
+	 * @return \EE_Checkout
+	 */
+	public function checkout()
+	{
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function set_transaction(EE_Transaction $transaction)
+	{
+		// first remove the session from the transaction before we save the transaction in the session
+		$transaction->set_txn_session_data(null);
+		$this->_session_data['transaction'] = $transaction;
+		return true;
+	}
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+	}
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param null $key
+	 * @param bool $reset_cache
+	 * @return array
+	 */
+	public function get_session_data($key = null, $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data($data)
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @initiate session
+	 * @access   private
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 */
+	private function _espresso_session()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->session_start_handler->startSession();
+		$this->status = EE_Session::STATUS_OPEN;
+		// get our modified session ID
+		$this->_sid = $this->_generate_session_id();
+		// and the visitors IP
+		$this->_ip_address = $this->request->ipAddress();
+		// set the "user agent"
+		$this->_user_agent = $this->request->userAgent();
+		// now let's retrieve what's in the db
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
+			$this->_time = $this->_time !== null ? $this->_time : time();
+			// and reset the session expiration
+			$this->_expiration = isset($session_data['expiration'])
+				? $session_data['expiration']
+				: $this->_time + $this->session_lifespan->inSeconds();
+		} else {
+			// set initial site access time and the session expiration
+			$this->_set_init_access_and_expiration();
+			// set referer
+			$this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
+				: '';
+			// no previous session = go back and create one (on top of the data above)
+			return false;
+		}
+		// now the user agent
+		if ($session_data['user_agent'] !== $this->_user_agent) {
+			return false;
+		}
+		// wait a minute... how old are you?
+		if ($this->_time > $this->_expiration) {
+			// yer too old fer me!
+			$this->_expired = true;
+			// wipe out everything that isn't a default session datum
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// make event espresso session data available to plugin
+		$this->_session_data = array_merge($this->_session_data, $session_data);
+		return true;
+	}
+
+
+	/**
+	 * _get_session_data
+	 * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
+	 * databases
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidSessionDataException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _retrieve_session_data()
+	{
+		$ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		try {
+			// we're using WP's Transient API to store session data using the PHP session ID as the option name
+			$session_data = $this->cache_storage->get($ssn_key, false);
+			if (empty($session_data)) {
+				return array();
+			}
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				$hash_check = $this->cache_storage->get(
+					EE_Session::hash_check_prefix . $this->_sid,
+					false
+				);
+				if ($hash_check && $hash_check !== md5($session_data)) {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
+								'event_espresso'
+							),
+							EE_Session::session_id_prefix . $this->_sid
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} catch (Exception $e) {
+			// let's just eat that error for now and attempt to correct any corrupted data
+			global $wpdb;
+			$row = $wpdb->get_row(
+				$wpdb->prepare(
+					"SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
+					'_transient_' . $ssn_key
+				)
+			);
+			$session_data = is_object($row) ? $row->option_value : null;
+			if ($session_data) {
+				$session_data = preg_replace_callback(
+					'!s:(d+):"(.*?)";!',
+					function ($match) {
+						return $match[1] === strlen($match[2])
+							? $match[0]
+							: 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					},
+					$session_data
+				);
+			}
+			$session_data = maybe_unserialize($session_data);
+		}
+		// in case the data is encoded... try to decode it
+		$session_data = $this->encryption instanceof EE_Encryption
+			? $this->encryption->base64_string_decode($session_data)
+			: $session_data;
+		if (! is_array($session_data)) {
+			try {
+				$session_data = maybe_unserialize($session_data);
+			} catch (Exception $e) {
+				$msg = esc_html__(
+					'An error occurred while attempting to unserialize the session data.',
+					'event_espresso'
+				);
+				$msg .= WP_DEBUG
+					? '<br><pre>'
+					  . print_r($session_data, true)
+					  . '</pre><br>'
+					  . $this->find_serialize_error($session_data)
+					: '';
+				$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+				throw new InvalidSessionDataException($msg, 0, $e);
+			}
+		}
+		// just a check to make sure the session array is indeed an array
+		if (! is_array($session_data)) {
+			// no?!?! then something is wrong
+			$msg = esc_html__(
+				'The session data is missing, invalid, or corrupted.',
+				'event_espresso'
+			);
+			$msg .= WP_DEBUG
+				? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+				: '';
+			$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+			throw new InvalidSessionDataException($msg);
+		}
+		if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
+			$session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				$session_data['transaction']
+			);
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * _generate_session_id
+	 * Retrieves the PHP session id either directly from the PHP session,
+	 * or from the $_REQUEST array if it was passed in from an AJAX request.
+	 * The session id is then salted and hashed (mmm sounds tasty)
+	 * so that it can be safely used as a $_REQUEST param
+	 *
+	 * @return string
+	 */
+	protected function _generate_session_id()
+	{
+		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
+		} else {
+			$session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+		}
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
+	}
+
+
+	/**
+	 * _get_sid_salt
+	 *
+	 * @return string
+	 */
+	protected function _get_sid_salt()
+	{
+		// was session id salt already saved to db ?
+		if (empty($this->_sid_salt)) {
+			// no?  then maybe use WP defined constant
+			if (defined('AUTH_SALT')) {
+				$this->_sid_salt = AUTH_SALT;
+			}
+			// if salt doesn't exist or is too short
+			if (strlen($this->_sid_salt) < 32) {
+				// create a new one
+				$this->_sid_salt = wp_generate_password(64);
+			}
+			// and save it as a permanent session setting
+			$this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
+		}
+		return $this->_sid_salt;
+	}
+
+
+	/**
+	 * _set_init_access_and_expiration
+	 *
+	 * @return void
+	 */
+	protected function _set_init_access_and_expiration()
+	{
+		$this->_time = time();
+		$this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
+		// set initial site access time
+		$this->_session_data['init_access'] = $this->_time;
+		// and the session expiration
+		$this->_session_data['expiration'] = $this->_expiration;
+	}
+
+
+	/**
+	 * @update session data  prior to saving to the db
+	 * @access public
+	 * @param bool $new_session
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update($new_session = false)
+	{
+		$this->_session_data = $this->_session_data !== null
+							   && is_array($this->_session_data)
+							   && isset($this->_session_data['id'])
+			? $this->_session_data
+			: array();
+		if (empty($this->_session_data)) {
+			$this->_set_defaults();
+		}
+		$session_data = array();
+		foreach ($this->_session_data as $key => $value) {
+			switch ($key) {
+				case 'id':
+					// session ID
+					$session_data['id'] = $this->_sid;
+					break;
+				case 'ip_address':
+					// visitor ip address
+					$session_data['ip_address'] = $this->request->ipAddress();
+					break;
+				case 'user_agent':
+					// visitor user_agent
+					$session_data['user_agent'] = $this->_user_agent;
+					break;
+				case 'init_access':
+					$session_data['init_access'] = absint($value);
+					break;
+				case 'last_access':
+					// current access time
+					$session_data['last_access'] = $this->_time;
+					break;
+				case 'expiration':
+					// when the session expires
+					$session_data['expiration'] = ! empty($this->_expiration)
+						? $this->_expiration
+						: $session_data['init_access'] + $this->session_lifespan->inSeconds();
+					break;
+				case 'user_id':
+					// current user if logged in
+					$session_data['user_id'] = $this->_wp_user_id();
+					break;
+				case 'pages_visited':
+					$page_visit = $this->_get_page_visit();
+					if ($page_visit) {
+						// set pages visited where the first will be the http referrer
+						$this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+						// we'll only save the last 10 page visits.
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
+					}
+					break;
+				default:
+					// carry any other data over
+					$session_data[ $key ] = $this->_session_data[ $key ];
+			}
+		}
+		$this->_session_data = $session_data;
+		// creating a new session does not require saving to the db just yet
+		if (! $new_session) {
+			// ready? let's save
+			if ($this->_save_session_to_db()) {
+				return true;
+			}
+			return false;
+		}
+		// meh, why not?
+		return true;
+	}
+
+
+	/**
+	 * @create session data array
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		return $this->update(true) ? true : false;
+	}
+
+	/**
+	 * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
+	 * too). This is used when determining if we want to save the session or not.
+	 * @since 4.9.67.p
+	 * @return bool
+	 */
+	private function sessionHasStuffWorthSaving()
+	{
+		return $this->cart() instanceof EE_Cart
+			|| (
+				isset($this->_session_data['ee_notices'])
+				&& (
+					! empty($this->_session_data['ee_notices']['attention'])
+					|| !empty($this->_session_data['ee_notices']['errors'])
+					|| !empty($this->_session_data['ee_notices']['success'])
+				)
+			);
+	}
+	/**
+	 * _save_session_to_db
+	 *
+	 * @param bool $clear_session
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _save_session_to_db($clear_session = false)
+	{
+		// don't save sessions for crawlers
+		// and unless we're deleting the session data, don't save anything if there isn't a cart
+		if ($this->request->isBot()
+			|| (
+				! $clear_session
+				&& ! $this->sessionHasStuffWorthSaving()
+				&& apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
+			)
+		) {
+			return false;
+		}
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			if (! $transaction->ID()) {
+				$transaction->save();
+			}
+			$this->_session_data['transaction'] = $transaction->ID();
+		}
+		// then serialize all of our session data
+		$session_data = serialize($this->_session_data);
+		// do we need to also encode it to avoid corrupted data when saved to the db?
+		$session_data = $this->_use_encryption
+			? $this->encryption->base64_string_encode($session_data)
+			: $session_data;
+		// maybe save hash check
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			$this->cache_storage->add(
+				EE_Session::hash_check_prefix . $this->_sid,
+				md5($session_data),
+				$this->session_lifespan->inSeconds()
+			);
+		}
+		// we're using the Transient API for storing session data,
+		return $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @access public
+	 * @return string
+	 */
+	public function _get_page_visit()
+	{
+		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		// check for request url
+		if (isset($_SERVER['REQUEST_URI'])) {
+			$http_host = '';
+			$page_id = '?';
+			$e_reg = '';
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits = explode('?', $request_uri);
+			$request_uri = $ru_bits[0];
+			// check for and grab host as well
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
+			}
+			// check for page_id in SERVER REQUEST
+			if (isset($_REQUEST['page_id'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+			}
+			// check for $e_reg in SERVER REQUEST
+			if (isset($_REQUEST['ee'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+			}
+			$page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
+		}
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
+	}
+
+
+	/**
+	 * @the    current wp user id
+	 * @access public
+	 * @return int
+	 */
+	public function _wp_user_id()
+	{
+		// if I need to explain the following lines of code, then you shouldn't be looking at this!
+		$this->_wp_user_id = get_current_user_id();
+		return $this->_wp_user_id;
+	}
+
+
+	/**
+	 * Clear EE_Session data
+	 *
+	 * @access public
+	 * @param string $class
+	 * @param string $function
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function clear_session($class = '', $function = '')
+	{
 //         echo '
 // <h3 style="color:#999;line-height:.9em;">
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
-        $this->reset_cart();
-        $this->reset_checkout();
-        $this->reset_transaction();
-        // wipe out everything that isn't a default session datum
-        $this->reset_data(array_keys($this->_session_data));
-        // reset initial site access time and the session expiration
-        $this->_set_init_access_and_expiration();
-        $this->_save_session_to_db(true);
-    }
-
-
-    /**
-     * resets all non-default session vars. Returns TRUE on success, FALSE on fail
-     *
-     * @param array|mixed $data_to_reset
-     * @param bool        $show_all_notices
-     * @return bool
-     */
-    public function reset_data($data_to_reset = array(), $show_all_notices = false)
-    {
-        // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
-            $data_to_reset = array($data_to_reset);
-        }
-        // nothing ??? go home!
-        if (empty($data_to_reset)) {
-            EE_Error::add_error(
-                __(
-                    'No session data could be reset, because no session var name was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $return_value = true;
-        // since $data_to_reset is an array, cycle through the values
-        foreach ($data_to_reset as $reset) {
-            // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
-                // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
-                    // remove session var
-                    unset($this->_session_data[ $reset ]);
-                    if ($show_all_notices) {
-                        EE_Error::add_success(
-                            sprintf(
-                                __('The session variable %s was removed.', 'event_espresso'),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    // yeeeeeeeeerrrrrrrrrrr OUT !!!!
-                    if ($show_all_notices) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __(
-                                    'Sorry! %s is a default session datum and can not be reset.',
-                                    'event_espresso'
-                                ),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    $return_value = false;
-                }
-            } elseif ($show_all_notices) {
-                // oops! that session var does not exist!
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The session item provided, %s, is invalid or does not exist.',
-                            'event_espresso'
-                        ),
-                        $reset
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $return_value = false;
-            }
-        } // end of foreach
-        return $return_value;
-    }
-
-
-    /**
-     *   wp_loaded
-     *
-     * @access public
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function wp_loaded()
-    {
-        if ($this->request->requestParamIsSet('clear_session')) {
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-    }
-
-
-    /**
-     * Used to reset the entire object (for tests).
-     *
-     * @since 4.3.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function reset_instance()
-    {
-        $this->clear_session();
-        self::$_instance = null;
-    }
-
-
-    public function configure_garbage_collection_filters()
-    {
-        // run old filter we had for controlling session cleanup
-        $expired_session_transient_delete_query_limit = absint(
-            apply_filters(
-                'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                50
-            )
-        );
-        // is there a value? or one that is different than the default 50 records?
-        if ($expired_session_transient_delete_query_limit === 0) {
-            // hook into TransientCacheStorage in case Session cleanup was turned off
-            add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-        } elseif ($expired_session_transient_delete_query_limit !== 50) {
-            // or use that for the new transient cleanup query limit
-            add_filter(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
-                    return $expired_session_transient_delete_query_limit;
-                }
-            );
-        }
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
-     * @param $data1
-     * @return string
-     */
-    private function find_serialize_error($data1)
-    {
-        $error = '<pre>';
-        $data2 = preg_replace_callback(
-            '!s:(\d+):"(.*?)";!',
-            function ($match) {
-                return ($match[1] === strlen($match[2]))
-                    ? $match[0]
-                    : 's:'
-                      . strlen($match[2])
-                      . ':"'
-                      . $match[2]
-                      . '";';
-            },
-            $data1
-        );
-        $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
-        for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
-                $start = ($i - 20);
-                $start = ($start < 0) ? 0 : $start;
-                $length = 40;
-                $point = $max - $i;
-                if ($point < 20) {
-                    $rlength = 1;
-                    $rpoint = -$point;
-                } else {
-                    $rpoint = $length - 20;
-                    $rlength = 1;
-                }
-                $error .= "\t-> Section Data1  = ";
-                $error .= substr_replace(
-                    substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-                $error .= "\t-> Section Data2  = ";
-                $error .= substr_replace(
-                    substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-            }
-        }
-        $error .= '</pre>';
-        return $error;
-    }
-
-
-    /**
-     * Saves an  array of settings used for configuring aspects of session behaviour
-     *
-     * @param array $updated_settings
-     */
-    private function updateSessionSettings(array $updated_settings = array())
-    {
-        // add existing settings, but only if not included in incoming $updated_settings array
-        $updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
-    }
-
-
-    /**
-     * garbage_collection
-     */
-    public function garbageCollection()
-    {
-        // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
-            $this->_last_gc = time();
-            $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            // filter the query limit. Set to 0 to turn off garbage collection
-            $expired_session_transient_delete_query_limit = absint(
-                apply_filters(
-                    'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                    50
-                )
-            );
-            // non-zero LIMIT means take out the trash
-            if ($expired_session_transient_delete_query_limit) {
-                $session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
-                $hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
-                // since transient expiration timestamps are set in the future, we can compare against NOW
-                // but we only want to pick up any trash that's been around for more than a day
-                $expiration = time() - DAY_IN_SECONDS;
-                $SQL = "
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+		$this->reset_cart();
+		$this->reset_checkout();
+		$this->reset_transaction();
+		// wipe out everything that isn't a default session datum
+		$this->reset_data(array_keys($this->_session_data));
+		// reset initial site access time and the session expiration
+		$this->_set_init_access_and_expiration();
+		$this->_save_session_to_db(true);
+	}
+
+
+	/**
+	 * resets all non-default session vars. Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array|mixed $data_to_reset
+	 * @param bool        $show_all_notices
+	 * @return bool
+	 */
+	public function reset_data($data_to_reset = array(), $show_all_notices = false)
+	{
+		// if $data_to_reset is not in an array, then put it in one
+		if (! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
+		}
+		// nothing ??? go home!
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(
+				__(
+					'No session data could be reset, because no session var name was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$return_value = true;
+		// since $data_to_reset is an array, cycle through the values
+		foreach ($data_to_reset as $reset) {
+			// first check to make sure it is a valid session var
+			if (isset($this->_session_data[ $reset ])) {
+				// then check to make sure it is not a default var
+				if (! array_key_exists($reset, $this->_default_session_vars)) {
+					// remove session var
+					unset($this->_session_data[ $reset ]);
+					if ($show_all_notices) {
+						EE_Error::add_success(
+							sprintf(
+								__('The session variable %s was removed.', 'event_espresso'),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
+					if ($show_all_notices) {
+						EE_Error::add_error(
+							sprintf(
+								__(
+									'Sorry! %s is a default session datum and can not be reset.',
+									'event_espresso'
+								),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					$return_value = false;
+				}
+			} elseif ($show_all_notices) {
+				// oops! that session var does not exist!
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The session item provided, %s, is invalid or does not exist.',
+							'event_espresso'
+						),
+						$reset
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$return_value = false;
+			}
+		} // end of foreach
+		return $return_value;
+	}
+
+
+	/**
+	 *   wp_loaded
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function wp_loaded()
+	{
+		if ($this->request->requestParamIsSet('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+	}
+
+
+	/**
+	 * Used to reset the entire object (for tests).
+	 *
+	 * @since 4.3.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function reset_instance()
+	{
+		$this->clear_session();
+		self::$_instance = null;
+	}
+
+
+	public function configure_garbage_collection_filters()
+	{
+		// run old filter we had for controlling session cleanup
+		$expired_session_transient_delete_query_limit = absint(
+			apply_filters(
+				'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				50
+			)
+		);
+		// is there a value? or one that is different than the default 50 records?
+		if ($expired_session_transient_delete_query_limit === 0) {
+			// hook into TransientCacheStorage in case Session cleanup was turned off
+			add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		} elseif ($expired_session_transient_delete_query_limit !== 50) {
+			// or use that for the new transient cleanup query limit
+			add_filter(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				function () use ($expired_session_transient_delete_query_limit) {
+					return $expired_session_transient_delete_query_limit;
+				}
+			);
+		}
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
+	 * @param $data1
+	 * @return string
+	 */
+	private function find_serialize_error($data1)
+	{
+		$error = '<pre>';
+		$data2 = preg_replace_callback(
+			'!s:(\d+):"(.*?)";!',
+			function ($match) {
+				return ($match[1] === strlen($match[2]))
+					? $match[0]
+					: 's:'
+					  . strlen($match[2])
+					  . ':"'
+					  . $match[2]
+					  . '";';
+			},
+			$data1
+		);
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1 . PHP_EOL;
+		$error .= $data2 . PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[ $i ] !== @$data2[ $i ]) {
+				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
+				$error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
+				$error .= "\t-> Line Number = $i" . PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
+				$length = 40;
+				$point = $max - $i;
+				if ($point < 20) {
+					$rlength = 1;
+					$rpoint = -$point;
+				} else {
+					$rpoint = $length - 20;
+					$rlength = 1;
+				}
+				$error .= "\t-> Section Data1  = ";
+				$error .= substr_replace(
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+				$error .= "\t-> Section Data2  = ";
+				$error .= substr_replace(
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+			}
+		}
+		$error .= '</pre>';
+		return $error;
+	}
+
+
+	/**
+	 * Saves an  array of settings used for configuring aspects of session behaviour
+	 *
+	 * @param array $updated_settings
+	 */
+	private function updateSessionSettings(array $updated_settings = array())
+	{
+		// add existing settings, but only if not included in incoming $updated_settings array
+		$updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
+	}
+
+
+	/**
+	 * garbage_collection
+	 */
+	public function garbageCollection()
+	{
+		// only perform during regular requests if last garbage collection was over an hour ago
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+			$this->_last_gc = time();
+			$this->updateSessionSettings(array('last_gc' => $this->_last_gc));
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			// filter the query limit. Set to 0 to turn off garbage collection
+			$expired_session_transient_delete_query_limit = absint(
+				apply_filters(
+					'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+					50
+				)
+			);
+			// non-zero LIMIT means take out the trash
+			if ($expired_session_transient_delete_query_limit) {
+				$session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
+				$hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
+				// since transient expiration timestamps are set in the future, we can compare against NOW
+				// but we only want to pick up any trash that's been around for more than a day
+				$expiration = time() - DAY_IN_SECONDS;
+				$SQL = "
                     SELECT option_name
                     FROM {$wpdb->options}
                     WHERE
@@ -1286,17 +1286,17 @@ 
                     AND option_value < {$expiration}
                     LIMIT {$expired_session_transient_delete_query_limit}
                 ";
-                // produces something like:
-                // SELECT option_name FROM wp_options
-                // WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
-                // OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
-                // AND option_value < 1508368198 LIMIT 50
-                $expired_sessions = $wpdb->get_col($SQL);
-                // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
-                    $this->cache_storage->deleteMany($expired_sessions, true);
-                }
-            }
-        }
-    }
+				// produces something like:
+				// SELECT option_name FROM wp_options
+				// WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
+				// OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
+				// AND option_value < 1508368198 LIMIT 50
+				$expired_sessions = $wpdb->get_col($SQL);
+				// valid results?
+				if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+					$this->cache_storage->deleteMany($expired_sessions, true);
+				}
+			}
+		}
+	}
 }

Spacing +55 added lines, -55 removed lines

@@ -193,7 +193,7 @@ 
         // check if class object is instantiated
         // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
         // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
             self::$_instance = new self(
                 $cache_storage,
                 $lifespan,
@@ -229,22 +229,22 @@ 
         // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
         // (which currently fires on the init hook at priority 9),
         // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! apply_filters('FHEE_load_EE_Session', true)) {
             return;
         }
         $this->session_start_handler = $session_start_handler;
         $this->session_lifespan = $lifespan;
         $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
+        if ( ! defined('ESPRESSO_SESSION')) {
             define('ESPRESSO_SESSION', true);
         }
         // retrieve session options from db
         $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
+        if ( ! empty($session_settings)) {
             // cycle though existing session options
             foreach ($session_settings as $var_name => $session_setting) {
                 // set values for class properties
-                $var_name = '_' . $var_name;
+                $var_name = '_'.$var_name;
                 $this->{$var_name} = $session_setting;
             }
         }
@@ -303,7 +303,7 @@ 
     public function open_session()
     {
         // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
+        if ( ! $this->_espresso_session()) {
             // or just start a new one
             $this->_create_espresso_session();
         }
@@ -376,9 +376,9 @@ 
         // set some defaults
         foreach ($this->_default_session_vars as $key => $default_var) {
             if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
+                $this->_session_data[$key] = array();
             } else {
-                $this->_session_data[ $key ] = '';
+                $this->_session_data[$key] = '';
             }
         }
     }
@@ -509,8 +509,8 @@ 
             $this->reset_checkout();
             $this->reset_transaction();
         }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+        if ( ! empty($key)) {
+            return isset($this->_session_data[$key]) ? $this->_session_data[$key] : null;
         }
         return $this->_session_data;
     }
@@ -538,7 +538,7 @@ 
             return false;
         }
         foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
+            if (isset($this->_default_session_vars[$key])) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -553,7 +553,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
         }
         return true;
     }
@@ -582,7 +582,7 @@ 
         $this->_user_agent = $this->request->userAgent();
         // now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
             $this->_time = $this->_time !== null ? $this->_time : time();
             // and reset the session expiration
@@ -593,7 +593,7 @@ 
             // set initial site access time and the session expiration
             $this->_set_init_access_and_expiration();
             // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
+            $this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
                 ? esc_attr($_SERVER['HTTP_REFERER'])
                 : '';
             // no previous session = go back and create one (on top of the data above)
@@ -630,7 +630,7 @@ 
      */
     protected function _retrieve_session_data()
     {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+        $ssn_key = EE_Session::session_id_prefix.$this->_sid;
         try {
             // we're using WP's Transient API to store session data using the PHP session ID as the option name
             $session_data = $this->cache_storage->get($ssn_key, false);
@@ -639,7 +639,7 @@ 
             }
             if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                 $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
+                    EE_Session::hash_check_prefix.$this->_sid,
                     false
                 );
                 if ($hash_check && $hash_check !== md5($session_data)) {
@@ -649,7 +649,7 @@ 
                                 'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                 'event_espresso'
                             ),
-                            EE_Session::session_id_prefix . $this->_sid
+                            EE_Session::session_id_prefix.$this->_sid
                         ),
                         __FILE__,
                         __FUNCTION__,
@@ -663,17 +663,17 @@ 
             $row = $wpdb->get_row(
                 $wpdb->prepare(
                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
+                    '_transient_'.$ssn_key
                 )
             );
             $session_data = is_object($row) ? $row->option_value : null;
             if ($session_data) {
                 $session_data = preg_replace_callback(
                     '!s:(d+):"(.*?)";!',
-                    function ($match) {
+                    function($match) {
                         return $match[1] === strlen($match[2])
                             ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                            : 's:'.strlen($match[2]).':"'.$match[2].'";';
                     },
                     $session_data
                 );
@@ -684,7 +684,7 @@ 
         $session_data = $this->encryption instanceof EE_Encryption
             ? $this->encryption->base64_string_decode($session_data)
             : $session_data;
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             try {
                 $session_data = maybe_unserialize($session_data);
             } catch (Exception $e) {
@@ -698,21 +698,21 @@ 
                       . '</pre><br>'
                       . $this->find_serialize_error($session_data)
                     : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+                $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
                 throw new InvalidSessionDataException($msg, 0, $e);
             }
         }
         // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             // no?!?! then something is wrong
             $msg = esc_html__(
                 'The session data is missing, invalid, or corrupted.',
                 'event_espresso'
             );
             $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                 : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+            $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
             throw new InvalidSessionDataException($msg);
         }
         if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
@@ -739,7 +739,7 @@ 
         if (isset($_REQUEST['EESID'])) {
             $session_id = sanitize_text_field($_REQUEST['EESID']);
         } else {
-            $session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+            $session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
         }
         return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
     }
@@ -842,19 +842,19 @@ 
                     $page_visit = $this->_get_page_visit();
                     if ($page_visit) {
                         // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+                        $this->_session_data['pages_visited'][$this->_time] = $page_visit;
                         // we'll only save the last 10 page visits.
                         $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
                     }
                     break;
                 default:
                     // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
+                    $session_data[$key] = $this->_session_data[$key];
             }
         }
         $this->_session_data = $session_data;
         // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
+        if ( ! $new_session) {
             // ready? let's save
             if ($this->_save_session_to_db()) {
                 return true;
@@ -895,8 +895,8 @@ 
                 isset($this->_session_data['ee_notices'])
                 && (
                     ! empty($this->_session_data['ee_notices']['attention'])
-                    || !empty($this->_session_data['ee_notices']['errors'])
-                    || !empty($this->_session_data['ee_notices']['success'])
+                    || ! empty($this->_session_data['ee_notices']['errors'])
+                    || ! empty($this->_session_data['ee_notices']['success'])
                 )
             );
     }
@@ -925,7 +925,7 @@ 
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -939,14 +939,14 @@ 
         // maybe save hash check
         if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->session_lifespan->inSeconds()
             );
         }
         // we're using the Transient API for storing session data,
         return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -960,7 +960,7 @@ 
      */
     public function _get_page_visit()
     {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+        $page_visit = home_url('/').'wp-admin/admin-ajax.php';
         // check for request url
         if (isset($_SERVER['REQUEST_URI'])) {
             $http_host = '';
@@ -976,14 +976,14 @@ 
             // check for page_id in SERVER REQUEST
             if (isset($_REQUEST['page_id'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+                $page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
             }
             // check for $e_reg in SERVER REQUEST
             if (isset($_REQUEST['ee'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+                $e_reg = 'ee='.esc_attr($_REQUEST['ee']);
             }
-            $page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
+            $page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
         }
         return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
     }
@@ -1021,7 +1021,7 @@ 
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
         $this->reset_cart();
         $this->reset_checkout();
         $this->reset_transaction();
@@ -1043,7 +1043,7 @@ 
     public function reset_data($data_to_reset = array(), $show_all_notices = false)
     {
         // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
+        if ( ! is_array($data_to_reset)) {
             $data_to_reset = array($data_to_reset);
         }
         // nothing ??? go home!
@@ -1063,11 +1063,11 @@ 
         // since $data_to_reset is an array, cycle through the values
         foreach ($data_to_reset as $reset) {
             // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
+            if (isset($this->_session_data[$reset])) {
                 // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
+                if ( ! array_key_exists($reset, $this->_default_session_vars)) {
                     // remove session var
-                    unset($this->_session_data[ $reset ]);
+                    unset($this->_session_data[$reset]);
                     if ($show_all_notices) {
                         EE_Error::add_success(
                             sprintf(
@@ -1168,7 +1168,7 @@ 
             // or use that for the new transient cleanup query limit
             add_filter(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
+                function() use ($expired_session_transient_delete_query_limit) {
                     return $expired_session_transient_delete_query_limit;
                 }
             );
@@ -1186,7 +1186,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match) {
+            function($match) {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
                     : 's:'
@@ -1198,13 +1198,13 @@ 
             $data1
         );
         $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $error .= $data1.PHP_EOL;
+        $error .= $data2.PHP_EOL;
         for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
+            if (@$data1[$i] !== @$data2[$i]) {
+                $error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+                $error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+                $error .= "\t-> Line Number = $i".PHP_EOL;
                 $start = ($i - 20);
                 $start = ($start < 0) ? 0 : $start;
                 $length = 40;
@@ -1219,7 +1219,7 @@ 
                 $error .= "\t-> Section Data1  = ";
                 $error .= substr_replace(
                     substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
+                    "<b style=\"color:green\">{$data1[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1227,7 +1227,7 @@ 
                 $error .= "\t-> Section Data2  = ";
                 $error .= substr_replace(
                     substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
+                    "<b style=\"color:red\">{$data2[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1258,7 +1258,7 @@ 
     public function garbageCollection()
     {
         // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
             $this->_last_gc = time();
             $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
             /** @type WPDB $wpdb */
@@ -1293,7 +1293,7 @@ 
                 // AND option_value < 1508368198 LIMIT 50
                 $expired_sessions = $wpdb->get_col($SQL);
                 // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+                if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
                     $this->cache_storage->deleteMany($expired_sessions, true);
                 }
             }