eventespresso / event-espresso-core

core/data_migration_scripts/EE_DMS_Core_4_7_0.dms.php

Indentation +186 added lines, -186 removed lines

@@ -10,9 +10,9 @@ 
 $stages            = glob(EE_CORE . 'data_migration_scripts/4_7_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
-    $matches = [];
-    preg_match('~4_7_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = [];
+	preg_match('~4_7_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_7_0__autoloaded_stages', $class_to_filepath);
@@ -35,71 +35,71 @@ 
 class EE_DMS_Core_4_7_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_7_0
-     *
-     * @param TableManager|null  $table_manager
-     * @param TableAnalysis|null $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name      = esc_html__("Data Update to Event Espresso 4.7.0", "event_espresso");
-        $this->_priority         = 10;
-        $this->_migration_stages = [
-            new EE_DMS_4_7_0_Add_Taxes_To_REG_Final_Price(),
-            new EE_DMS_4_7_0_Registration_Payments(),
-        ];
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-    /**
-     * @param array $version_array
-     * @return bool
-     * @throws EE_Error
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (
-            (version_compare($version_string, '4.7.0.decaf', '<') &&
-             version_compare($version_string, '4.6.0.decaf', '>=')) ||
-            (version_compare($version_string, '4.7.0.decaf', '>=') &&
-             ! $this->_get_table_analysis()->tableExists('esp_registration_payment') &&
-             $this->_get_table_analysis()->tableExists('esp_registration'))
-        ) {
-            return true;
-        } elseif (! $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 {
-            return false;
-        }
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function schema_changes_before_migration()
-    {
-        // relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-
-        $table_name = 'esp_answer';
-        $sql        = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * return EE_DMS_Core_4_7_0
+	 *
+	 * @param TableManager|null  $table_manager
+	 * @param TableAnalysis|null $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name      = esc_html__("Data Update to Event Espresso 4.7.0", "event_espresso");
+		$this->_priority         = 10;
+		$this->_migration_stages = [
+			new EE_DMS_4_7_0_Add_Taxes_To_REG_Final_Price(),
+			new EE_DMS_4_7_0_Registration_Payments(),
+		];
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+	/**
+	 * @param array $version_array
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (
+			(version_compare($version_string, '4.7.0.decaf', '<') &&
+			 version_compare($version_string, '4.6.0.decaf', '>=')) ||
+			(version_compare($version_string, '4.7.0.decaf', '>=') &&
+			 ! $this->_get_table_analysis()->tableExists('esp_registration_payment') &&
+			 $this->_get_table_analysis()->tableExists('esp_registration'))
+		) {
+			return true;
+		} elseif (! $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 {
+			return false;
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function schema_changes_before_migration()
+	{
+		// relies on 4.1's EEH_Activation::create_table
+		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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_attendee_meta';
-        $sql        = "ATTM_ID int(10) unsigned NOT	NULL AUTO_INCREMENT,
+		$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,
@@ -116,10 +116,10 @@ 
 								KEY ATT_email (ATT_email(191)),
 								KEY ATT_lname (ATT_lname),
 								KEY ATT_fname (ATT_fname)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$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,
+		$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,20 +135,20 @@ 
 					  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);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_currency';
-        $sql        = "CUR_code varchar(6) COLLATE utf8_bin NOT NULL,
+		$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);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_datetime';
-        $sql        = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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,
@@ -164,10 +164,10 @@ 
 						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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_event_meta';
-        $sql        = "
+		$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,
@@ -183,38 +183,38 @@ 
 			EVT_donations tinyint(1) NULL,
 			PRIMARY KEY  (EVTM_ID),
 			KEY EVT_ID (EVT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_event_question_group';
-        $sql        = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_event_venue';
-        $sql        = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$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);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_extra_meta';
-        $sql        = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$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(45))";
-        $this->_table_is_changed_in_this_version($table_name, $sql);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_line_item';
-        $sql        = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$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 '',
@@ -232,10 +232,10 @@ 
 				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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_log';
-        $sql        = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$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,
@@ -246,20 +246,20 @@ 
 				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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_message_template';
-        $sql        = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_message_template_group';
-        $sql        = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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 '',
@@ -271,19 +271,19 @@ 
 					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);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_event_message_template';
-        $sql        = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$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);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_payment';
-        $sql        = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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',
@@ -300,10 +300,10 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY PAY_timestamp (PAY_timestamp),
 					KEY TXN_ID (TXN_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-        $table_name = 'esp_payment_method';
-        $sql        = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$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,
@@ -319,36 +319,36 @@ 
 				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');
+		$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,
+		$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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = "esp_datetime_ticket";
-        $sql        = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = "esp_ticket_template";
-        $sql        = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_question';
-        $sql        = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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) DEFAULT NULL,
@@ -361,20 +361,20 @@ 
 					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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_question_group_question';
-        $sql        = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_question_option';
-        $sql        = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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,
@@ -383,10 +383,10 @@ 
 					PRIMARY KEY  (QSO_ID),
 					KEY QST_ID (QST_ID),
 					KEY QSO_order (QSO_order)";
-        $this->_table_is_changed_in_this_version($table_name, $sql);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_registration';
-        $sql        = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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,20 +410,20 @@ 
 					  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');
+		$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,
+		$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_new_in_this_version($table_name, $sql);
+		$this->_table_is_new_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_checkin';
-        $sql        = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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,
@@ -431,10 +431,10 @@ 
 					PRIMARY KEY  (CHK_ID),
 					KEY REG_ID (REG_ID),
 					KEY DTT_ID (DTT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_state';
-        $sql        = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$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,
@@ -442,10 +442,10 @@ 
 					  PRIMARY KEY  (STA_ID),
 					  KEY STA_abbrev (STA_abbrev),
 					  KEY CNT_ISO (CNT_ISO)";
-        $this->_table_is_changed_in_this_version($table_name, $sql);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_status';
-        $sql        = "STS_ID varchar(3) COLLATE utf8_bin NOT NULL,
+		$table_name = 'esp_status';
+		$sql        = "STS_ID varchar(3) COLLATE utf8_bin NOT NULL,
 					  STS_code varchar(45) COLLATE utf8_bin NOT NULL,
 					  STS_type set('event','registration','transaction','payment','email') COLLATE utf8_bin NOT NULL,
 					  STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -453,10 +453,10 @@ 
 					  STS_open tinyint(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_transaction';
-        $sql        = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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',
@@ -468,10 +468,10 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql);
+		$this->_table_has_not_changed_since_previous($table_name, $sql);
 
-        $table_name = 'esp_venue_meta';
-        $sql        = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$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,
@@ -490,10 +490,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);
-        // 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);
+		// 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,
@@ -506,10 +506,10 @@ 
 					  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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = "esp_price_type";
-        $sql        = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$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',
@@ -518,10 +518,10 @@ 
 				  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');
+		$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,
+		$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,
@@ -543,10 +543,10 @@ 
 					  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);
+		$this->_table_is_changed_in_this_version($table_name, $sql);
 
-        $table_name = 'esp_question_group';
-        $sql        = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$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,
@@ -559,36 +559,36 @@ 
 					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);
-        /** @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();
-        return true;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
-
-
-    public function migration_page_hooks()
-    {
-    }
+		$this->_table_is_changed_in_this_version($table_name, $sql);
+		/** @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();
+		return true;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
+
+
+	public function migration_page_hooks()
+	{
+	}
 }
 // end of file: /core/data_migration_scripts/EE_DMS_Core_4_7_0.dms.php

Spacing +5 added lines, -5 removed lines

@@ -7,12 +7,12 @@ 
 // unfortunately, this needs to be done upon INCLUSION of this file,
 // instead of construction, because it only gets constructed on first page load
 // (all other times it gets resurrected from a wordpress option)
-$stages            = glob(EE_CORE . 'data_migration_scripts/4_7_0_stages/*');
+$stages            = glob(EE_CORE.'data_migration_scripts/4_7_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
     $matches = [];
     preg_match('~4_7_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+    $class_to_filepath[$matches[1]] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_7_0__autoloaded_stages', $class_to_filepath);
@@ -69,9 +69,9 @@ 
              $this->_get_table_analysis()->tableExists('esp_registration'))
         ) {
             return true;
-        } elseif (! $version_string) {
+        } elseif ( ! $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
+            return false; // changed mind. dont want people thinking they should migrate yet because they cant
         } else {
             return false;
         }
@@ -86,7 +86,7 @@ 
     public function schema_changes_before_migration()
     {
         // relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+        require_once(EE_HELPERS.'EEH_Activation.helper.php');
 
         $table_name = 'esp_answer';
         $sql        = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,

core/data_migration_scripts/4_7_0_stages/EE_DMS_4_7_0_Registration_Payments.dmsstage.php

Indentation +214 added lines, -214 removed lines

@@ -10,218 +10,218 @@
 class EE_DMS_4_7_0_Registration_Payments extends EE_Data_Migration_Script_Stage_Table
 {
 
-    protected string $_payment_table;
-
-    protected string $_registration_table;
-
-    protected string $_registration_payment_table;
-
-
-    public function __construct()
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $this->_pretty_name = esc_html__('Registration Payment Record Generation', 'event_espresso');
-        // define tables
-        $this->_old_table                  = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_table              = $wpdb->prefix . 'esp_payment';
-        $this->_registration_table         = $wpdb->prefix . 'esp_registration';
-        $this->_registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
-        // build SQL WHERE clauses
-        $this->_extra_where_sql = "WHERE STS_ID IN ( 'TIN', 'TCM' ) AND TXN_Total != '0.000'";
-        parent::__construct();
-    }
-
-
-    /**
-     * @param array $old_row
-     * @return void
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $TXN_ID = absint($old_row['TXN_ID']);
-        if (! $TXN_ID) {
-            $this->add_error(
-                sprintf(
-                    esc_html__('Invalid transaction with ID=%1$d. Error: "%2$s"', 'event_espresso'),
-                    $TXN_ID,
-                    $wpdb->last_error
-                )
-            );
-            return;
-        }
-        // get all payments for the TXN
-        $payments = $this->_get_payments($TXN_ID);
-        if (empty($payments)) {
-            return;
-        }
-        // then the registrants
-        $registrations = $this->_get_registrations($TXN_ID);
-        if (empty($registrations)) {
-            return;
-        }
-        // now loop thru each payment and apply it to each of the registrations
-        foreach ($payments as $payment) {
-            if ($payment->STS_ID === 'PAP' && $payment->PAY_amount > 0) {
-                $this->_process_registration_payments($payment, $registrations);
-            }
-        }
-    }
-
-
-    /**
-     * _get_registrations
-     *
-     * @param int $TXN_ID
-     * @return array
-     */
-    protected function _get_registrations(int $TXN_ID): array
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $SQL = "SELECT * FROM $this->_registration_table WHERE TXN_ID = %d AND STS_ID IN ( 'RPP', 'RAP' )";
-        return $wpdb->get_results($wpdb->prepare($SQL, $TXN_ID), OBJECT_K);
-    }
-
-
-    /**
-     * _get_payments
-     *
-     * @param int $TXN_ID
-     * @return array
-     */
-    protected function _get_payments(int $TXN_ID): array
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        return $wpdb->get_results(
-            $wpdb->prepare("SELECT * FROM $this->_payment_table WHERE TXN_ID = %d", $TXN_ID),
-            OBJECT_K
-        );
-    }
-
-
-    /**
-     * _get_possibly_updated_REG_paid
-     *
-     * @param int $REG_ID
-     * @return float
-     */
-    protected function _get_possibly_updated_REG_paid(int $REG_ID): float
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        return (float) $wpdb->get_var(
-            $wpdb->prepare("SELECT REG_paid FROM $this->_registration_table WHERE REG_ID = %d", $REG_ID)
-        );
-    }
-
-
-    /**
-     * _process_registration_payments
-     * basically a copy of the "Sequential Registration Payment Application Strategy"  logic
-     * currently in EE_Payment_Processor::process_registration_payments()
-     *
-     * @param stdClass $payment
-     * @param array    $registrations
-     * @return void
-     */
-    protected function _process_registration_payments(stdClass $payment, array $registrations = [])
-    {
-        // how much is available to apply to registrations?
-        $available_payment_amount = $payment->PAY_amount;
-        foreach ($registrations as $REG_ID => $registration) {
-            // nothing left, then we are done here?
-            if (! $available_payment_amount > 0) {
-                break;
-            }
-            // ensure REG_final_price has a valid value, and skip if it turns out to be zero
-            $registration->REG_final_price =
-                ! empty($registration->REG_final_price) ? (float) $registration->REG_final_price : 0.00;
-            if (! $registration->REG_final_price > 0) {
-                continue;
-            }
-            // because REG_paid may have been updated by a previous payment, we need to retrieve the value from the db
-            $registration->REG_paid = $this->_get_possibly_updated_REG_paid($REG_ID);
-            // calculate amount owing, and skip if it turns out to be zero
-            $owing = $registration->REG_final_price - $registration->REG_paid;
-            if (! $owing > 0) {
-                continue;
-            }
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount = $available_payment_amount - $payment_amount;
-            // add relation between registration and payment and set amount
-            if ($this->_insert_registration_payment($registration->REG_ID, $payment->PAY_ID, (float) $payment_amount)) {
-                // calculate and set new REG_paid
-                $registration->REG_paid = $registration->REG_paid + $payment_amount;
-                $this->_update_registration_paid($registration->REG_ID, (float) $registration->REG_paid);
-            }
-        }
-    }
-
-
-    /**
-     * _insert_registration_payment
-     *
-     * @param int   $REG_ID
-     * @param int   $PAY_ID
-     * @param float $PAY_amount
-     * @return bool
-     */
-    protected function _insert_registration_payment(int $REG_ID = 0, int $PAY_ID = 0, float $PAY_amount = 0.00): bool
-    {
-        global $wpdb;
-        $success = $wpdb->insert(
-            $this->_registration_payment_table,
-            ['REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount,],  // data
-            ['%f']                                                                     // data format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        'Could not update registration paid value for registration ID=%1$d because "%2$s"',
-                        'event_espresso'
-                    ),
-                    $REG_ID,
-                    $wpdb->last_error
-                )
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _update_registration_paid
-     *
-     * @param int   $REG_ID
-     * @param float $REG_paid
-     * @return bool
-     */
-    protected function _update_registration_paid(int $REG_ID = 0, float $REG_paid = 0.00): bool
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $success = $wpdb->update(
-            $this->_registration_table,
-            ['REG_paid' => $REG_paid],  // data
-            ['REG_ID' => $REG_ID],      // where
-            ['%f'],                     // data format
-            ['%d']                      // where format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        'Could not update registration paid value for registration ID=%1$d because "%2$s"',
-                        'event_espresso'
-                    ),
-                    $REG_ID,
-                    $wpdb->last_error
-                )
-            );
-            return false;
-        }
-        return true;
-    }
+	protected string $_payment_table;
+
+	protected string $_registration_table;
+
+	protected string $_registration_payment_table;
+
+
+	public function __construct()
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$this->_pretty_name = esc_html__('Registration Payment Record Generation', 'event_espresso');
+		// define tables
+		$this->_old_table                  = $wpdb->prefix . 'esp_transaction';
+		$this->_payment_table              = $wpdb->prefix . 'esp_payment';
+		$this->_registration_table         = $wpdb->prefix . 'esp_registration';
+		$this->_registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+		// build SQL WHERE clauses
+		$this->_extra_where_sql = "WHERE STS_ID IN ( 'TIN', 'TCM' ) AND TXN_Total != '0.000'";
+		parent::__construct();
+	}
+
+
+	/**
+	 * @param array $old_row
+	 * @return void
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$TXN_ID = absint($old_row['TXN_ID']);
+		if (! $TXN_ID) {
+			$this->add_error(
+				sprintf(
+					esc_html__('Invalid transaction with ID=%1$d. Error: "%2$s"', 'event_espresso'),
+					$TXN_ID,
+					$wpdb->last_error
+				)
+			);
+			return;
+		}
+		// get all payments for the TXN
+		$payments = $this->_get_payments($TXN_ID);
+		if (empty($payments)) {
+			return;
+		}
+		// then the registrants
+		$registrations = $this->_get_registrations($TXN_ID);
+		if (empty($registrations)) {
+			return;
+		}
+		// now loop thru each payment and apply it to each of the registrations
+		foreach ($payments as $payment) {
+			if ($payment->STS_ID === 'PAP' && $payment->PAY_amount > 0) {
+				$this->_process_registration_payments($payment, $registrations);
+			}
+		}
+	}
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @param int $TXN_ID
+	 * @return array
+	 */
+	protected function _get_registrations(int $TXN_ID): array
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$SQL = "SELECT * FROM $this->_registration_table WHERE TXN_ID = %d AND STS_ID IN ( 'RPP', 'RAP' )";
+		return $wpdb->get_results($wpdb->prepare($SQL, $TXN_ID), OBJECT_K);
+	}
+
+
+	/**
+	 * _get_payments
+	 *
+	 * @param int $TXN_ID
+	 * @return array
+	 */
+	protected function _get_payments(int $TXN_ID): array
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		return $wpdb->get_results(
+			$wpdb->prepare("SELECT * FROM $this->_payment_table WHERE TXN_ID = %d", $TXN_ID),
+			OBJECT_K
+		);
+	}
+
+
+	/**
+	 * _get_possibly_updated_REG_paid
+	 *
+	 * @param int $REG_ID
+	 * @return float
+	 */
+	protected function _get_possibly_updated_REG_paid(int $REG_ID): float
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		return (float) $wpdb->get_var(
+			$wpdb->prepare("SELECT REG_paid FROM $this->_registration_table WHERE REG_ID = %d", $REG_ID)
+		);
+	}
+
+
+	/**
+	 * _process_registration_payments
+	 * basically a copy of the "Sequential Registration Payment Application Strategy"  logic
+	 * currently in EE_Payment_Processor::process_registration_payments()
+	 *
+	 * @param stdClass $payment
+	 * @param array    $registrations
+	 * @return void
+	 */
+	protected function _process_registration_payments(stdClass $payment, array $registrations = [])
+	{
+		// how much is available to apply to registrations?
+		$available_payment_amount = $payment->PAY_amount;
+		foreach ($registrations as $REG_ID => $registration) {
+			// nothing left, then we are done here?
+			if (! $available_payment_amount > 0) {
+				break;
+			}
+			// ensure REG_final_price has a valid value, and skip if it turns out to be zero
+			$registration->REG_final_price =
+				! empty($registration->REG_final_price) ? (float) $registration->REG_final_price : 0.00;
+			if (! $registration->REG_final_price > 0) {
+				continue;
+			}
+			// because REG_paid may have been updated by a previous payment, we need to retrieve the value from the db
+			$registration->REG_paid = $this->_get_possibly_updated_REG_paid($REG_ID);
+			// calculate amount owing, and skip if it turns out to be zero
+			$owing = $registration->REG_final_price - $registration->REG_paid;
+			if (! $owing > 0) {
+				continue;
+			}
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount = $available_payment_amount - $payment_amount;
+			// add relation between registration and payment and set amount
+			if ($this->_insert_registration_payment($registration->REG_ID, $payment->PAY_ID, (float) $payment_amount)) {
+				// calculate and set new REG_paid
+				$registration->REG_paid = $registration->REG_paid + $payment_amount;
+				$this->_update_registration_paid($registration->REG_ID, (float) $registration->REG_paid);
+			}
+		}
+	}
+
+
+	/**
+	 * _insert_registration_payment
+	 *
+	 * @param int   $REG_ID
+	 * @param int   $PAY_ID
+	 * @param float $PAY_amount
+	 * @return bool
+	 */
+	protected function _insert_registration_payment(int $REG_ID = 0, int $PAY_ID = 0, float $PAY_amount = 0.00): bool
+	{
+		global $wpdb;
+		$success = $wpdb->insert(
+			$this->_registration_payment_table,
+			['REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount,],  // data
+			['%f']                                                                     // data format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						'Could not update registration paid value for registration ID=%1$d because "%2$s"',
+						'event_espresso'
+					),
+					$REG_ID,
+					$wpdb->last_error
+				)
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _update_registration_paid
+	 *
+	 * @param int   $REG_ID
+	 * @param float $REG_paid
+	 * @return bool
+	 */
+	protected function _update_registration_paid(int $REG_ID = 0, float $REG_paid = 0.00): bool
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$success = $wpdb->update(
+			$this->_registration_table,
+			['REG_paid' => $REG_paid],  // data
+			['REG_ID' => $REG_ID],      // where
+			['%f'],                     // data format
+			['%d']                      // where format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						'Could not update registration paid value for registration ID=%1$d because "%2$s"',
+						'event_espresso'
+					),
+					$REG_ID,
+					$wpdb->last_error
+				)
+			);
+			return false;
+		}
+		return true;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -22,10 +22,10 @@ 
         /** @type WPDB $wpdb */ global $wpdb;
         $this->_pretty_name = esc_html__('Registration Payment Record Generation', 'event_espresso');
         // define tables
-        $this->_old_table                  = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_table              = $wpdb->prefix . 'esp_payment';
-        $this->_registration_table         = $wpdb->prefix . 'esp_registration';
-        $this->_registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+        $this->_old_table                  = $wpdb->prefix.'esp_transaction';
+        $this->_payment_table              = $wpdb->prefix.'esp_payment';
+        $this->_registration_table         = $wpdb->prefix.'esp_registration';
+        $this->_registration_payment_table = $wpdb->prefix.'esp_registration_payment';
         // build SQL WHERE clauses
         $this->_extra_where_sql = "WHERE STS_ID IN ( 'TIN', 'TCM' ) AND TXN_Total != '0.000'";
         parent::__construct();
@@ -40,7 +40,7 @@ 
     {
         /** @type WPDB $wpdb */ global $wpdb;
         $TXN_ID = absint($old_row['TXN_ID']);
-        if (! $TXN_ID) {
+        if ( ! $TXN_ID) {
             $this->add_error(
                 sprintf(
                     esc_html__('Invalid transaction with ID=%1$d. Error: "%2$s"', 'event_espresso'),
@@ -129,20 +129,20 @@ 
         $available_payment_amount = $payment->PAY_amount;
         foreach ($registrations as $REG_ID => $registration) {
             // nothing left, then we are done here?
-            if (! $available_payment_amount > 0) {
+            if ( ! $available_payment_amount > 0) {
                 break;
             }
             // ensure REG_final_price has a valid value, and skip if it turns out to be zero
             $registration->REG_final_price =
                 ! empty($registration->REG_final_price) ? (float) $registration->REG_final_price : 0.00;
-            if (! $registration->REG_final_price > 0) {
+            if ( ! $registration->REG_final_price > 0) {
                 continue;
             }
             // because REG_paid may have been updated by a previous payment, we need to retrieve the value from the db
             $registration->REG_paid = $this->_get_possibly_updated_REG_paid($REG_ID);
             // calculate amount owing, and skip if it turns out to be zero
             $owing = $registration->REG_final_price - $registration->REG_paid;
-            if (! $owing > 0) {
+            if ( ! $owing > 0) {
                 continue;
             }
             // don't allow payment amount to exceed the available payment amount, OR the amount owing
@@ -172,7 +172,7 @@ 
         global $wpdb;
         $success = $wpdb->insert(
             $this->_registration_payment_table,
-            ['REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount,],  // data
+            ['REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount, ], // data
             ['%f']                                                                     // data format
         );
         if ($success === false) {
@@ -204,9 +204,9 @@ 
         /** @type WPDB $wpdb */ global $wpdb;
         $success = $wpdb->update(
             $this->_registration_table,
-            ['REG_paid' => $REG_paid],  // data
-            ['REG_ID' => $REG_ID],      // where
-            ['%f'],                     // data format
+            ['REG_paid' => $REG_paid], // data
+            ['REG_ID' => $REG_ID], // where
+            ['%f'], // data format
             ['%d']                      // where format
         );
         if ($success === false) {

core/data_migration_scripts/4_7_0_stages/EE_DMS_4_7_0_Add_Taxes_To_REG_Final_Price.dmsstage.php

Indentation +193 added lines, -193 removed lines

@@ -10,69 +10,69 @@ 
 class EE_DMS_4_7_0_Add_Taxes_To_REG_Final_Price extends EE_Data_Migration_Script_Stage_Table
 {
 
-    protected string $_ticket_table;
-
-    protected string $_line_item_table;
-
-
-    public function __construct()
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $this->_pretty_name = esc_html__('Registration Final Price Tax Calculations', 'event_espresso');
-        // define tables
-        $this->_old_table       = $wpdb->prefix . 'esp_registration';
-        $this->_ticket_table    = $wpdb->prefix . 'esp_ticket';
-        $this->_line_item_table = $wpdb->prefix . 'esp_line_item';
-        parent::__construct();
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _get_rest_of_sql_for_query(): string
-    {
-        $SQL = "FROM $this->_old_table AS reg ";
-        $SQL .= "JOIN $this->_ticket_table as tkt ON reg.TKT_ID = tkt.TKT_ID ";
-        $SQL .= "JOIN $this->_line_item_table as line ON reg.TXN_ID = line.TXN_ID ";
-        $SQL .= "WHERE tkt.TKT_taxable = 1 ";
-        $SQL .= "AND line.LIN_code = 'total' ";
-        $SQL .= "AND reg.REG_final_price > 0 ";
-        return $SQL;
-    }
-
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    public function _count_records_to_migrate(): int
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $SQL   = "SELECT count( reg.REG_ID ) ";
-        $SQL   .= $this->_get_rest_of_sql_for_query();
-        return (int) $wpdb->get_var($SQL);
-    }
-
-
-    /**
-     * Gets data for all registrations with taxable tickets in the esp_line_item table
-     *
-     * @param int   $limit
-     * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
-     * @global wpdb $wpdb
-     */
-    protected function _get_rows($limit): array
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $SQL             = "SELECT reg.REG_ID,  reg.REG_final_price, line.LIN_ID ";
-        $SQL             .= $this->_get_rest_of_sql_for_query();
-        $SQL             .= $wpdb->prepare("LIMIT %d, %d", $start_at_record, $limit);
-
-        // produces something like:
-        /*
+	protected string $_ticket_table;
+
+	protected string $_line_item_table;
+
+
+	public function __construct()
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$this->_pretty_name = esc_html__('Registration Final Price Tax Calculations', 'event_espresso');
+		// define tables
+		$this->_old_table       = $wpdb->prefix . 'esp_registration';
+		$this->_ticket_table    = $wpdb->prefix . 'esp_ticket';
+		$this->_line_item_table = $wpdb->prefix . 'esp_line_item';
+		parent::__construct();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _get_rest_of_sql_for_query(): string
+	{
+		$SQL = "FROM $this->_old_table AS reg ";
+		$SQL .= "JOIN $this->_ticket_table as tkt ON reg.TKT_ID = tkt.TKT_ID ";
+		$SQL .= "JOIN $this->_line_item_table as line ON reg.TXN_ID = line.TXN_ID ";
+		$SQL .= "WHERE tkt.TKT_taxable = 1 ";
+		$SQL .= "AND line.LIN_code = 'total' ";
+		$SQL .= "AND reg.REG_final_price > 0 ";
+		return $SQL;
+	}
+
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	public function _count_records_to_migrate(): int
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$SQL   = "SELECT count( reg.REG_ID ) ";
+		$SQL   .= $this->_get_rest_of_sql_for_query();
+		return (int) $wpdb->get_var($SQL);
+	}
+
+
+	/**
+	 * Gets data for all registrations with taxable tickets in the esp_line_item table
+	 *
+	 * @param int   $limit
+	 * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
+	 * @global wpdb $wpdb
+	 */
+	protected function _get_rows($limit): array
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$SQL             = "SELECT reg.REG_ID,  reg.REG_final_price, line.LIN_ID ";
+		$SQL             .= $this->_get_rest_of_sql_for_query();
+		$SQL             .= $wpdb->prepare("LIMIT %d, %d", $start_at_record, $limit);
+
+		// produces something like:
+		/*
             SELECT
               reg.REG_ID,
               reg.REG_final_price,
@@ -89,134 +89,134 @@ 
             LIMIT 1, 50
          */
 
-        return $wpdb->get_results($SQL, ARRAY_A);
-    }
-
-
-    /**
-     * @param array $old_row
-     * @return void
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        // ensure all required values are present
-        if (! isset($old_row['REG_ID'], $old_row['REG_final_price'], $old_row['LIN_ID'])) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        'Invalid query results returned with the following data:%1$s REG_ID=%2$d, REG_final_price=%3$d, LIN_ID=%4$f. Error: "%5$s"',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $old_row['REG_ID'] ?? '',
-                    $old_row['REG_final_price'] ?? '',
-                    $old_row['LIN_ID'] ?? '',
-                    $wpdb->last_error
-                )
-            );
-            return;
-        }
-        // get tax subtotal
-        $tax_subtotal_line_item_ID = $this->_get_line_item_ID_for_tax_subtotal($old_row['LIN_ID']);
-        if (! $tax_subtotal_line_item_ID) {
-            $this->add_error(
-                sprintf(
-                    esc_html__('Invalid line item ID returned. Error: "%1$s"', 'event_espresso'),
-                    $wpdb->last_error
-                )
-            );
-            return;
-        }
-        // now get taxes
-        $taxes = $this->_get_tax_amounts($tax_subtotal_line_item_ID);
-        // apply taxes to registration final price
-        $this->_apply_taxes($old_row['REG_ID'], (float) $old_row['REG_final_price'], $taxes);
-    }
-
-
-    /**
-     * _get_tax_subtotal
-     *
-     * @param int $LIN_ID
-     * @return int
-     */
-    protected function _get_line_item_ID_for_tax_subtotal(int $LIN_ID): int
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $SQL = "SELECT LIN_ID ";
-        $SQL .= "FROM $this->_line_item_table ";
-        $SQL .= "WHERE LIN_parent = %d ";
-        $SQL .= "AND LIN_code = 'taxes'";
-        return (int) $wpdb->get_var($wpdb->prepare($SQL, $LIN_ID));
-    }
-
-
-    /**
-     * _get_tax_subtotal
-     *
-     * @param int $LIN_ID
-     * @return array
-     */
-    protected function _get_tax_amounts(int $LIN_ID): array
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $SQL = "SELECT LIN_percent ";
-        $SQL .= "FROM $this->_line_item_table ";
-        $SQL .= "WHERE LIN_parent = %d";
-        return $wpdb->get_results($wpdb->prepare($SQL, $LIN_ID), OBJECT_K);
-    }
-
-
-    /**
-     * _apply_taxes
-     *
-     * @param int   $REG_ID
-     * @param float $final_price
-     * @param array $taxes
-     * @return void
-     */
-    protected function _apply_taxes(int $REG_ID = 0, float $final_price = 0.00, array $taxes = [])
-    {
-        if (is_array($taxes) && ! empty($taxes)) {
-            $total_taxes = 0;
-            foreach ($taxes as $tax) {
-                $total_taxes += $final_price * ($tax->LIN_percent / 100);
-            }
-            $final_price += $total_taxes;
-            $this->_update_registration_final_price($REG_ID, (float) $final_price);
-        }
-    }
-
-
-    /**
-     * _update_registration_final_price
-     *
-     * @param int   $REG_ID
-     * @param float $REG_final_price
-     * @return void
-     */
-    protected function _update_registration_final_price(int $REG_ID = 0, float $REG_final_price = 0.00)
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $success = $wpdb->update(
-            $this->_old_table,
-            ['REG_final_price' => $REG_final_price],  // data
-            ['REG_ID' => $REG_ID],                    // where
-            ['%f'],                                   // data format
-            ['%d']                                    // where format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        'Could not update registration final price value for registration ID=%1$d because "%2$s"',
-                        'event_espresso'
-                    ),
-                    $REG_ID,
-                    $wpdb->last_error
-                )
-            );
-        }
-    }
+		return $wpdb->get_results($SQL, ARRAY_A);
+	}
+
+
+	/**
+	 * @param array $old_row
+	 * @return void
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		// ensure all required values are present
+		if (! isset($old_row['REG_ID'], $old_row['REG_final_price'], $old_row['LIN_ID'])) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						'Invalid query results returned with the following data:%1$s REG_ID=%2$d, REG_final_price=%3$d, LIN_ID=%4$f. Error: "%5$s"',
+						'event_espresso'
+					),
+					'<br />',
+					$old_row['REG_ID'] ?? '',
+					$old_row['REG_final_price'] ?? '',
+					$old_row['LIN_ID'] ?? '',
+					$wpdb->last_error
+				)
+			);
+			return;
+		}
+		// get tax subtotal
+		$tax_subtotal_line_item_ID = $this->_get_line_item_ID_for_tax_subtotal($old_row['LIN_ID']);
+		if (! $tax_subtotal_line_item_ID) {
+			$this->add_error(
+				sprintf(
+					esc_html__('Invalid line item ID returned. Error: "%1$s"', 'event_espresso'),
+					$wpdb->last_error
+				)
+			);
+			return;
+		}
+		// now get taxes
+		$taxes = $this->_get_tax_amounts($tax_subtotal_line_item_ID);
+		// apply taxes to registration final price
+		$this->_apply_taxes($old_row['REG_ID'], (float) $old_row['REG_final_price'], $taxes);
+	}
+
+
+	/**
+	 * _get_tax_subtotal
+	 *
+	 * @param int $LIN_ID
+	 * @return int
+	 */
+	protected function _get_line_item_ID_for_tax_subtotal(int $LIN_ID): int
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$SQL = "SELECT LIN_ID ";
+		$SQL .= "FROM $this->_line_item_table ";
+		$SQL .= "WHERE LIN_parent = %d ";
+		$SQL .= "AND LIN_code = 'taxes'";
+		return (int) $wpdb->get_var($wpdb->prepare($SQL, $LIN_ID));
+	}
+
+
+	/**
+	 * _get_tax_subtotal
+	 *
+	 * @param int $LIN_ID
+	 * @return array
+	 */
+	protected function _get_tax_amounts(int $LIN_ID): array
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$SQL = "SELECT LIN_percent ";
+		$SQL .= "FROM $this->_line_item_table ";
+		$SQL .= "WHERE LIN_parent = %d";
+		return $wpdb->get_results($wpdb->prepare($SQL, $LIN_ID), OBJECT_K);
+	}
+
+
+	/**
+	 * _apply_taxes
+	 *
+	 * @param int   $REG_ID
+	 * @param float $final_price
+	 * @param array $taxes
+	 * @return void
+	 */
+	protected function _apply_taxes(int $REG_ID = 0, float $final_price = 0.00, array $taxes = [])
+	{
+		if (is_array($taxes) && ! empty($taxes)) {
+			$total_taxes = 0;
+			foreach ($taxes as $tax) {
+				$total_taxes += $final_price * ($tax->LIN_percent / 100);
+			}
+			$final_price += $total_taxes;
+			$this->_update_registration_final_price($REG_ID, (float) $final_price);
+		}
+	}
+
+
+	/**
+	 * _update_registration_final_price
+	 *
+	 * @param int   $REG_ID
+	 * @param float $REG_final_price
+	 * @return void
+	 */
+	protected function _update_registration_final_price(int $REG_ID = 0, float $REG_final_price = 0.00)
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$success = $wpdb->update(
+			$this->_old_table,
+			['REG_final_price' => $REG_final_price],  // data
+			['REG_ID' => $REG_ID],                    // where
+			['%f'],                                   // data format
+			['%d']                                    // where format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						'Could not update registration final price value for registration ID=%1$d because "%2$s"',
+						'event_espresso'
+					),
+					$REG_ID,
+					$wpdb->last_error
+				)
+			);
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -20,9 +20,9 @@ 
         /** @type WPDB $wpdb */ global $wpdb;
         $this->_pretty_name = esc_html__('Registration Final Price Tax Calculations', 'event_espresso');
         // define tables
-        $this->_old_table       = $wpdb->prefix . 'esp_registration';
-        $this->_ticket_table    = $wpdb->prefix . 'esp_ticket';
-        $this->_line_item_table = $wpdb->prefix . 'esp_line_item';
+        $this->_old_table       = $wpdb->prefix.'esp_registration';
+        $this->_ticket_table    = $wpdb->prefix.'esp_ticket';
+        $this->_line_item_table = $wpdb->prefix.'esp_line_item';
         parent::__construct();
     }
 
@@ -50,8 +50,8 @@ 
     public function _count_records_to_migrate(): int
     {
         /** @type WPDB $wpdb */ global $wpdb;
-        $SQL   = "SELECT count( reg.REG_ID ) ";
-        $SQL   .= $this->_get_rest_of_sql_for_query();
+        $SQL = "SELECT count( reg.REG_ID ) ";
+        $SQL .= $this->_get_rest_of_sql_for_query();
         return (int) $wpdb->get_var($SQL);
     }
 
@@ -101,7 +101,7 @@ 
     {
         /** @type WPDB $wpdb */ global $wpdb;
         // ensure all required values are present
-        if (! isset($old_row['REG_ID'], $old_row['REG_final_price'], $old_row['LIN_ID'])) {
+        if ( ! isset($old_row['REG_ID'], $old_row['REG_final_price'], $old_row['LIN_ID'])) {
             $this->add_error(
                 sprintf(
                     esc_html__(
@@ -119,7 +119,7 @@ 
         }
         // get tax subtotal
         $tax_subtotal_line_item_ID = $this->_get_line_item_ID_for_tax_subtotal($old_row['LIN_ID']);
-        if (! $tax_subtotal_line_item_ID) {
+        if ( ! $tax_subtotal_line_item_ID) {
             $this->add_error(
                 sprintf(
                     esc_html__('Invalid line item ID returned. Error: "%1$s"', 'event_espresso'),
@@ -201,9 +201,9 @@ 
         /** @type WPDB $wpdb */ global $wpdb;
         $success = $wpdb->update(
             $this->_old_table,
-            ['REG_final_price' => $REG_final_price],  // data
-            ['REG_ID' => $REG_ID],                    // where
-            ['%f'],                                   // data format
+            ['REG_final_price' => $REG_final_price], // data
+            ['REG_ID' => $REG_ID], // where
+            ['%f'], // data format
             ['%d']                                    // where format
         );
         if ($success === false) {

core/data_migration_scripts/EE_DMS_Core_5_0_0.dms.php

Indentation +244 added lines, -244 removed lines

@@ -11,9 +11,9 @@ 
 $stages            = glob(EE_CORE . 'data_migration_scripts/5_0_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
-    $matches = [];
-    preg_match('~5_0_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = [];
+	preg_match('~5_0_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_5_0_0__autoloaded_stages', $class_to_filepath);
@@ -29,65 +29,65 @@ 
  */
 class EE_DMS_Core_5_0_0 extends EE_Data_Migration_Script_Base
 {
-    /**
-     * @param EE_DMS_Core_4_10_0 $dms_4_10
-     * @param TableManager|null  $table_manager
-     * @param TableAnalysis|null $table_analysis
-     */
-    public function __construct(
-        EE_DMS_Core_4_10_0 $dms_4_10,
-        TableManager $table_manager = null,
-        TableAnalysis $table_analysis = null
-    ) {
-        $this->previous_dms      = $dms_4_10;
-        $this->_pretty_name      = esc_html__("Data Update to Event Espresso 5.0.0", "event_espresso");
-        $this->_priority         = 10;
-        $this->_migration_stages = [
-            new EE_DMS_5_0_0_Event_Venues(),
-        ];
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-    /**
-     * Whether to migrate or not.
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array): bool
-    {
-        $version_string = $version_array['Core'];
-        return $version_string &&
-               version_compare($version_string, '5.0.0.decaf', '<') &&
-               version_compare($version_string, '4.10.0.decaf', '>=');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function schema_changes_before_migration(): bool
-    {
-        require_once EE_HELPERS . 'EEH_Activation.helper.php';
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_answer',
-            ' ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @param EE_DMS_Core_4_10_0 $dms_4_10
+	 * @param TableManager|null  $table_manager
+	 * @param TableAnalysis|null $table_analysis
+	 */
+	public function __construct(
+		EE_DMS_Core_4_10_0 $dms_4_10,
+		TableManager $table_manager = null,
+		TableAnalysis $table_analysis = null
+	) {
+		$this->previous_dms      = $dms_4_10;
+		$this->_pretty_name      = esc_html__("Data Update to Event Espresso 5.0.0", "event_espresso");
+		$this->_priority         = 10;
+		$this->_migration_stages = [
+			new EE_DMS_5_0_0_Event_Venues(),
+		];
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array): bool
+	{
+		$version_string = $version_array['Core'];
+		return $version_string &&
+			   version_compare($version_string, '5.0.0.decaf', '<') &&
+			   version_compare($version_string, '4.10.0.decaf', '>=');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function schema_changes_before_migration(): bool
+	{
+		require_once EE_HELPERS . 'EEH_Activation.helper.php';
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_answer',
+			' 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_has_not_changed_since_previous(
-            'esp_attendee_meta',
-            "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_attendee_meta',
+			"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,
@@ -104,12 +104,12 @@ 
 				KEY ATT_email (ATT_email(191)),
 				KEY ATT_lname (ATT_lname),
 				KEY ATT_fname (ATT_fname)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_checkin',
-            "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_checkin',
+			"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,
@@ -117,12 +117,12 @@ 
 				PRIMARY KEY  (CHK_ID),
 				KEY REG_ID (REG_ID),
 				KEY DTT_ID (DTT_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_country',
-            "CNT_ISO varchar(2) NOT NULL,
+		$this->_table_has_not_changed_since_previous(
+			'esp_country',
+			"CNT_ISO varchar(2) NOT NULL,
 				CNT_ISO3 varchar(3) NOT NULL,
 				RGN_ID tinyint(3) unsigned DEFAULT NULL,
 				CNT_name varchar(45) NOT NULL,
@@ -138,38 +138,38 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_currency',
-            "CUR_code varchar(6) NOT NULL,
+		$this->_table_has_not_changed_since_previous(
+			'esp_currency',
+			"CUR_code varchar(6) NOT NULL,
 				CUR_single varchar(45) DEFAULT 'dollar',
 				CUR_plural varchar(45) DEFAULT 'dollars',
 				CUR_sign varchar(45) DEFAULT '$',
 				CUR_dec_plc varchar(1) NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)"
-        );
+		);
 
 
-        // note: although this table is no longer in use,
-        // it hasn't been removed because then queries to the model will have errors.
-        // but you should expect this table and its corresponding model to be removed in
-        // the next few months
-        $this->_table_is_new_in_this_version(
-            'esp_currency_payment_method',
-            "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		// note: although this table is no longer in use,
+		// it hasn't been removed because then queries to the model will have errors.
+		// but you should expect this table and its corresponding model to be removed in
+		// the next few months
+		$this->_table_is_new_in_this_version(
+			'esp_currency_payment_method',
+			"CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)"
-        );
+		);
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_datetime',
-            "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_datetime',
+			"DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
@@ -188,35 +188,35 @@ 
 				KEY DTT_EVT_end (DTT_EVT_end),
 				KEY EVT_ID (EVT_ID),
 				KEY VNU_ID (VNU_ID)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_datetime', 'DTT_is_primary');
+		);
+		$this->_get_table_manager()->dropIndex('esp_datetime', 'DTT_is_primary');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_datetime_ticket',
-            "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_datetime_ticket',
+			"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_has_not_changed_since_previous(
-            'esp_event_message_template',
-            "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_message_template',
+			"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_is_changed_in_this_version(
-            'esp_event_meta',
-            "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_event_meta',
+			"EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -234,12 +234,12 @@ 
 				PRIMARY KEY  (EVTM_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY VNU_ID (VNU_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_question_group',
-            "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_question_group',
+			"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,
@@ -247,34 +247,34 @@ 
 				PRIMARY KEY  (EQG_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY QSG_ID (QSG_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_venue',
-            "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_venue',
+			"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(
-            'esp_extra_meta',
-            "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_extra_meta',
+			"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_has_not_changed_since_previous(
-            'esp_extra_join',
-            "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_extra_join',
+			"EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(12) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(12) NOT NULL,
@@ -282,12 +282,12 @@ 
 				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(
-            'esp_form_element',
-            "FIN_UUID varchar(25) NOT NULL,
+		$this->_table_is_new_in_this_version(
+			'esp_form_element',
+			"FIN_UUID varchar(25) NOT NULL,
 				FSC_UUID varchar(25) NOT NULL,
 				FIN_adminOnly tinyint(1) unsigned NOT NULL DEFAULT 0,
 				FIN_attributes text DEFAULT NULL,
@@ -302,14 +302,14 @@ 
 				FIN_wpUser bigint(20) unsigned DEFAULT NULL,
 				PRIMARY KEY  (FIN_UUID),
 				KEY FSC_UUID (FSC_UUID)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_order');
-        $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_status');
+		);
+		$this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_order');
+		$this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_status');
 
 
-        $this->_table_is_new_in_this_version(
-            'esp_form_section',
-            "FSC_UUID varchar(25) NOT NULL,
+		$this->_table_is_new_in_this_version(
+			'esp_form_section',
+			"FSC_UUID varchar(25) NOT NULL,
 				FSC_appliesTo tinytext NOT NULL,
 				FSC_attributes text DEFAULT NULL,
 				FSC_belongsTo varchar(25) DEFAULT NULL,
@@ -319,14 +319,14 @@ 
 				FSC_wpUser bigint(20) unsigned DEFAULT NULL,
 				PRIMARY KEY  (FSC_UUID),
 				KEY FSC_belongsTo (FSC_belongsTo)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_order');
-        $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_status');
+		);
+		$this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_order');
+		$this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_status');
 
 
-        $this->_table_is_new_in_this_version(
-            'esp_form_submission',
-            "FSB_UUID varchar(25) NOT NULL,
+		$this->_table_is_new_in_this_version(
+			'esp_form_submission',
+			"FSB_UUID varchar(25) NOT NULL,
                 FSC_UUID varchar(25) NOT NULL,
 				TXN_ID int(10) DEFAULT NULL,
 				FSB_data mediumtext DEFAULT NULL,
@@ -334,12 +334,12 @@ 
 				PRIMARY KEY  (FSB_UUID),
 				KEY FSC_UUID (FSC_UUID),
 				KEY TXN_ID (TXN_ID)"
-        );
+		);
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_line_item',
-            "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_line_item',
+			"LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(10) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -361,12 +361,12 @@ 
 				KEY txn_type_timestamp (TXN_ID,LIN_type,LIN_timestamp),
 				KEY txn_obj_id_obj_type (TXN_ID,OBJ_ID,OBJ_type),
 				KEY obj_id_obj_type (OBJ_ID,OBJ_type)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_log',
-            "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_log',
+			"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,
@@ -377,12 +377,12 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_message',
-            "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_message',
+			"MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NULL,
 				MSG_token varchar(255) NULL,
 				TXN_ID int(10) unsigned NULL,
@@ -406,32 +406,32 @@ 
 				KEY MSG_to (MSG_to(191)),
 				KEY MSG_from (MSG_from(191)),
 				KEY MSG_modified (MSG_modified)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_message', 'MSG_messenger');
-        $this->_get_table_manager()->dropIndex('esp_message', 'MSG_message_type');
-        $this->_get_table_manager()->dropIndex('esp_message', 'MSG_context');
-        $this->_get_table_manager()->dropIndex('esp_message', 'MSG_recipient_type');
-        $this->_get_table_manager()->dropIndex('esp_message', 'MSG_subject');
-        $this->_get_table_manager()->dropIndex('esp_message', 'MSG_created');
-        $this->_get_table_manager()->dropIndex('esp_message', 'MSG_priority');
-        $this->_get_table_manager()->dropIndex('esp_message', 'STS_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_message_template',
-            "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->dropIndex('esp_message', 'MSG_messenger');
+		$this->_get_table_manager()->dropIndex('esp_message', 'MSG_message_type');
+		$this->_get_table_manager()->dropIndex('esp_message', 'MSG_context');
+		$this->_get_table_manager()->dropIndex('esp_message', 'MSG_recipient_type');
+		$this->_get_table_manager()->dropIndex('esp_message', 'MSG_subject');
+		$this->_get_table_manager()->dropIndex('esp_message', 'MSG_created');
+		$this->_get_table_manager()->dropIndex('esp_message', 'MSG_priority');
+		$this->_get_table_manager()->dropIndex('esp_message', 'STS_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_message_template',
+			"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(
-            'esp_message_template_group',
-            "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_message_template_group',
+			"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 '',
@@ -443,12 +443,12 @@ 
 				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(
-            'esp_payment',
-            "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_payment',
+			"PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_ID int(10) unsigned DEFAULT NULL,
 				STS_ID varchar(3) DEFAULT NULL,
 				PAY_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
@@ -465,12 +465,12 @@ 
 				PRIMARY KEY  (PAY_ID),
 				KEY PAY_timestamp (PAY_timestamp),
 				KEY TXN_ID (TXN_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_payment_method',
-            "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_payment_method',
+			"PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -485,13 +485,13 @@ 
 				PMD_scope varchar(255) NULL DEFAULT 'frontend',
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_payment_method', 'PMD_type');
+		);
+		$this->_get_table_manager()->dropIndex('esp_payment_method', 'PMD_type');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_price',
-            "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_price',
+			"PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,6) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -504,12 +504,12 @@ 
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID),
 				KEY PRT_ID (PRT_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_price_type',
-            "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_price_type',
+			"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',
@@ -518,33 +518,33 @@ 
 				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(
-            'esp_ticket_price',
-            "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_ticket_price',
+			"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_has_not_changed_since_previous(
-            'esp_ticket_template',
-            "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_ticket_template',
+			"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(
-            'esp_question',
-            "QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question',
+			"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) DEFAULT NULL,
@@ -557,13 +557,13 @@ 
 				QST_wp_user bigint(20) unsigned NULL,
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_question', 'QST_order');
+		);
+		$this->_get_table_manager()->dropIndex('esp_question', 'QST_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_group',
-            "QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_group',
+			"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,
@@ -576,25 +576,25 @@ 
 				PRIMARY KEY  (QSG_ID),
 				UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 				KEY QSG_order (QSG_order)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_order');
+		);
+		$this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_group_question',
-            "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_group_question',
+			"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)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_question_group_question', 'QSG_ID_order');
+		);
+		$this->_get_table_manager()->dropIndex('esp_question_group_question', 'QSG_ID_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_option',
-            "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_option',
+			"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,
@@ -603,13 +603,13 @@ 
 				QSO_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QSO_ID),
 				KEY QST_ID (QST_ID)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_question_option', 'QSO_order');
+		);
+		$this->_get_table_manager()->dropIndex('esp_question_option', 'QSO_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_registration',
-            "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_registration',
+			"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,
@@ -633,25 +633,25 @@ 
 				KEY ATT_ID (ATT_ID),
 				KEY TKT_ID (TKT_ID),
 				KEY EVT_ID (EVT_ID)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_registration', 'STS_ID');
+		);
+		$this->_get_table_manager()->dropIndex('esp_registration', 'STS_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_registration_payment',
-            "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_registration_payment',
+			"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(12,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID),
 					  KEY REG_ID (REG_ID),
 					  KEY PAY_ID (PAY_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_state',
-            "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_state',
+			"STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 				CNT_ISO varchar(2) NOT NULL,
 				STA_abbrev varchar(24) NOT NULL,
 				STA_name varchar(100) NOT NULL,
@@ -659,12 +659,12 @@ 
 				PRIMARY KEY  (STA_ID),
 				KEY STA_abbrev (STA_abbrev),
 				KEY CNT_ISO (CNT_ISO)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_status',
-            "STS_ID varchar(3) NOT NULL,
+		$this->_table_has_not_changed_since_previous(
+			'esp_status',
+			"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,
@@ -672,12 +672,12 @@ 
 				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(
-            'esp_ticket',
-            "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_ticket',
+			"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,
@@ -703,12 +703,12 @@ 
 				PRIMARY KEY  (TKT_ID),
 				KEY TKT_start_date (TKT_start_date),
 				KEY TKT_end_date (TKT_end_date)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_transaction',
-            "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_transaction',
+			"TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -719,13 +719,13 @@ 
 				TXN_reg_steps text,
 				PRIMARY KEY  (TXN_ID),
 				KEY TXN_timestamp (TXN_timestamp)"
-        );
-        $this->_get_table_manager()->dropIndex('esp_transaction', 'STS_ID');
+		);
+		$this->_get_table_manager()->dropIndex('esp_transaction', 'STS_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_venue_meta',
-            'VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_venue_meta',
+			'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,
@@ -744,26 +744,26 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)'
-        );
+		);
 
 
-        $this->previous_dms->insert_default_data();
-        $LegacyTextDomainOptions = new LegacyTextDomainOptions();
-        $LegacyTextDomainOptions->convertToConsolidatedFormat();
-        return true;
-    }
+		$this->previous_dms->insert_default_data();
+		$LegacyTextDomainOptions = new LegacyTextDomainOptions();
+		$LegacyTextDomainOptions->convertToConsolidatedFormat();
+		return true;
+	}
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_after_migration(): bool
-    {
-        return true;
-    }
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_after_migration(): bool
+	{
+		return true;
+	}
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 }

core/data_migration_scripts/EE_Data_Migration_Script_Base.core.php

Indentation +914 added lines, -914 removed lines

@@ -15,918 +15,918 @@
  */
 abstract class EE_Data_Migration_Script_Base extends EE_Data_Migration_Class_Base
 {
-    /**
-     * Set by client code to indicate this DMS is being ran as part of a proper migration,
-     * instead of being used to merely setup (or verify) the database structure.
-     * Defaults to TRUE, so client code that's NOT using this DMS as part of a proper migration
-     * should call EE_Data_Migration_Script_Base::set_migrating( FALSE )
-     *
-     * @var boolean
-     */
-    protected bool $_migrating = true;
-
-    /**
-     * numerically-indexed array where each value is EE_Data_Migration_Script_Stage object
-     *
-     * @var EE_Data_Migration_Script_Stage[] $migration_functions
-     */
-    protected array $_migration_stages = array();
-
-    /**
-     * Indicates we've already run the schema changes that needed to happen BEFORE the data migration
-     *
-     * @var boolean
-     */
-    protected ?bool $_schema_changes_before_migration_ran = null;
-
-    /**
-     * Indicates we've already run the schema changes that needed to happen AFTER the data migration
-     *
-     * @var boolean
-     */
-    protected ?bool $_schema_changes_after_migration_ran = null;
-
-    /**
-     * String which describes what's currently happening in this migration
-     *
-     * @var string|null
-     */
-    protected ?string $_feedback_message = '';
-
-    /**
-     * Indicates the script's priority. Like wp's add_action and add_filter, lower numbers
-     * correspond to earlier execution
-     *
-     * @var int
-     */
-    protected int $_priority = 5;
-
-    /**
-     * Multidimensional array that defines the mapping from OLD table Primary Keys
-     * to NEW table Primary Keys.
-     * Top-level array keys are OLD table names (minus the "wp_" part),
-     * 2nd-level array keys are NEW table names (again, minus the "wp_" part),
-     * 3rd-level array keys are the OLD table primary keys
-     * and 3rd-level array values are the NEW table primary keys
-     *
-     * @var array
-     */
-    protected array $_mappings = array();
-
-    /**
-     * @var EE_Data_Migration_Script_Base
-     */
-    protected EE_Data_Migration_Script_Base $previous_dms;
-
-
-    /**
-     * Returns whether this data migration script can operate on the given version of the database.
-     * Eg, if this migration script can migrate from 3.1.26 or higher (but not anything after 4.0.0), and
-     * it's passed a string like '3.1.38B', it should return true.
-     * If this DMS is to migrate data from an EE3 addon, you will probably want to use
-     * EventEspresso\core\services\database\TableAnalysis::tableExists() to check for old EE3 tables, and
-     * EE_Data_Migration_Manager::get_migration_ran() to check that core was already
-     * migrated from EE3 to EE4 (ie, this DMS probably relies on some migration data generated
-     * during the Core 4.1.0 DMS. If core didn't run that DMS, you probably don't want
-     * to run this DMS).
-     * If this DMS migrates data from a previous version of this EE4 addon, just
-     * comparing $current_database_state_of[ $this->slug() ] will probably suffice.
-     * If this DMS should never migrate data, because it's only used to define the initial
-     * database state, just return FALSE (and core's activation process will take care
-     * of calling its schema_changes_before_migration() and
-     * schema_changes_after_migration() for you. )
-     *
-     * @param array $version_array keys are EE plugin slugs (eg 'Core', 'Calendar', 'Mailchimp', etc)
-     * @return boolean
-     */
-    abstract public function can_migrate_from_version($version_array);
-
-
-    /**
-     * Performs database schema changes that need to occur BEFORE the data is migrated.
-     * Eg, if we were going to change user passwords from plaintext to encoded versions
-     * during this migration, this would probably add a new column called something like
-     * "encoded_password".
-     *
-     * @return boolean of success
-     */
-    abstract public function schema_changes_before_migration();
-
-
-    /**
-     * Performs the database schema changes that need to occur AFTER the data has been migrated.
-     * Usually this will mean we'll be removing old columns. Eg, if we were changing passwords
-     * from plaintext to encoded versions, and we had added a column called "encoded_password",
-     * this function would probably remove the old column "password" (which still holds the plaintext password)
-     * and possibly rename "encoded_password" to "password"
-     *
-     * @return boolean of success
-     */
-    abstract public function schema_changes_after_migration();
-
-
-    /**
-     * All children of this must call parent::__construct()
-     * at the end of their constructor or suffer the consequences!
-     *
-     * @param TableManager|null  $table_manager
-     * @param TableAnalysis|null $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_migration_stages = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__construct__migration_stages',
-            $this->_migration_stages
-        );
-        foreach ($this->_migration_stages as $migration_stage) {
-            if ($migration_stage instanceof EE_Data_Migration_Script_Stage) {
-                $migration_stage->_construct_finalize($this);
-            }
-        }
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-    /**
-     * Place to add hooks and filters for tweaking the migrations page, in order
-     * to customize it
-     */
-    public function migration_page_hooks()
-    {
-        // by default none are added because we normally like the default look of the migration page
-    }
-
-
-    /**
-     * Sets the mapping from old table primary keys to new table primary keys.
-     * This mapping is automatically persisted as a property on the migration
-     *
-     * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
-     * @param int|string $old_pk    old primary key. Eg events_detail.id's value
-     * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
-     * @param array|int|string $new_pk    eg posts.ID
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_mapping($old_table, $old_pk, $new_table, $new_pk)
-    {
-        // make sure it has the needed keys
-        if (! isset($this->_mappings[ $old_table ]) || ! isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
-        }
-        $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] = $new_pk;
-    }
-
-
-    /**
-     * Gets the new primary key, if provided with the OLD table and the primary key
-     * of an item in the old table, and the new table
-     *
-     * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
-     * @param int|string $old_pk    old primary key. Eg events_detail.id's value
-     * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
-     * @return mixed the primary key on the new table
-     * @throws EE_Error
-     */
-    public function get_mapping_new_pk($old_table, $old_pk, $new_table)
-    {
-        if (
-            ! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])
-        ) {
-            // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
-        }
-        return isset($this->_mappings[ $old_table ][ $new_table ][ $old_pk ])
-            ? $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] : null;
-    }
-
-
-    /**
-     * Gets the old primary key, if provided with the OLD table,
-     * and the new table and the primary key of an item in the new table
-     *
-     * @param string $old_table with wpdb prefix (wp_). Eg: wp_events_detail
-     * @param string $new_table with wpdb prefix (wp_). Eg: wp_posts
-     * @param mixed  $new_pk
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function get_mapping_old_pk($old_table, $new_table, $new_pk)
-    {
-        if (
-            ! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])
-        ) {
-            // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
-        }
-        if (isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $new_pk_to_old_pk = array_flip($this->_mappings[ $old_table ][ $new_table ]);
-            if (isset($new_pk_to_old_pk[ $new_pk ])) {
-                return $new_pk_to_old_pk[ $new_pk ];
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the mapping array option specified by the table names
-     *
-     * @param string $old_table_name
-     * @param string $new_table_name
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_mapping_option($old_table_name, $new_table_name)
-    {
-        return get_option($this->_get_mapping_option_name($old_table_name, $new_table_name), array());
-    }
-
-
-    /**
-     * Updates the mapping option specified by the table names with the array provided
-     *
-     * @param string $old_table_name
-     * @param string $new_table_name
-     * @param array  $mapping_array
-     * @return boolean success of updating option
-     * @throws EE_Error
-     */
-    protected function _set_mapping_option($old_table_name, $new_table_name, $mapping_array)
-    {
-        $success = update_option($this->_get_mapping_option_name($old_table_name, $new_table_name), $mapping_array, false);
-        return $success;
-    }
-
-
-    /**
-     * Gets the option name for this script to map from $old_table_name to $new_table_name
-     *
-     * @param string $old_table_name
-     * @param string $new_table_name
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_mapping_option_name($old_table_name, $new_table_name)
-    {
-        global $wpdb;
-        $old_table_name_sans_wp = str_replace($wpdb->prefix, "", $old_table_name);
-        $new_table_name_sans_wp = str_replace($wpdb->prefix, "", $new_table_name);
-        $migrates_to = EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
-        return substr(
-            EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix . $migrates_to ['slug'] . '_' . $migrates_to['version'] . '_' . $old_table_name_sans_wp . '_' . $new_table_name_sans_wp,
-            0,
-            64
-        );
-    }
-
-
-    /**
-     * Counts all the records that will be migrated during this data migration.
-     * For example, if we were changing old user passwords from plaintext to encoded versions,
-     * this would be a count of all users who have passwords. If we were going to also split
-     * attendee records into transactions, registrations, and attendee records, this would include
-     * the count of all attendees currently in existence in the DB (ie, users + attendees).
-     * If you can't determine how many records there are to migrate, just provide a guess: this
-     * number will only be used in calculating the percent complete. If you estimate there to be
-     * 100 records to migrate, and it turns out there's 120, we'll just show the migration as being at
-     * 99% until the function "migration_step" returns EE_Data_Migration_Script_Base::status_complete.
-     *
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        $count = 0;
-        foreach ($this->stages() as $stage) {
-            $count += $stage->count_records_to_migrate();
-        }
-        return $count;
-    }
-
-
-    /**
-     * Returns the number of records updated so far. Usually this is easiest to do
-     * by just setting a transient and updating it after each migration_step
-     *
-     * @return int
-     */
-    public function count_records_migrated()
-    {
-        $count = 0;
-        foreach ($this->stages() as $stage) {
-            $count += $stage->count_records_migrated();
-        }
-        $this->_records_migrated = $count;
-        return $count;
-    }
-
-
-    /**
-     * @param int $num_records_to_migrate_limit
-     * @return int
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function migration_step($num_records_to_migrate_limit)
-    {
-        // reset the feedback message
-        $this->_feedback_message = '';
-        // if we haven't yet done the 1st schema changes, do them now. buffer any output
-        $this->_maybe_do_schema_changes(true);
-
-        $num_records_actually_migrated = 0;
-        $records_migrated_per_stage = array();
-        // setup the 'stage' variable, which should hold the last run stage of the migration  (or none at all if nothing runs)
-        $stage = null;
-        // get the next stage that isn't complete
-        foreach ($this->stages() as $stage) {
-            if ($stage->get_status() == EE_Data_Migration_Manager::status_continue) {
-                try {
-                    $records_migrated_during_stage = $stage->migration_step(
-                        $num_records_to_migrate_limit - $num_records_actually_migrated
-                    );
-                    $num_records_actually_migrated += $records_migrated_during_stage;
-                    $records_migrated_per_stage[ $stage->pretty_name() ] = $records_migrated_during_stage;
-                } catch (Exception $e) {
-                    // yes if we catch an exception here, we consider that migration stage borked.
-                    $stage->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                    $this->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                    $stage->add_error($e->getMessage() . ". Stack-trace:" . $e->getTraceAsString());
-                    throw $e;
-                }
-                // check that the migration stage didn't mark itself as having a fatal error
-                if ($stage->is_broken()) {
-                    $this->set_broken();
-                    throw new EE_Error($stage->get_last_error());
-                }
-            }
-            // once we've migrated all the number we intended to (possibly from different stages), stop migrating
-            // or if we had a fatal error
-            // or if the current script stopped early- its not done, but it's done all it thinks we should do on this step
-            if (
-                $num_records_actually_migrated >= $num_records_to_migrate_limit
-                || $stage->is_broken()
-                || $stage->has_more_to_do()
-            ) {
-                break;
-            }
-        }
-        // check if we're all done this data migration...
-        // which is indicated by being done early AND the last stage claims to be done
-        if ($stage == null) {
-            // this migration script apparently has NO stages... which is super weird, but whatever
-            $this->set_completed();
-            $this->_maybe_do_schema_changes(false);
-        } elseif ($num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()) {
-            // apparently we're done, because we couldn't migrate the number we intended to
-            $this->set_completed();
-            $this->_update_feedback_message(array_reverse($records_migrated_per_stage));
-            // do schema changes for after the migration now
-            // first double-check we haven't already done this
-            $this->_maybe_do_schema_changes(false);
-        } else {
-            // update feedback message, keeping in mind that we show them with the most recent at the top
-            $this->_update_feedback_message(array_reverse($records_migrated_per_stage));
-        }
-        return $num_records_actually_migrated;
-    }
-
-
-    /**
-     * Updates the feedback message according to what was done during this migration stage.
-     *
-     * @param array $records_migrated_per_stage KEYS are pretty names for each stage; values are the count of records
-     *                                          migrated from that stage
-     * @return void
-     */
-    private function _update_feedback_message($records_migrated_per_stage)
-    {
-        $feedback_message_array = array();
-        foreach ($records_migrated_per_stage as $migration_stage_name => $num_records_migrated) {
-            $feedback_message_array[] = sprintf(
-                esc_html__("Migrated %d records successfully during %s", "event_espresso"),
-                $num_records_migrated,
-                $migration_stage_name
-            );
-        }
-        $this->_feedback_message .= implode("<br>", $feedback_message_array);
-    }
-
-
-    /**
-     * Calls either schema_changes_before_migration() (if $before==true) or schema_changes_after_migration
-     * (if $before==false). Buffers their outputs and stores them on the class.
-     *
-     * @param boolean $before
-     * @throws Exception
-     * @return void
-     */
-    private function _maybe_do_schema_changes($before = true)
-    {
-        // so this property will be either _schema_changes_after_migration_ran or _schema_changes_before_migration_ran
-        $property_name = '_schema_changes_' . ($before ? 'before' : 'after') . '_migration_ran';
-        if (! $this->{$property_name}) {
-            try {
-                ob_start();
-                if ($before) {
-                    $this->schema_changes_before_migration();
-                } else {
-                    $this->schema_changes_after_migration();
-                }
-                $output = ob_get_contents();
-                ob_end_clean();
-            } catch (Exception $e) {
-                $this->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                throw $e;
-            }
-            // record that we've done these schema changes
-            $this->{$property_name} = true;
-            // if there were any warnings etc, record them as non-fatal errors
-            if ($output) {
-                // there were some warnings
-                $this->_errors[] = $output;
-            }
-        }
-    }
-
-
-    /**
-     * Wrapper for EEH_Activation::create_table. However, takes into account the request type when
-     * deciding what to pass for its 4th arg, $drop_pre_existing_tables. Using this function, instead
-     * of _table_should_exist_previously, indicates that this table should be new to the EE version being migrated to
-     * or
-     * activated currently. If this is a brand new activation or a migration, and we're indicating this table should
-     * not
-     * previously exist, then we want to set $drop_pre_existing_tables to TRUE (ie, we shouldn't discover that this
-     * table exists in the DB in EEH_Activation::create_table- if it DOES exist, something's wrong and the old table
-     * should be nuked.
-     *
-     * Just for a bit of context, the migration script's db_schema_changes_* methods
-     * are called basically in 3 cases: on brand new activation of EE4 (ie no previous version of EE existed and the
-     * plugin is being activated and we want to add all the brand new tables), upon reactivation of EE4 (it was
-     * deactivated and then reactivated, in which case we want to just verify the DB structure is ok) that table should
-     * be dropped), and during a migration when we're moving the DB to the state of the migration script
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _table_is_new_in_this_version(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=InnoDB'
-    ) {
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(true)
-        );
-    }
-
-
-    /**
-     * Like _table_is_new_in_this_version and _table_should_exist_previously, this function verifies the given table
-     * exists. But we understand that this table has CHANGED in this version since the previous version. So it's not
-     * completely new, but it's different. So we need to treat it like a new table in terms of verifying it's schema is
-     * correct on activations, migrations, upgrades; but if it exists when it shouldn't, we need to be as lenient as
-     * _table_should_exist_previously.
-     * 8656]{Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the
-     * table shouldn't exist).
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _table_is_changed_in_this_version(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=InnoDB'
-    ) {
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(false)
-        );
-    }
-
-
-    /**
-     * _old_table_exists
-     * returns TRUE if the requested table exists in the current database
-     *
-     * @param string $table_name
-     * @return boolean
-     * @throws EE_Error
-     */
-    protected function _old_table_exists($table_name)
-    {
-        return $this->_get_table_analysis()->tableExists($table_name);
-    }
-
-
-    /**
-     * _delete_table_if_empty
-     * returns TRUE if the requested table was empty and successfully empty
-     *
-     * @param string $table_name
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_table_if_empty($table_name)
-    {
-        return EEH_Activation::delete_db_table_if_empty($table_name);
-    }
-
-
-    /**
-     * It is preferred to use _table_has_not_changed_since_previous or _table_is_changed_in_this_version
-     * as these are significantly more efficient or explicit.
-     * Please see description of _table_is_new_in_this_version. This function will only set
-     * EEH_Activation::create_table's $drop_pre_existing_tables to TRUE if it's a brand
-     * new activation. ie, a more accurate name for this method would be "_table_added_previously_by_this_plugin"
-     * because the table will be cleared out if this is a new activation (ie, if its a new activation, it actually
-     * should exist previously). Otherwise, we'll always set $drop_pre_existing_tables to FALSE because the table
-     * should have existed. Note, if the table is being MODIFIED in this version being activated or migrated to, then
-     * you want _table_is_changed_in_this_version NOT this one. We don't check this table's structure during migrations
-     * because apparently it hasn't changed since the previous one, right?
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _table_should_exist_previously(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=InnoDB'
-    ) {
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(false)
-        );
-    }
-
-
-    /**
-     * Exactly the same as _table_should_exist_previously(), except if this migration script is currently doing
-     * a migration, we skip checking this table's structure in the database and just assume it's correct.
-     * So this is useful only to improve efficiency when doing migrations (not a big deal for single site installs,
-     * but important for multisite where migrations can take a very long time otherwise).
-     * If the table is known to have changed since previous version, use _table_is_changed_in_this_version().
-     * Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the table
-     * shouldn't exist).
-     *
-     * @param string $table_name
-     * @param string $table_definition_sql
-     * @param string $engine_string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _table_has_not_changed_since_previous(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=InnoDB'
-    ) {
-        if ($this->_currently_migrating()) {
-            // if we're doing a migration, and this table apparently already exists, then we don't need do anything right?
-            return;
-        }
-        $this->_create_table_and_catch_errors(
-            $table_name,
-            $table_definition_sql,
-            $engine_string,
-            $this->_pre_existing_table_should_be_dropped(false)
-        );
-    }
-
-    /**
-     * Returns whether this migration script is being used as part of an actual migration
-     *
-     * @return boolean
-     */
-    protected function _currently_migrating()
-    {
-        // we want to know if we are currently performing a migration. We could just believe what was set on the _migrating property, but let's double-check (ie the script should apply and we should be in MM)
-        return $this->_migrating
-            && DbStatus::isOffline()
-            && $this->can_migrate_from_version(
-                EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set()
-            );
-    }
-
-
-    /**
-     * Determines if a table should be dropped, based on whether it's reported to be new in $table_is_new,
-     * and the plugin's request type.
-     * Assumes only this plugin could have added the table (ie, if its a new activation of this plugin, the table
-     * shouldn't exist no matter what).
-     *
-     * @param boolean $table_is_new
-     * @return boolean
-     * @throws EE_Error
-     */
-    protected function _pre_existing_table_should_be_dropped($table_is_new)
-    {
-        if ($table_is_new) {
-            if (
-                $this->_get_req_type_for_plugin_corresponding_to_this_dms() == EE_System::req_type_new_activation
-                || $this->_currently_migrating()
-            ) {
-                return true;
-            } else {
-                return false;
-            }
-        } else {
-            if (
-                in_array(
-                    $this->_get_req_type_for_plugin_corresponding_to_this_dms(),
-                    array(EE_System::req_type_new_activation)
-                )
-            ) {
-                return true;
-            } else {
-                return false;
-            }
-        }
-    }
-
-
-    /**
-     * Just wraps EEH_Activation::create_table, but catches any errors it may throw and adds them as errors on the DMS
-     *
-     * @param string  $table_name
-     * @param string  $table_definition_sql
-     * @param string  $engine_string
-     * @param boolean $drop_pre_existing_tables
-     * @throws ReflectionException
-     */
-    private function _create_table_and_catch_errors(
-        $table_name,
-        $table_definition_sql,
-        $engine_string = 'ENGINE=InnoDB',
-        $drop_pre_existing_tables = false
-    ) {
-        try {
-            EEH_Activation::create_table($table_name, $table_definition_sql, $engine_string, $drop_pre_existing_tables);
-        } catch (EE_Error $e) {
-            $message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString();
-            $this->add_error($message);
-            $this->_feedback_message .= $message;
-        }
-    }
-
-
-    /**
-     * Gets the request type for the plugin (core or addon) that corresponds to this DMS
-     *
-     * @return int one of EE_System::_req_type_* constants
-     * @throws EE_Error
-     */
-    private function _get_req_type_for_plugin_corresponding_to_this_dms()
-    {
-        if ($this->slug() == 'Core') {
-            return EE_System::instance()->detect_req_type();
-        } else {// it must be for an addon
-            $addon_name = $this->slug();
-            if (EE_Registry::instance()->get_addon_by_name($addon_name)) {
-                return EE_Registry::instance()->get_addon_by_name($addon_name)->detect_req_type();
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "The DMS slug '%s' should correspond to the addon's name, which should also be '%s', but no such addon was registered. These are the registered addons' names: %s",
-                            "event_espresso"
-                        ),
-                        $this->slug(),
-                        $addon_name,
-                        implode(",", array_keys(EE_Registry::instance()->get_addons_by_name()))
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * returns an array of strings describing errors by all the script's stages
-     *
-     * @return array
-     */
-    public function get_errors()
-    {
-        $all_errors = $this->_errors;
-        if (! is_array($all_errors)) {
-            $all_errors = array();
-        }
-        foreach ($this->stages() as $stage) {
-            $all_errors = array_merge($stage->get_errors(), $all_errors);
-        }
-        return $all_errors;
-    }
-
-
-    /**
-     * Indicates whether this migration script should continue
-     *
-     * @return boolean
-     */
-    public function can_continue()
-    {
-        return in_array(
-            $this->get_status(),
-            EE_Data_Migration_Manager::instance()->stati_that_indicate_to_continue_single_migration_script
-        );
-    }
-
-
-    /**
-     * Gets all the data migration stages associated with this script. Note:
-     * addons can filter this list to add their own stages, and because the list is
-     * numerically-indexed, they can insert their stage wherever they like and it will
-     * get ordered by the indexes
-     *
-     * @return EE_Data_Migration_Script_Stage[]
-     */
-    protected function stages()
-    {
-        $stages = apply_filters('FHEE__' . get_class($this) . '__stages', $this->_migration_stages);
-        ksort($stages);
-        return $stages;
-    }
-
-
-    /**
-     * Gets a string which should describe what's going on currently with this migration, which
-     * can be displayed to the user
-     *
-     * @return string
-     */
-    public function get_feedback_message()
-    {
-        return $this->_feedback_message;
-    }
-
-
-    /**
-     * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
-     * properties to the DB. However, we don't want to use __sleep() because its quite
-     * possible that this class is defined when it goes to sleep, but NOT available when it
-     * awakes (eg, this class is part of an addon that is deactivated at some point).
-     */
-    public function properties_as_array()
-    {
-        $properties = parent::properties_as_array();
-        $properties['_migration_stages'] = array();
-        foreach ($this->_migration_stages as $migration_stage_priority => $migration_stage_class) {
-            $properties['_migration_stages'][ $migration_stage_priority ] = $migration_stage_class->properties_as_array(
-            );
-        }
-        unset($properties['_mappings']);
-        unset($properties['previous_dms']);
-
-        foreach ($this->_mappings as $old_table_name => $mapping_to_new_table) {
-            foreach ($mapping_to_new_table as $new_table_name => $mapping) {
-                $this->_set_mapping_option($old_table_name, $new_table_name, $mapping);
-            }
-        }
-        return $properties;
-    }
-
-
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     * @return void
-     */
-    public function instantiate_from_array_of_properties($array_of_properties)
-    {
-        $stages_properties_arrays = $array_of_properties['_migration_stages'];
-        unset($array_of_properties['_migration_stages']);
-        unset($array_of_properties['class']);
-        foreach ($array_of_properties as $property_name => $property_value) {
-            $this->{$property_name} = $property_value;
-        }
-        // _migration_stages are already instantiated, but have only default data
-        foreach ($this->_migration_stages as $stage) {
-            $stage_data = $this->_find_migration_stage_data_with_classname(
-                get_class($stage),
-                $stages_properties_arrays
-            );
-            // SO, if we found the stage data that was saved, use it. Otherwise, I guess the stage is new? (maybe added by
-            // an addon? Unlikely... not sure why it wouldn't exist, but if it doesn't just treat it like it was never started yet)
-            if ($stage_data) {
-                $stage->instantiate_from_array_of_properties($stage_data);
-            }
-        }
-    }
-
-
-    /**
-     * Gets the migration data from the array $migration_stage_data_arrays (which is an array of arrays, each of which
-     * is pretty well identical to EE_Data_Migration_Stage objects except all their properties are array indexes)
-     * for the given classname
-     *
-     * @param string $classname
-     * @param array  $migration_stage_data_arrays
-     * @return null
-     */
-    private function _find_migration_stage_data_with_classname($classname, $migration_stage_data_arrays)
-    {
-        foreach ($migration_stage_data_arrays as $migration_stage_data_array) {
-            if (isset($migration_stage_data_array['class']) && $migration_stage_data_array['class'] == $classname) {
-                return $migration_stage_data_array;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns the version that this script migrates to, based on the script's name.
-     * Cannot be overwritten because lots of code needs to know which version a script
-     * migrates to knowing only its name.
-     *
-     * @return array where the first key is the plugin's slug, the 2nd is the version of that plugin
-     * that will be updated to. Eg array('Core','4.1.0')
-     * @throws EE_Error
-     */
-    final public function migrates_to_version()
-    {
-        return EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
-    }
-
-
-    /**
-     * Gets this addon's slug as it would appear in the current_db_state wp option,
-     * and if this migration script is for an addon, it SHOULD match the addon's slug
-     * (and also the addon's classname, minus the 'EE_' prefix.). Eg, 'Calendar' for the EE_Calendar addon.
-     * Or 'Core' for core (non-addon).
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function slug()
-    {
-        $migrates_to_version_info = $this->migrates_to_version();
-        // the slug is the first part of the array
-        return $migrates_to_version_info['slug'];
-    }
-
-
-    /**
-     * Returns the script's priority relative to DMSs from other addons. However, when
-     * two DMSs from the same addon/core apply, this is ignored (and instead the version that
-     * the script migrates to is used to determine which to run first). The default is 5, but all core DMSs
-     * normally have priority 10. (So if you want a DMS "A" to run before DMS "B", both of which are from addons,
-     * and both of which CAN run at the same time (ie, "B" doesn't depend on "A" to set
-     * the database up so it can run), then you can set "A" to priority 3 or something.
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->_priority;
-    }
-
-
-    /**
-     * Sets whether this DMS is being ran as part of a migration, instead of
-     * just being used to setup (or verify) the current database structure matches
-     * what the latest DMS indicates it should be
-     *
-     * @param boolean $migrating
-     * @return void
-     */
-    public function set_migrating($migrating = true)
-    {
-        $this->_migrating = $migrating;
-    }
-
-    /**
-     * Marks that we think this migration class can continue to migrate
-     */
-    public function reattempt()
-    {
-        parent::reattempt();
-        // also, we want to reattempt any stages that were marked as borked
-        foreach ($this->stages() as $stage) {
-            if ($stage->is_broken()) {
-                $stage->reattempt();
-            }
-        }
-    }
+	/**
+	 * Set by client code to indicate this DMS is being ran as part of a proper migration,
+	 * instead of being used to merely setup (or verify) the database structure.
+	 * Defaults to TRUE, so client code that's NOT using this DMS as part of a proper migration
+	 * should call EE_Data_Migration_Script_Base::set_migrating( FALSE )
+	 *
+	 * @var boolean
+	 */
+	protected bool $_migrating = true;
+
+	/**
+	 * numerically-indexed array where each value is EE_Data_Migration_Script_Stage object
+	 *
+	 * @var EE_Data_Migration_Script_Stage[] $migration_functions
+	 */
+	protected array $_migration_stages = array();
+
+	/**
+	 * Indicates we've already run the schema changes that needed to happen BEFORE the data migration
+	 *
+	 * @var boolean
+	 */
+	protected ?bool $_schema_changes_before_migration_ran = null;
+
+	/**
+	 * Indicates we've already run the schema changes that needed to happen AFTER the data migration
+	 *
+	 * @var boolean
+	 */
+	protected ?bool $_schema_changes_after_migration_ran = null;
+
+	/**
+	 * String which describes what's currently happening in this migration
+	 *
+	 * @var string|null
+	 */
+	protected ?string $_feedback_message = '';
+
+	/**
+	 * Indicates the script's priority. Like wp's add_action and add_filter, lower numbers
+	 * correspond to earlier execution
+	 *
+	 * @var int
+	 */
+	protected int $_priority = 5;
+
+	/**
+	 * Multidimensional array that defines the mapping from OLD table Primary Keys
+	 * to NEW table Primary Keys.
+	 * Top-level array keys are OLD table names (minus the "wp_" part),
+	 * 2nd-level array keys are NEW table names (again, minus the "wp_" part),
+	 * 3rd-level array keys are the OLD table primary keys
+	 * and 3rd-level array values are the NEW table primary keys
+	 *
+	 * @var array
+	 */
+	protected array $_mappings = array();
+
+	/**
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	protected EE_Data_Migration_Script_Base $previous_dms;
+
+
+	/**
+	 * Returns whether this data migration script can operate on the given version of the database.
+	 * Eg, if this migration script can migrate from 3.1.26 or higher (but not anything after 4.0.0), and
+	 * it's passed a string like '3.1.38B', it should return true.
+	 * If this DMS is to migrate data from an EE3 addon, you will probably want to use
+	 * EventEspresso\core\services\database\TableAnalysis::tableExists() to check for old EE3 tables, and
+	 * EE_Data_Migration_Manager::get_migration_ran() to check that core was already
+	 * migrated from EE3 to EE4 (ie, this DMS probably relies on some migration data generated
+	 * during the Core 4.1.0 DMS. If core didn't run that DMS, you probably don't want
+	 * to run this DMS).
+	 * If this DMS migrates data from a previous version of this EE4 addon, just
+	 * comparing $current_database_state_of[ $this->slug() ] will probably suffice.
+	 * If this DMS should never migrate data, because it's only used to define the initial
+	 * database state, just return FALSE (and core's activation process will take care
+	 * of calling its schema_changes_before_migration() and
+	 * schema_changes_after_migration() for you. )
+	 *
+	 * @param array $version_array keys are EE plugin slugs (eg 'Core', 'Calendar', 'Mailchimp', etc)
+	 * @return boolean
+	 */
+	abstract public function can_migrate_from_version($version_array);
+
+
+	/**
+	 * Performs database schema changes that need to occur BEFORE the data is migrated.
+	 * Eg, if we were going to change user passwords from plaintext to encoded versions
+	 * during this migration, this would probably add a new column called something like
+	 * "encoded_password".
+	 *
+	 * @return boolean of success
+	 */
+	abstract public function schema_changes_before_migration();
+
+
+	/**
+	 * Performs the database schema changes that need to occur AFTER the data has been migrated.
+	 * Usually this will mean we'll be removing old columns. Eg, if we were changing passwords
+	 * from plaintext to encoded versions, and we had added a column called "encoded_password",
+	 * this function would probably remove the old column "password" (which still holds the plaintext password)
+	 * and possibly rename "encoded_password" to "password"
+	 *
+	 * @return boolean of success
+	 */
+	abstract public function schema_changes_after_migration();
+
+
+	/**
+	 * All children of this must call parent::__construct()
+	 * at the end of their constructor or suffer the consequences!
+	 *
+	 * @param TableManager|null  $table_manager
+	 * @param TableAnalysis|null $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_migration_stages = (array) apply_filters(
+			'FHEE__' . get_class($this) . '__construct__migration_stages',
+			$this->_migration_stages
+		);
+		foreach ($this->_migration_stages as $migration_stage) {
+			if ($migration_stage instanceof EE_Data_Migration_Script_Stage) {
+				$migration_stage->_construct_finalize($this);
+			}
+		}
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+	/**
+	 * Place to add hooks and filters for tweaking the migrations page, in order
+	 * to customize it
+	 */
+	public function migration_page_hooks()
+	{
+		// by default none are added because we normally like the default look of the migration page
+	}
+
+
+	/**
+	 * Sets the mapping from old table primary keys to new table primary keys.
+	 * This mapping is automatically persisted as a property on the migration
+	 *
+	 * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
+	 * @param int|string $old_pk    old primary key. Eg events_detail.id's value
+	 * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
+	 * @param array|int|string $new_pk    eg posts.ID
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_mapping($old_table, $old_pk, $new_table, $new_pk)
+	{
+		// make sure it has the needed keys
+		if (! isset($this->_mappings[ $old_table ]) || ! isset($this->_mappings[ $old_table ][ $new_table ])) {
+			$this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+		}
+		$this->_mappings[ $old_table ][ $new_table ][ $old_pk ] = $new_pk;
+	}
+
+
+	/**
+	 * Gets the new primary key, if provided with the OLD table and the primary key
+	 * of an item in the old table, and the new table
+	 *
+	 * @param string     $old_table with wpdb prefix (wp_). Eg: wp_events_detail
+	 * @param int|string $old_pk    old primary key. Eg events_detail.id's value
+	 * @param string     $new_table with wpdb prefix (wp_). Eg: wp_posts
+	 * @return mixed the primary key on the new table
+	 * @throws EE_Error
+	 */
+	public function get_mapping_new_pk($old_table, $old_pk, $new_table)
+	{
+		if (
+			! isset($this->_mappings[ $old_table ]) ||
+			! isset($this->_mappings[ $old_table ][ $new_table ])
+		) {
+			// try fetching the option
+			$this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+		}
+		return isset($this->_mappings[ $old_table ][ $new_table ][ $old_pk ])
+			? $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] : null;
+	}
+
+
+	/**
+	 * Gets the old primary key, if provided with the OLD table,
+	 * and the new table and the primary key of an item in the new table
+	 *
+	 * @param string $old_table with wpdb prefix (wp_). Eg: wp_events_detail
+	 * @param string $new_table with wpdb prefix (wp_). Eg: wp_posts
+	 * @param mixed  $new_pk
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function get_mapping_old_pk($old_table, $new_table, $new_pk)
+	{
+		if (
+			! isset($this->_mappings[ $old_table ]) ||
+			! isset($this->_mappings[ $old_table ][ $new_table ])
+		) {
+			// try fetching the option
+			$this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+		}
+		if (isset($this->_mappings[ $old_table ][ $new_table ])) {
+			$new_pk_to_old_pk = array_flip($this->_mappings[ $old_table ][ $new_table ]);
+			if (isset($new_pk_to_old_pk[ $new_pk ])) {
+				return $new_pk_to_old_pk[ $new_pk ];
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the mapping array option specified by the table names
+	 *
+	 * @param string $old_table_name
+	 * @param string $new_table_name
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_mapping_option($old_table_name, $new_table_name)
+	{
+		return get_option($this->_get_mapping_option_name($old_table_name, $new_table_name), array());
+	}
+
+
+	/**
+	 * Updates the mapping option specified by the table names with the array provided
+	 *
+	 * @param string $old_table_name
+	 * @param string $new_table_name
+	 * @param array  $mapping_array
+	 * @return boolean success of updating option
+	 * @throws EE_Error
+	 */
+	protected function _set_mapping_option($old_table_name, $new_table_name, $mapping_array)
+	{
+		$success = update_option($this->_get_mapping_option_name($old_table_name, $new_table_name), $mapping_array, false);
+		return $success;
+	}
+
+
+	/**
+	 * Gets the option name for this script to map from $old_table_name to $new_table_name
+	 *
+	 * @param string $old_table_name
+	 * @param string $new_table_name
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_mapping_option_name($old_table_name, $new_table_name)
+	{
+		global $wpdb;
+		$old_table_name_sans_wp = str_replace($wpdb->prefix, "", $old_table_name);
+		$new_table_name_sans_wp = str_replace($wpdb->prefix, "", $new_table_name);
+		$migrates_to = EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
+		return substr(
+			EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix . $migrates_to ['slug'] . '_' . $migrates_to['version'] . '_' . $old_table_name_sans_wp . '_' . $new_table_name_sans_wp,
+			0,
+			64
+		);
+	}
+
+
+	/**
+	 * Counts all the records that will be migrated during this data migration.
+	 * For example, if we were changing old user passwords from plaintext to encoded versions,
+	 * this would be a count of all users who have passwords. If we were going to also split
+	 * attendee records into transactions, registrations, and attendee records, this would include
+	 * the count of all attendees currently in existence in the DB (ie, users + attendees).
+	 * If you can't determine how many records there are to migrate, just provide a guess: this
+	 * number will only be used in calculating the percent complete. If you estimate there to be
+	 * 100 records to migrate, and it turns out there's 120, we'll just show the migration as being at
+	 * 99% until the function "migration_step" returns EE_Data_Migration_Script_Base::status_complete.
+	 *
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		$count = 0;
+		foreach ($this->stages() as $stage) {
+			$count += $stage->count_records_to_migrate();
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Returns the number of records updated so far. Usually this is easiest to do
+	 * by just setting a transient and updating it after each migration_step
+	 *
+	 * @return int
+	 */
+	public function count_records_migrated()
+	{
+		$count = 0;
+		foreach ($this->stages() as $stage) {
+			$count += $stage->count_records_migrated();
+		}
+		$this->_records_migrated = $count;
+		return $count;
+	}
+
+
+	/**
+	 * @param int $num_records_to_migrate_limit
+	 * @return int
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function migration_step($num_records_to_migrate_limit)
+	{
+		// reset the feedback message
+		$this->_feedback_message = '';
+		// if we haven't yet done the 1st schema changes, do them now. buffer any output
+		$this->_maybe_do_schema_changes(true);
+
+		$num_records_actually_migrated = 0;
+		$records_migrated_per_stage = array();
+		// setup the 'stage' variable, which should hold the last run stage of the migration  (or none at all if nothing runs)
+		$stage = null;
+		// get the next stage that isn't complete
+		foreach ($this->stages() as $stage) {
+			if ($stage->get_status() == EE_Data_Migration_Manager::status_continue) {
+				try {
+					$records_migrated_during_stage = $stage->migration_step(
+						$num_records_to_migrate_limit - $num_records_actually_migrated
+					);
+					$num_records_actually_migrated += $records_migrated_during_stage;
+					$records_migrated_per_stage[ $stage->pretty_name() ] = $records_migrated_during_stage;
+				} catch (Exception $e) {
+					// yes if we catch an exception here, we consider that migration stage borked.
+					$stage->set_status(EE_Data_Migration_Manager::status_fatal_error);
+					$this->set_status(EE_Data_Migration_Manager::status_fatal_error);
+					$stage->add_error($e->getMessage() . ". Stack-trace:" . $e->getTraceAsString());
+					throw $e;
+				}
+				// check that the migration stage didn't mark itself as having a fatal error
+				if ($stage->is_broken()) {
+					$this->set_broken();
+					throw new EE_Error($stage->get_last_error());
+				}
+			}
+			// once we've migrated all the number we intended to (possibly from different stages), stop migrating
+			// or if we had a fatal error
+			// or if the current script stopped early- its not done, but it's done all it thinks we should do on this step
+			if (
+				$num_records_actually_migrated >= $num_records_to_migrate_limit
+				|| $stage->is_broken()
+				|| $stage->has_more_to_do()
+			) {
+				break;
+			}
+		}
+		// check if we're all done this data migration...
+		// which is indicated by being done early AND the last stage claims to be done
+		if ($stage == null) {
+			// this migration script apparently has NO stages... which is super weird, but whatever
+			$this->set_completed();
+			$this->_maybe_do_schema_changes(false);
+		} elseif ($num_records_actually_migrated < $num_records_to_migrate_limit && ! $stage->has_more_to_do()) {
+			// apparently we're done, because we couldn't migrate the number we intended to
+			$this->set_completed();
+			$this->_update_feedback_message(array_reverse($records_migrated_per_stage));
+			// do schema changes for after the migration now
+			// first double-check we haven't already done this
+			$this->_maybe_do_schema_changes(false);
+		} else {
+			// update feedback message, keeping in mind that we show them with the most recent at the top
+			$this->_update_feedback_message(array_reverse($records_migrated_per_stage));
+		}
+		return $num_records_actually_migrated;
+	}
+
+
+	/**
+	 * Updates the feedback message according to what was done during this migration stage.
+	 *
+	 * @param array $records_migrated_per_stage KEYS are pretty names for each stage; values are the count of records
+	 *                                          migrated from that stage
+	 * @return void
+	 */
+	private function _update_feedback_message($records_migrated_per_stage)
+	{
+		$feedback_message_array = array();
+		foreach ($records_migrated_per_stage as $migration_stage_name => $num_records_migrated) {
+			$feedback_message_array[] = sprintf(
+				esc_html__("Migrated %d records successfully during %s", "event_espresso"),
+				$num_records_migrated,
+				$migration_stage_name
+			);
+		}
+		$this->_feedback_message .= implode("<br>", $feedback_message_array);
+	}
+
+
+	/**
+	 * Calls either schema_changes_before_migration() (if $before==true) or schema_changes_after_migration
+	 * (if $before==false). Buffers their outputs and stores them on the class.
+	 *
+	 * @param boolean $before
+	 * @throws Exception
+	 * @return void
+	 */
+	private function _maybe_do_schema_changes($before = true)
+	{
+		// so this property will be either _schema_changes_after_migration_ran or _schema_changes_before_migration_ran
+		$property_name = '_schema_changes_' . ($before ? 'before' : 'after') . '_migration_ran';
+		if (! $this->{$property_name}) {
+			try {
+				ob_start();
+				if ($before) {
+					$this->schema_changes_before_migration();
+				} else {
+					$this->schema_changes_after_migration();
+				}
+				$output = ob_get_contents();
+				ob_end_clean();
+			} catch (Exception $e) {
+				$this->set_status(EE_Data_Migration_Manager::status_fatal_error);
+				throw $e;
+			}
+			// record that we've done these schema changes
+			$this->{$property_name} = true;
+			// if there were any warnings etc, record them as non-fatal errors
+			if ($output) {
+				// there were some warnings
+				$this->_errors[] = $output;
+			}
+		}
+	}
+
+
+	/**
+	 * Wrapper for EEH_Activation::create_table. However, takes into account the request type when
+	 * deciding what to pass for its 4th arg, $drop_pre_existing_tables. Using this function, instead
+	 * of _table_should_exist_previously, indicates that this table should be new to the EE version being migrated to
+	 * or
+	 * activated currently. If this is a brand new activation or a migration, and we're indicating this table should
+	 * not
+	 * previously exist, then we want to set $drop_pre_existing_tables to TRUE (ie, we shouldn't discover that this
+	 * table exists in the DB in EEH_Activation::create_table- if it DOES exist, something's wrong and the old table
+	 * should be nuked.
+	 *
+	 * Just for a bit of context, the migration script's db_schema_changes_* methods
+	 * are called basically in 3 cases: on brand new activation of EE4 (ie no previous version of EE existed and the
+	 * plugin is being activated and we want to add all the brand new tables), upon reactivation of EE4 (it was
+	 * deactivated and then reactivated, in which case we want to just verify the DB structure is ok) that table should
+	 * be dropped), and during a migration when we're moving the DB to the state of the migration script
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _table_is_new_in_this_version(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=InnoDB'
+	) {
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(true)
+		);
+	}
+
+
+	/**
+	 * Like _table_is_new_in_this_version and _table_should_exist_previously, this function verifies the given table
+	 * exists. But we understand that this table has CHANGED in this version since the previous version. So it's not
+	 * completely new, but it's different. So we need to treat it like a new table in terms of verifying it's schema is
+	 * correct on activations, migrations, upgrades; but if it exists when it shouldn't, we need to be as lenient as
+	 * _table_should_exist_previously.
+	 * 8656]{Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the
+	 * table shouldn't exist).
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _table_is_changed_in_this_version(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=InnoDB'
+	) {
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(false)
+		);
+	}
+
+
+	/**
+	 * _old_table_exists
+	 * returns TRUE if the requested table exists in the current database
+	 *
+	 * @param string $table_name
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	protected function _old_table_exists($table_name)
+	{
+		return $this->_get_table_analysis()->tableExists($table_name);
+	}
+
+
+	/**
+	 * _delete_table_if_empty
+	 * returns TRUE if the requested table was empty and successfully empty
+	 *
+	 * @param string $table_name
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_table_if_empty($table_name)
+	{
+		return EEH_Activation::delete_db_table_if_empty($table_name);
+	}
+
+
+	/**
+	 * It is preferred to use _table_has_not_changed_since_previous or _table_is_changed_in_this_version
+	 * as these are significantly more efficient or explicit.
+	 * Please see description of _table_is_new_in_this_version. This function will only set
+	 * EEH_Activation::create_table's $drop_pre_existing_tables to TRUE if it's a brand
+	 * new activation. ie, a more accurate name for this method would be "_table_added_previously_by_this_plugin"
+	 * because the table will be cleared out if this is a new activation (ie, if its a new activation, it actually
+	 * should exist previously). Otherwise, we'll always set $drop_pre_existing_tables to FALSE because the table
+	 * should have existed. Note, if the table is being MODIFIED in this version being activated or migrated to, then
+	 * you want _table_is_changed_in_this_version NOT this one. We don't check this table's structure during migrations
+	 * because apparently it hasn't changed since the previous one, right?
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _table_should_exist_previously(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=InnoDB'
+	) {
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(false)
+		);
+	}
+
+
+	/**
+	 * Exactly the same as _table_should_exist_previously(), except if this migration script is currently doing
+	 * a migration, we skip checking this table's structure in the database and just assume it's correct.
+	 * So this is useful only to improve efficiency when doing migrations (not a big deal for single site installs,
+	 * but important for multisite where migrations can take a very long time otherwise).
+	 * If the table is known to have changed since previous version, use _table_is_changed_in_this_version().
+	 * Assumes only this plugin could have added this table (ie, if its a new activation of this plugin, the table
+	 * shouldn't exist).
+	 *
+	 * @param string $table_name
+	 * @param string $table_definition_sql
+	 * @param string $engine_string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _table_has_not_changed_since_previous(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=InnoDB'
+	) {
+		if ($this->_currently_migrating()) {
+			// if we're doing a migration, and this table apparently already exists, then we don't need do anything right?
+			return;
+		}
+		$this->_create_table_and_catch_errors(
+			$table_name,
+			$table_definition_sql,
+			$engine_string,
+			$this->_pre_existing_table_should_be_dropped(false)
+		);
+	}
+
+	/**
+	 * Returns whether this migration script is being used as part of an actual migration
+	 *
+	 * @return boolean
+	 */
+	protected function _currently_migrating()
+	{
+		// we want to know if we are currently performing a migration. We could just believe what was set on the _migrating property, but let's double-check (ie the script should apply and we should be in MM)
+		return $this->_migrating
+			&& DbStatus::isOffline()
+			&& $this->can_migrate_from_version(
+				EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set()
+			);
+	}
+
+
+	/**
+	 * Determines if a table should be dropped, based on whether it's reported to be new in $table_is_new,
+	 * and the plugin's request type.
+	 * Assumes only this plugin could have added the table (ie, if its a new activation of this plugin, the table
+	 * shouldn't exist no matter what).
+	 *
+	 * @param boolean $table_is_new
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	protected function _pre_existing_table_should_be_dropped($table_is_new)
+	{
+		if ($table_is_new) {
+			if (
+				$this->_get_req_type_for_plugin_corresponding_to_this_dms() == EE_System::req_type_new_activation
+				|| $this->_currently_migrating()
+			) {
+				return true;
+			} else {
+				return false;
+			}
+		} else {
+			if (
+				in_array(
+					$this->_get_req_type_for_plugin_corresponding_to_this_dms(),
+					array(EE_System::req_type_new_activation)
+				)
+			) {
+				return true;
+			} else {
+				return false;
+			}
+		}
+	}
+
+
+	/**
+	 * Just wraps EEH_Activation::create_table, but catches any errors it may throw and adds them as errors on the DMS
+	 *
+	 * @param string  $table_name
+	 * @param string  $table_definition_sql
+	 * @param string  $engine_string
+	 * @param boolean $drop_pre_existing_tables
+	 * @throws ReflectionException
+	 */
+	private function _create_table_and_catch_errors(
+		$table_name,
+		$table_definition_sql,
+		$engine_string = 'ENGINE=InnoDB',
+		$drop_pre_existing_tables = false
+	) {
+		try {
+			EEH_Activation::create_table($table_name, $table_definition_sql, $engine_string, $drop_pre_existing_tables);
+		} catch (EE_Error $e) {
+			$message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString();
+			$this->add_error($message);
+			$this->_feedback_message .= $message;
+		}
+	}
+
+
+	/**
+	 * Gets the request type for the plugin (core or addon) that corresponds to this DMS
+	 *
+	 * @return int one of EE_System::_req_type_* constants
+	 * @throws EE_Error
+	 */
+	private function _get_req_type_for_plugin_corresponding_to_this_dms()
+	{
+		if ($this->slug() == 'Core') {
+			return EE_System::instance()->detect_req_type();
+		} else {// it must be for an addon
+			$addon_name = $this->slug();
+			if (EE_Registry::instance()->get_addon_by_name($addon_name)) {
+				return EE_Registry::instance()->get_addon_by_name($addon_name)->detect_req_type();
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"The DMS slug '%s' should correspond to the addon's name, which should also be '%s', but no such addon was registered. These are the registered addons' names: %s",
+							"event_espresso"
+						),
+						$this->slug(),
+						$addon_name,
+						implode(",", array_keys(EE_Registry::instance()->get_addons_by_name()))
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * returns an array of strings describing errors by all the script's stages
+	 *
+	 * @return array
+	 */
+	public function get_errors()
+	{
+		$all_errors = $this->_errors;
+		if (! is_array($all_errors)) {
+			$all_errors = array();
+		}
+		foreach ($this->stages() as $stage) {
+			$all_errors = array_merge($stage->get_errors(), $all_errors);
+		}
+		return $all_errors;
+	}
+
+
+	/**
+	 * Indicates whether this migration script should continue
+	 *
+	 * @return boolean
+	 */
+	public function can_continue()
+	{
+		return in_array(
+			$this->get_status(),
+			EE_Data_Migration_Manager::instance()->stati_that_indicate_to_continue_single_migration_script
+		);
+	}
+
+
+	/**
+	 * Gets all the data migration stages associated with this script. Note:
+	 * addons can filter this list to add their own stages, and because the list is
+	 * numerically-indexed, they can insert their stage wherever they like and it will
+	 * get ordered by the indexes
+	 *
+	 * @return EE_Data_Migration_Script_Stage[]
+	 */
+	protected function stages()
+	{
+		$stages = apply_filters('FHEE__' . get_class($this) . '__stages', $this->_migration_stages);
+		ksort($stages);
+		return $stages;
+	}
+
+
+	/**
+	 * Gets a string which should describe what's going on currently with this migration, which
+	 * can be displayed to the user
+	 *
+	 * @return string
+	 */
+	public function get_feedback_message()
+	{
+		return $this->_feedback_message;
+	}
+
+
+	/**
+	 * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
+	 * properties to the DB. However, we don't want to use __sleep() because its quite
+	 * possible that this class is defined when it goes to sleep, but NOT available when it
+	 * awakes (eg, this class is part of an addon that is deactivated at some point).
+	 */
+	public function properties_as_array()
+	{
+		$properties = parent::properties_as_array();
+		$properties['_migration_stages'] = array();
+		foreach ($this->_migration_stages as $migration_stage_priority => $migration_stage_class) {
+			$properties['_migration_stages'][ $migration_stage_priority ] = $migration_stage_class->properties_as_array(
+			);
+		}
+		unset($properties['_mappings']);
+		unset($properties['previous_dms']);
+
+		foreach ($this->_mappings as $old_table_name => $mapping_to_new_table) {
+			foreach ($mapping_to_new_table as $new_table_name => $mapping) {
+				$this->_set_mapping_option($old_table_name, $new_table_name, $mapping);
+			}
+		}
+		return $properties;
+	}
+
+
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 * @return void
+	 */
+	public function instantiate_from_array_of_properties($array_of_properties)
+	{
+		$stages_properties_arrays = $array_of_properties['_migration_stages'];
+		unset($array_of_properties['_migration_stages']);
+		unset($array_of_properties['class']);
+		foreach ($array_of_properties as $property_name => $property_value) {
+			$this->{$property_name} = $property_value;
+		}
+		// _migration_stages are already instantiated, but have only default data
+		foreach ($this->_migration_stages as $stage) {
+			$stage_data = $this->_find_migration_stage_data_with_classname(
+				get_class($stage),
+				$stages_properties_arrays
+			);
+			// SO, if we found the stage data that was saved, use it. Otherwise, I guess the stage is new? (maybe added by
+			// an addon? Unlikely... not sure why it wouldn't exist, but if it doesn't just treat it like it was never started yet)
+			if ($stage_data) {
+				$stage->instantiate_from_array_of_properties($stage_data);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the migration data from the array $migration_stage_data_arrays (which is an array of arrays, each of which
+	 * is pretty well identical to EE_Data_Migration_Stage objects except all their properties are array indexes)
+	 * for the given classname
+	 *
+	 * @param string $classname
+	 * @param array  $migration_stage_data_arrays
+	 * @return null
+	 */
+	private function _find_migration_stage_data_with_classname($classname, $migration_stage_data_arrays)
+	{
+		foreach ($migration_stage_data_arrays as $migration_stage_data_array) {
+			if (isset($migration_stage_data_array['class']) && $migration_stage_data_array['class'] == $classname) {
+				return $migration_stage_data_array;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns the version that this script migrates to, based on the script's name.
+	 * Cannot be overwritten because lots of code needs to know which version a script
+	 * migrates to knowing only its name.
+	 *
+	 * @return array where the first key is the plugin's slug, the 2nd is the version of that plugin
+	 * that will be updated to. Eg array('Core','4.1.0')
+	 * @throws EE_Error
+	 */
+	final public function migrates_to_version()
+	{
+		return EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
+	}
+
+
+	/**
+	 * Gets this addon's slug as it would appear in the current_db_state wp option,
+	 * and if this migration script is for an addon, it SHOULD match the addon's slug
+	 * (and also the addon's classname, minus the 'EE_' prefix.). Eg, 'Calendar' for the EE_Calendar addon.
+	 * Or 'Core' for core (non-addon).
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function slug()
+	{
+		$migrates_to_version_info = $this->migrates_to_version();
+		// the slug is the first part of the array
+		return $migrates_to_version_info['slug'];
+	}
+
+
+	/**
+	 * Returns the script's priority relative to DMSs from other addons. However, when
+	 * two DMSs from the same addon/core apply, this is ignored (and instead the version that
+	 * the script migrates to is used to determine which to run first). The default is 5, but all core DMSs
+	 * normally have priority 10. (So if you want a DMS "A" to run before DMS "B", both of which are from addons,
+	 * and both of which CAN run at the same time (ie, "B" doesn't depend on "A" to set
+	 * the database up so it can run), then you can set "A" to priority 3 or something.
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->_priority;
+	}
+
+
+	/**
+	 * Sets whether this DMS is being ran as part of a migration, instead of
+	 * just being used to setup (or verify) the current database structure matches
+	 * what the latest DMS indicates it should be
+	 *
+	 * @param boolean $migrating
+	 * @return void
+	 */
+	public function set_migrating($migrating = true)
+	{
+		$this->_migrating = $migrating;
+	}
+
+	/**
+	 * Marks that we think this migration class can continue to migrate
+	 */
+	public function reattempt()
+	{
+		parent::reattempt();
+		// also, we want to reattempt any stages that were marked as borked
+		foreach ($this->stages() as $stage) {
+			if ($stage->is_broken()) {
+				$stage->reattempt();
+			}
+		}
+	}
 }

core/data_migration_scripts/EE_Data_Migration_Script_Stage_Table.core.php

Indentation +75 added lines, -75 removed lines

@@ -15,86 +15,86 @@
  */
 abstract class EE_Data_Migration_Script_Stage_Table extends EE_Data_Migration_Script_Stage
 {
-    /**
-     * @var string The columns to select. May be overridden for children.
-     */
-    protected string $select_expression = '*';
+	/**
+	 * @var string The columns to select. May be overridden for children.
+	 */
+	protected string $select_expression = '*';
 
-    /**
-     * Set in the constructor to add this sql to both the counting query in
-     * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and
-     * EE_Data_Migration_Script_Stage_Table::_get_rows().
-     * Eg "where column_name like '%some_value%'"
-     *
-     * @var string|null
-     */
-    protected ?string $_extra_where_sql;
+	/**
+	 * Set in the constructor to add this sql to both the counting query in
+	 * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and
+	 * EE_Data_Migration_Script_Stage_Table::_get_rows().
+	 * Eg "where column_name like '%some_value%'"
+	 *
+	 * @var string|null
+	 */
+	protected ?string $_extra_where_sql;
 
 
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
-     * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
-     * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
-     * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
-     * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
-     * very least we MUST report/return 50 items migrated)
-     *
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    public function _migration_step($num_items_to_migrate = 50)
-    {
-        $rows = $this->_get_rows($num_items_to_migrate);
-        $items_actually_migrated = 0;
-        foreach ($rows as $old_row) {
-            $this->_migrate_old_row($old_row);
-            $items_actually_migrated++;
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
+	 * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
+	 * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
+	 * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
+	 * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
+	 * very least we MUST report/return 50 items migrated)
+	 *
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	public function _migration_step($num_items_to_migrate = 50)
+	{
+		$rows = $this->_get_rows($num_items_to_migrate);
+		$items_actually_migrated = 0;
+		foreach ($rows as $old_row) {
+			$this->_migrate_old_row($old_row);
+			$items_actually_migrated++;
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 
-    /**
-     * Gets the rows for each migration stage from the old table
-     *
-     * @global wpdb $wpdb
-     * @param int   $limit
-     * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
-     */
-    protected function _get_rows($limit)
-    {
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
-            "LIMIT %d, %d",
-            $start_at_record,
-            $limit
-        );
-        return $wpdb->get_results($query, ARRAY_A);
-    }
+	/**
+	 * Gets the rows for each migration stage from the old table
+	 *
+	 * @global wpdb $wpdb
+	 * @param int   $limit
+	 * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
+	 */
+	protected function _get_rows($limit)
+	{
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
+			"LIMIT %d, %d",
+			$start_at_record,
+			$limit
+		);
+		return $wpdb->get_results($query, ARRAY_A);
+	}
 
 
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}";
-        return (int) $wpdb->get_var($query);
-    }
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}";
+		return (int) $wpdb->get_var($query);
+	}
 
-    /**
-     * takes care of migrating this particular row from the OLD table to whatever its
-     * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a
-     * fatal error which prevents all future migrations, throw an exception describing it
-     *
-     * @param array $old_row an associative array where keys are column names and values are their values.
-     * @return void
-     */
-    abstract protected function _migrate_old_row($old_row);
+	/**
+	 * takes care of migrating this particular row from the OLD table to whatever its
+	 * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a
+	 * fatal error which prevents all future migrations, throw an exception describing it
+	 *
+	 * @param array $old_row an associative array where keys are column names and values are their values.
+	 * @return void
+	 */
+	abstract protected function _migrate_old_row($old_row);
 }

core/data_migration_scripts/4_5_0_stages/EE_DMS_4_5_0_update_wp_user_for_price_types.dmsstage.php

Indentation +38 added lines, -38 removed lines

@@ -11,44 +11,44 @@
 class EE_DMS_4_5_0_update_wp_user_for_price_types extends EE_Data_Migration_Script_Stage_Table
 {
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__("Price Types", "event_espresso");
-        $this->_old_table   = $wpdb->prefix . "esp_price_type";
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__("Price Types", "event_espresso");
+		$this->_old_table   = $wpdb->prefix . "esp_price_type";
+		parent::__construct();
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        // foreach ticket row we add the id for the current logged in user.
-        global $wpdb;
-        $user_id = EEH_Activation::get_default_creator_id();
-        $user_id = $user_id ?: 0;
-        $updated = $wpdb->update(
-            $this->_old_table,
-            ['PRT_wp_user' => $user_id],
-            ['PRT_ID' => $old_row['PRT_ID']],
-            ['%d'], // PRT_wp_user
-            ['%d']  // PRT_ID
-        );
-        if (false === $updated) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        "Error in updating table %s setting PRT_wp_user = %d where PRT_ID = %d",
-                        'event_espresso'
-                    ),
-                    $this->_old_table,
-                    $user_id,
-                    $old_row['PRT_ID']
-                )
-            );
-        }
-    }
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		// foreach ticket row we add the id for the current logged in user.
+		global $wpdb;
+		$user_id = EEH_Activation::get_default_creator_id();
+		$user_id = $user_id ?: 0;
+		$updated = $wpdb->update(
+			$this->_old_table,
+			['PRT_wp_user' => $user_id],
+			['PRT_ID' => $old_row['PRT_ID']],
+			['%d'], // PRT_wp_user
+			['%d']  // PRT_ID
+		);
+		if (false === $updated) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						"Error in updating table %s setting PRT_wp_user = %d where PRT_ID = %d",
+						'event_espresso'
+					),
+					$this->_old_table,
+					$user_id,
+					$old_row['PRT_ID']
+				)
+			);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     {
         global $wpdb;
         $this->_pretty_name = esc_html__("Price Types", "event_espresso");
-        $this->_old_table   = $wpdb->prefix . "esp_price_type";
+        $this->_old_table   = $wpdb->prefix."esp_price_type";
         parent::__construct();
     }
 

core/data_migration_scripts/4_5_0_stages/EE_DMS_4_5_0_update_wp_user_for_prices.dmsstage.php

Indentation +38 added lines, -38 removed lines

@@ -11,44 +11,44 @@
 class EE_DMS_4_5_0_update_wp_user_for_prices extends EE_Data_Migration_Script_Stage_Table
 {
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__("Prices", "event_espresso");
-        $this->_old_table   = $wpdb->prefix . "esp_price";
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__("Prices", "event_espresso");
+		$this->_old_table   = $wpdb->prefix . "esp_price";
+		parent::__construct();
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        // foreach ticket row we add the id for the current logged in user.
-        global $wpdb;
-        $user_id = EEH_Activation::get_default_creator_id();
-        $user_id = $user_id ?: 0;
-        $updated = $wpdb->update(
-            $this->_old_table,
-            ['PRC_wp_user' => $user_id],
-            ['PRC_ID' => $old_row['PRC_ID']],
-            ['%d'],// PRC_wp_user
-            ['%d'] // PRC_ID
-        );
-        if (false === $updated) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        "Error in updating table %s setting PRC_wp_user = %d where PRC_ID = %d",
-                        'event_espresso'
-                    ),
-                    $this->_old_table,
-                    $user_id,
-                    $old_row['PRC_ID']
-                )
-            );
-        }
-    }
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		// foreach ticket row we add the id for the current logged in user.
+		global $wpdb;
+		$user_id = EEH_Activation::get_default_creator_id();
+		$user_id = $user_id ?: 0;
+		$updated = $wpdb->update(
+			$this->_old_table,
+			['PRC_wp_user' => $user_id],
+			['PRC_ID' => $old_row['PRC_ID']],
+			['%d'],// PRC_wp_user
+			['%d'] // PRC_ID
+		);
+		if (false === $updated) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						"Error in updating table %s setting PRC_wp_user = %d where PRC_ID = %d",
+						'event_espresso'
+					),
+					$this->_old_table,
+					$user_id,
+					$old_row['PRC_ID']
+				)
+			);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
     {
         global $wpdb;
         $this->_pretty_name = esc_html__("Prices", "event_espresso");
-        $this->_old_table   = $wpdb->prefix . "esp_price";
+        $this->_old_table   = $wpdb->prefix."esp_price";
         parent::__construct();
     }
 
@@ -34,7 +34,7 @@ 
             $this->_old_table,
             ['PRC_wp_user' => $user_id],
             ['PRC_ID' => $old_row['PRC_ID']],
-            ['%d'],// PRC_wp_user
+            ['%d'], // PRC_wp_user
             ['%d'] // PRC_ID
         );
         if (false === $updated) {

core/data_migration_scripts/4_5_0_stages/EE_DMS_4_5_0_update_wp_user_for_tickets.dmsstage.php

Indentation +42 added lines, -42 removed lines

@@ -10,48 +10,48 @@
  */
 class EE_DMS_4_5_0_update_wp_user_for_tickets extends EE_Data_Migration_Script_Stage_Table
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__("Tickets", "event_espresso");
-        $this->_old_table   = $wpdb->prefix . "esp_ticket";
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__("Tickets", "event_espresso");
+		$this->_old_table   = $wpdb->prefix . "esp_ticket";
+		parent::__construct();
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        // foreach ticket row we add the id for the current logged in user.
-        global $wpdb;
-        $user_id = EEH_Activation::get_default_creator_id();
-        $user_id = $user_id ?: 0;
-        $updated = $wpdb->update(
-            $this->_old_table,
-            ['TKT_wp_user' => $user_id],
-            ['TKT_ID' => $old_row['TKT_ID']],
-            [
-                '%d',// TKT_wp_user
-            ],
-            [
-                '%d',// TKT_ID
-            ]
-        );
-        if (false === $updated) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        "Error in updating table %s setting TKT_wp_user = %d where TKT_ID = %d",
-                        'event_espresso'
-                    ),
-                    $this->_old_table,
-                    $user_id,
-                    $old_row['TKT_ID']
-                )
-            );
-        }
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		// foreach ticket row we add the id for the current logged in user.
+		global $wpdb;
+		$user_id = EEH_Activation::get_default_creator_id();
+		$user_id = $user_id ?: 0;
+		$updated = $wpdb->update(
+			$this->_old_table,
+			['TKT_wp_user' => $user_id],
+			['TKT_ID' => $old_row['TKT_ID']],
+			[
+				'%d',// TKT_wp_user
+			],
+			[
+				'%d',// TKT_ID
+			]
+		);
+		if (false === $updated) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						"Error in updating table %s setting TKT_wp_user = %d where TKT_ID = %d",
+						'event_espresso'
+					),
+					$this->_old_table,
+					$user_id,
+					$old_row['TKT_ID']
+				)
+			);
+		}
+	}
 }