eventespresso / event-espresso-core

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_billing_info.dmsstage.php

Indentation +64 added lines, -64 removed lines

@@ -11,69 +11,69 @@
  */
 class EE_DMS_4_6_0_billing_info extends EE_Data_Migration_Script_Stage_Table
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->postmeta;
-        $this->_pretty_name = __('Billing Info', 'event_espresso');
-        $this->_extra_where_sql = "WHERE meta_key LIKE 'billing_info_%'";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        $new_billing_info = array();
-        $old_billing_info = maybe_unserialize($old_row['meta_value']);
-        $gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
-        $repetitive_prefix = '_reg-page-billing-';
-        $repetitive_suffix = "-" . $gateway_name;
-        foreach ($old_billing_info as $old_input_name => $input_value) {
-            $old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->postmeta;
+		$this->_pretty_name = __('Billing Info', 'event_espresso');
+		$this->_extra_where_sql = "WHERE meta_key LIKE 'billing_info_%'";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		$new_billing_info = array();
+		$old_billing_info = maybe_unserialize($old_row['meta_value']);
+		$gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
+		$repetitive_prefix = '_reg-page-billing-';
+		$repetitive_suffix = "-" . $gateway_name;
+		foreach ($old_billing_info as $old_input_name => $input_value) {
+			$old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
 
-            switch ($old_input_name_important_part) {
-                case 'fname':
-                    $new_input_name = 'first_name';
-                    break;
-                case 'lname':
-                    $new_input_name = 'last_name';
-                    break;
-                case 'state':
-                    // we used to store the state's id ,but now we just store the name
-                    $new_input_name = $old_input_name_important_part;
-                    $input_value = $this->_get_state_name_by_ID($input_value);
-                    break;
-                case 'card-nmbr':
-                    $new_input_name = 'credit_card';
-                    break;
-                case 'card-type':// paypal pro only
-                    $new_input_name = 'credit_card_type';
-                    break;
-                case 'card-exp-date-mnth':
-                    $new_input_name = 'exp_month';
-                    $input_value = '';
-                    break;
-                case 'card-exp-date-year':
-                    $new_input_name = 'exp_year';
-                    $input_value = 0;
-                    break;
-                case 'ccv-code':
-                    $new_input_name = 'cvv';
-                    break;
-                default:
-                    $new_input_name = $old_input_name_important_part;
-            }
-            $new_billing_info[ $new_input_name ] = $input_value;
-        }
-        update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
-    }
-    /**
-     *
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_state_name_by_ID($id)
-    {
-        global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
-    }
+			switch ($old_input_name_important_part) {
+				case 'fname':
+					$new_input_name = 'first_name';
+					break;
+				case 'lname':
+					$new_input_name = 'last_name';
+					break;
+				case 'state':
+					// we used to store the state's id ,but now we just store the name
+					$new_input_name = $old_input_name_important_part;
+					$input_value = $this->_get_state_name_by_ID($input_value);
+					break;
+				case 'card-nmbr':
+					$new_input_name = 'credit_card';
+					break;
+				case 'card-type':// paypal pro only
+					$new_input_name = 'credit_card_type';
+					break;
+				case 'card-exp-date-mnth':
+					$new_input_name = 'exp_month';
+					$input_value = '';
+					break;
+				case 'card-exp-date-year':
+					$new_input_name = 'exp_year';
+					$input_value = 0;
+					break;
+				case 'ccv-code':
+					$new_input_name = 'cvv';
+					break;
+				default:
+					$new_input_name = $old_input_name_important_part;
+			}
+			$new_billing_info[ $new_input_name ] = $input_value;
+		}
+		update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
+	}
+	/**
+	 *
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_state_name_by_ID($id)
+	{
+		global $wpdb;
+		return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -25,9 +25,9 @@ 
         $old_billing_info = maybe_unserialize($old_row['meta_value']);
         $gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
         $repetitive_prefix = '_reg-page-billing-';
-        $repetitive_suffix = "-" . $gateway_name;
+        $repetitive_suffix = "-".$gateway_name;
         foreach ($old_billing_info as $old_input_name => $input_value) {
-            $old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
+            $old_input_name_important_part = str_replace(array($repetitive_prefix, $repetitive_suffix), array('', ''), $old_input_name);
 
             switch ($old_input_name_important_part) {
                 case 'fname':
@@ -61,7 +61,7 @@ 
                 default:
                     $new_input_name = $old_input_name_important_part;
             }
-            $new_billing_info[ $new_input_name ] = $input_value;
+            $new_billing_info[$new_input_name] = $input_value;
         }
         update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
     }
@@ -74,6 +74,6 @@ 
     protected function _get_state_name_by_ID($id)
     {
         global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
+        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM ".$wpdb->prefix."esp_state WHERE STA_ID = %d", $id));
     }
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_question_types.dmsstage.php

Indentation +49 added lines, -49 removed lines

@@ -12,57 +12,57 @@
 class EE_DMS_4_6_0_question_types extends EE_Data_Migration_Script_Stage_Table
 {
 
-    protected $_question_type_conversions = array();
+	protected $_question_type_conversions = array();
 
 
 
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_6_0_question_types
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __('Question Types', 'event_espresso');
-        $this->_old_table = $wpdb->prefix.'esp_question';
-        $this->_question_type_conversions = array(
-            'MULTIPLE'          => 'CHECKBOX',
-            'SINGLE'                => 'RADIO_BTN'
-        );
-        // when fetching rows, because we automatically use a limit and offset
-        // rows counted before migrating any rows, need to ALSO be counted after a bunch of rows were counted
-        // so we need to include both the migrated rows as well as the non-migrated rows
-        $QST_types_to_count = array_merge(array_keys($this->_question_type_conversions), $this->_question_type_conversions);
-        $this->_extra_where_sql = "WHERE QST_type IN ('" . implode("', '", $QST_types_to_count) . "')" ;
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_6_0_question_types
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __('Question Types', 'event_espresso');
+		$this->_old_table = $wpdb->prefix.'esp_question';
+		$this->_question_type_conversions = array(
+			'MULTIPLE'          => 'CHECKBOX',
+			'SINGLE'                => 'RADIO_BTN'
+		);
+		// when fetching rows, because we automatically use a limit and offset
+		// rows counted before migrating any rows, need to ALSO be counted after a bunch of rows were counted
+		// so we need to include both the migrated rows as well as the non-migrated rows
+		$QST_types_to_count = array_merge(array_keys($this->_question_type_conversions), $this->_question_type_conversions);
+		$this->_extra_where_sql = "WHERE QST_type IN ('" . implode("', '", $QST_types_to_count) . "')" ;
+		parent::__construct();
+	}
 
-    /**
-     * @param array $question an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($question)
-    {
-        global $wpdb;
-        if ($question['QST_ID'] && isset($this->_question_type_conversions[ $question['QST_type'] ])) {
-            $success = $wpdb->update(
-                $this->_old_table,
-                array( 'QST_type' => $this->_question_type_conversions[ $question['QST_type'] ] ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
-            );
-            if (! $success) {
-                $this->add_error(
-                    sprintf(
-                        __('Could not update question type %1$s for question ID=%2$d because "%3$s"', 'event_espresso'),
-                        wp_json_encode($question['QST_type']),
-                        $question['QST_ID'],
-                        $wpdb->last_error
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * @param array $question an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($question)
+	{
+		global $wpdb;
+		if ($question['QST_ID'] && isset($this->_question_type_conversions[ $question['QST_type'] ])) {
+			$success = $wpdb->update(
+				$this->_old_table,
+				array( 'QST_type' => $this->_question_type_conversions[ $question['QST_type'] ] ),  // data
+				array( 'QST_ID' => $question['QST_ID'] ),  // where
+				array( '%s' ),   // data format
+				array( '%d' )  // where format
+			);
+			if (! $success) {
+				$this->add_error(
+					sprintf(
+						__('Could not update question type %1$s for question ID=%2$d because "%3$s"', 'event_espresso'),
+						wp_json_encode($question['QST_type']),
+						$question['QST_ID'],
+						$wpdb->last_error
+					)
+				);
+			}
+		}
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
         // rows counted before migrating any rows, need to ALSO be counted after a bunch of rows were counted
         // so we need to include both the migrated rows as well as the non-migrated rows
         $QST_types_to_count = array_merge(array_keys($this->_question_type_conversions), $this->_question_type_conversions);
-        $this->_extra_where_sql = "WHERE QST_type IN ('" . implode("', '", $QST_types_to_count) . "')" ;
+        $this->_extra_where_sql = "WHERE QST_type IN ('".implode("', '", $QST_types_to_count)."')";
         parent::__construct();
     }
 
@@ -45,15 +45,15 @@ 
     protected function _migrate_old_row($question)
     {
         global $wpdb;
-        if ($question['QST_ID'] && isset($this->_question_type_conversions[ $question['QST_type'] ])) {
+        if ($question['QST_ID'] && isset($this->_question_type_conversions[$question['QST_type']])) {
             $success = $wpdb->update(
                 $this->_old_table,
-                array( 'QST_type' => $this->_question_type_conversions[ $question['QST_type'] ] ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
+                array('QST_type' => $this->_question_type_conversions[$question['QST_type']]), // data
+                array('QST_ID' => $question['QST_ID']), // where
+                array('%s'), // data format
+                array('%d')  // where format
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error(
                     sprintf(
                         __('Could not update question type %1$s for question ID=%2$d because "%3$s"', 'event_espresso'),

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_gateways.dmsstage.php

Indentation +256 added lines, -256 removed lines

@@ -14,277 +14,277 @@
 class EE_DMS_4_6_0_gateways extends EE_Data_Migration_Script_Stage
 {
 
-    protected $_new_table_name;
-    protected $_extra_meta_table_name;
-    protected $_currency_table_name;
-    protected $_currency_payment_method_table_name;
+	protected $_new_table_name;
+	protected $_extra_meta_table_name;
+	protected $_currency_table_name;
+	protected $_currency_payment_method_table_name;
 
-    /**
-     * each key is the name of a 4.1-style gateway we know how to migrate to 4.6
-     * @var array
-     */
-    protected $_gateway_we_know_to_migrate = array(
-        'Aim',
-        'Bank',
-        'Check',
-        'Invoice',
-        'Mijireh',
-        'Paypal_Pro',
-        'Paypal_Standard',
-    );
+	/**
+	 * each key is the name of a 4.1-style gateway we know how to migrate to 4.6
+	 * @var array
+	 */
+	protected $_gateway_we_know_to_migrate = array(
+		'Aim',
+		'Bank',
+		'Check',
+		'Invoice',
+		'Mijireh',
+		'Paypal_Pro',
+		'Paypal_Standard',
+	);
 
 
 
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_new_table_name = $wpdb->prefix."esp_payment_method";
-        $this->_extra_meta_table_name = $wpdb->prefix."esp_extra_meta";
-        $this->_currency_table_name = $wpdb->prefix."esp_currency";
-        $this->_currency_payment_method_table_name = $wpdb->prefix."esp_currency_payment_method";
-        $this->_pretty_name = __('Gateways', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_new_table_name = $wpdb->prefix."esp_payment_method";
+		$this->_extra_meta_table_name = $wpdb->prefix."esp_extra_meta";
+		$this->_currency_table_name = $wpdb->prefix."esp_currency";
+		$this->_currency_payment_method_table_name = $wpdb->prefix."esp_currency_payment_method";
+		$this->_pretty_name = __('Gateways', 'event_espresso');
+		parent::__construct();
+	}
 
 
 
-    /**
-     * Counts the records to migrate; the public version may cache it
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return count(EE_Config::instance()->gateway->payment_settings);
-    }
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return count(EE_Config::instance()->gateway->payment_settings);
+	}
 
 
 
-    /**
-     * 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
-     */
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        $items_actually_migrated = 0;
-        $gateways_to_deal_with = array_slice(EE_Config::instance()->gateway->payment_settings, $this->count_records_migrated(), $num_items_to_migrate);
-        foreach ($gateways_to_deal_with as $old_gateway_slug => $old_gateway_settings) {
-            if (in_array($old_gateway_slug, $this->_gateway_we_know_to_migrate)) {
-                if (! $old_gateway_settings) {
-                    // no settings existed for this gateway anyways... weird...
-                    $items_actually_migrated++;
-                    continue;
-                }
-                // now prepare the settings to make sure they're in the 4.1 format
-                $success = $this->_convert_gateway_settings(
-                    $old_gateway_slug,
-                    $old_gateway_settings,
-                    isset(EE_Config::instance()->gateway->active_gateways[ $old_gateway_slug ])
-                );
-                if ($success) {
-                    EE_Config::instance()->gateway->payment_settings[ $old_gateway_slug ] = 'Deprecated';
-                }
-            }
-            $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
+	 */
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		$items_actually_migrated = 0;
+		$gateways_to_deal_with = array_slice(EE_Config::instance()->gateway->payment_settings, $this->count_records_migrated(), $num_items_to_migrate);
+		foreach ($gateways_to_deal_with as $old_gateway_slug => $old_gateway_settings) {
+			if (in_array($old_gateway_slug, $this->_gateway_we_know_to_migrate)) {
+				if (! $old_gateway_settings) {
+					// no settings existed for this gateway anyways... weird...
+					$items_actually_migrated++;
+					continue;
+				}
+				// now prepare the settings to make sure they're in the 4.1 format
+				$success = $this->_convert_gateway_settings(
+					$old_gateway_slug,
+					$old_gateway_settings,
+					isset(EE_Config::instance()->gateway->active_gateways[ $old_gateway_slug ])
+				);
+				if ($success) {
+					EE_Config::instance()->gateway->payment_settings[ $old_gateway_slug ] = 'Deprecated';
+				}
+			}
+			$items_actually_migrated++;
+		}
 
-        EE_Config::instance()->update_espresso_config(false, false);
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+		EE_Config::instance()->update_espresso_config(false, false);
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 
-    /**
-     * Converts the 4.1-style gateway to a 4.6-style payment method and saves it to the DB
-     * @param string $old_gateway_slug
-     * @param array $old_gateway_settings
-     * @param boolean $active indicates the gateway is currently active
-     * @return boolean success
-     */
-    protected function _convert_gateway_settings($old_gateway_slug, $old_gateway_settings, $active)
-    {
-        switch ($old_gateway_slug) {
-            case 'Aim':
-                $extra_meta_key_values = array(
-                    'login_id'=>$old_gateway_settings['authnet_aim_login_id'],
-                    'transaction_key'=>$old_gateway_settings['authnet_aim_transaction_key'],
-                    'test_transactions'=>$old_gateway_settings['test_transactions']
-                );
-                $desc = __('Please provide the following billing information.', 'event_espresso');
-                break;
-            case 'Bank':
-                $extra_meta_key_values = array(
-                    'page_title'=>$old_gateway_settings['page_title'],
-                    'payment_instructions'=>
-                    sprintf(__('%1$s<br/>Name on Bank Account: %2$s<br/>Bank Account Number: %3$s<br/>Bank Name: %4$s<br/>Bank Address:%5$s', 'event_espresso'), $old_gateway_settings['bank_instructions'], $old_gateway_settings['account_name'], $old_gateway_settings['account_number'], $old_gateway_settings['bank_name'], $old_gateway_settings['bank_address']) );
-                $desc = __('Make payment using an electronic funds transfer from your bank.', 'event_espresso');
-                break;
-            case 'Check':
-                $extra_meta_key_values = array(
-                    'check_title'=> $old_gateway_settings['check_title'],
-                    'payment_instructions'=>$old_gateway_settings['check_instructions'],
-                    'address_to_send_payment'=>$old_gateway_settings['payment_address']
-                );
-                $desc = __('On the next page you will be given instructions on how to make a payment by check.', 'event_espresso');
-                break;
-            case 'Invoice':
-                $extra_meta_key_values = array(
-                    'pdf_payee_name' => $old_gateway_settings['template_invoice_payee_name'],
-                    'pdf_payee_email' => $old_gateway_settings['template_invoice_email'],
-                    'pdf_payee_tax_number' => $old_gateway_settings['template_invoice_tax_number'],
-                    'pdf_payee_address' => $old_gateway_settings['template_invoice_address'],
-                    'pdf_instructions' => $old_gateway_settings['template_payment_instructions'],
-                    'pdf_logo_image' => $old_gateway_settings['invoice_logo_url'],
-                    'page_confirmation_text' => isset($old_gateway_settings['page_instructions']) ? $old_gateway_settings['page_instructions'] : '',
-                    'page_extra_info' => isset($old_gateway_settings['payment_address']) ? $old_gateway_settings['payment_address'] : '',
-                    'legacy_invoice_css' => $old_gateway_settings['invoice_css']
-                );
-                // if they didnt want the invoiec gateway to show, pretend it was inactive
-                if (! $old_gateway_settings['show']) {
-                    $active = false;
-                }
-                $desc = __('On the next page you will be able to access your invoice and instructions on how to pay it.', 'event_espresso');
-                break;
-            case 'Mijireh':
-                $extra_meta_key_values = array(
-                    'access_key' => $old_gateway_settings['access_key']
-                );
-                $desc =  __('On the next page you will be able to enter your billing information to make the payment.', 'event_espresso');
-                break;
-            case 'Paypal_Pro':
-                $extra_meta_key_values = array(
-                    'username'=>$old_gateway_settings['username'],
-                    'password'=>$old_gateway_settings['password'],
-                    'signature'=>$old_gateway_settings['signature'],
-                    'credit_card_types'=>$old_gateway_settings['credit_cards'],
-                );
-                $desc = __('Please provide the following billing information.', 'event_espresso');
-                break;
-            case 'Paypal_Standard':
-                $extra_meta_key_values = array(
-                    'paypal_id' => $old_gateway_settings['paypal_id'],
-                    'image_url' => $old_gateway_settings['image_url'],
-                    'shipping_details' => isset($old_gateway_settings['no_shipping']) ? $old_gateway_settings['no_shipping'] : false,
+	/**
+	 * Converts the 4.1-style gateway to a 4.6-style payment method and saves it to the DB
+	 * @param string $old_gateway_slug
+	 * @param array $old_gateway_settings
+	 * @param boolean $active indicates the gateway is currently active
+	 * @return boolean success
+	 */
+	protected function _convert_gateway_settings($old_gateway_slug, $old_gateway_settings, $active)
+	{
+		switch ($old_gateway_slug) {
+			case 'Aim':
+				$extra_meta_key_values = array(
+					'login_id'=>$old_gateway_settings['authnet_aim_login_id'],
+					'transaction_key'=>$old_gateway_settings['authnet_aim_transaction_key'],
+					'test_transactions'=>$old_gateway_settings['test_transactions']
+				);
+				$desc = __('Please provide the following billing information.', 'event_espresso');
+				break;
+			case 'Bank':
+				$extra_meta_key_values = array(
+					'page_title'=>$old_gateway_settings['page_title'],
+					'payment_instructions'=>
+					sprintf(__('%1$s<br/>Name on Bank Account: %2$s<br/>Bank Account Number: %3$s<br/>Bank Name: %4$s<br/>Bank Address:%5$s', 'event_espresso'), $old_gateway_settings['bank_instructions'], $old_gateway_settings['account_name'], $old_gateway_settings['account_number'], $old_gateway_settings['bank_name'], $old_gateway_settings['bank_address']) );
+				$desc = __('Make payment using an electronic funds transfer from your bank.', 'event_espresso');
+				break;
+			case 'Check':
+				$extra_meta_key_values = array(
+					'check_title'=> $old_gateway_settings['check_title'],
+					'payment_instructions'=>$old_gateway_settings['check_instructions'],
+					'address_to_send_payment'=>$old_gateway_settings['payment_address']
+				);
+				$desc = __('On the next page you will be given instructions on how to make a payment by check.', 'event_espresso');
+				break;
+			case 'Invoice':
+				$extra_meta_key_values = array(
+					'pdf_payee_name' => $old_gateway_settings['template_invoice_payee_name'],
+					'pdf_payee_email' => $old_gateway_settings['template_invoice_email'],
+					'pdf_payee_tax_number' => $old_gateway_settings['template_invoice_tax_number'],
+					'pdf_payee_address' => $old_gateway_settings['template_invoice_address'],
+					'pdf_instructions' => $old_gateway_settings['template_payment_instructions'],
+					'pdf_logo_image' => $old_gateway_settings['invoice_logo_url'],
+					'page_confirmation_text' => isset($old_gateway_settings['page_instructions']) ? $old_gateway_settings['page_instructions'] : '',
+					'page_extra_info' => isset($old_gateway_settings['payment_address']) ? $old_gateway_settings['payment_address'] : '',
+					'legacy_invoice_css' => $old_gateway_settings['invoice_css']
+				);
+				// if they didnt want the invoiec gateway to show, pretend it was inactive
+				if (! $old_gateway_settings['show']) {
+					$active = false;
+				}
+				$desc = __('On the next page you will be able to access your invoice and instructions on how to pay it.', 'event_espresso');
+				break;
+			case 'Mijireh':
+				$extra_meta_key_values = array(
+					'access_key' => $old_gateway_settings['access_key']
+				);
+				$desc =  __('On the next page you will be able to enter your billing information to make the payment.', 'event_espresso');
+				break;
+			case 'Paypal_Pro':
+				$extra_meta_key_values = array(
+					'username'=>$old_gateway_settings['username'],
+					'password'=>$old_gateway_settings['password'],
+					'signature'=>$old_gateway_settings['signature'],
+					'credit_card_types'=>$old_gateway_settings['credit_cards'],
+				);
+				$desc = __('Please provide the following billing information.', 'event_espresso');
+				break;
+			case 'Paypal_Standard':
+				$extra_meta_key_values = array(
+					'paypal_id' => $old_gateway_settings['paypal_id'],
+					'image_url' => $old_gateway_settings['image_url'],
+					'shipping_details' => isset($old_gateway_settings['no_shipping']) ? $old_gateway_settings['no_shipping'] : false,
 
-                );
-                $desc = sprintf(__('After clicking \'Finalize Registration\', you will be forwarded to PayPal to make your payment. Make sure you return to this site in order to properly finalize your registration.', 'event_espresso'), '<strong>', '</strong>');
-                break;
-            default:
-                // if we don't recognize the payment method, just put everything in it into extra meta. At least this way its preserved somewhere
-                $extra_meta_key_values = $old_gateway_settings;
-                $desc = '';
-        }
-        $pretty_name = isset($old_gateway_settings['display_name']) ? $old_gateway_settings['display_name'] : $old_gateway_slug;
-        $offline_gateways = array( 'Bank', 'Check', 'Invoice' );
-        if ($active && in_array($old_gateway_slug, $offline_gateways)) {
-            $scope = array( 'CART', 'ADMIN');
-        } elseif ($active && ! in_array($old_gateway_slug, $offline_gateways)) {
-            $scope = array( 'CART' );
-        } elseif (! $active && in_array($old_gateway_slug, $offline_gateways)) {
-            $scope = array( 'ADMIN' );
-        } else {
-            $scope = array();
-        }
-        $payment_method_col_values = array(
-            'PMD_type' => $old_gateway_slug,
-            'PMD_name' => $pretty_name,
-            'PMD_desc' => $desc,
-            'PMD_admin_name' => $pretty_name,
-            'PMD_slug' => sanitize_key($old_gateway_slug),
-            'PMD_debug_mode' => isset($old_gateway_settings['use_sandbox']) ? $old_gateway_settings['use_sandbox'] : false,
-            'PMD_button_url' => isset($old_gateway_settings['button_url']) ? $old_gateway_settings['button_url'] : null,
-            'PMD_scope' =>  serialize($scope)
-        );
-        $db_types = array(
-            '%s',// PMD_type
-            '%s',// PMD_name
-            '%s',// PMD_desc
-            '%s',// PMD_admin_name
-            '%s',// PMD_slug
-            '%d',// PMD_debug_mode
-            '%s',// PMD_button_url
-            '%s',// PMD_scope
-        );
-        global $wpdb;
-        // first: check if it already exists
-        $id = $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM {$this->_new_table_name} WHERE PMD_slug=%s", $payment_method_col_values['PMD_slug']));
-        if ($id) {
-            // just update that payment method instead of creating a new one
-            $success = $wpdb->update(
-                $this->_new_table_name,
-                $payment_method_col_values,
-                array(
-                        'PMD_ID'=>$id
-                    ),
-                $db_types,
-                array(
-                        '%d',// PMD_ID
-                    )
-            );
-            if (! $success) {
-                $this->add_error(sprintf(__('Could not update payment method %d with properties %s because %s', "event_espresso"), $id, wp_json_encode($payment_method_col_values), $wpdb->last_error));
-            }
-        } else {
-            $success = $wpdb->insert(
-                $this->_new_table_name,
-                $payment_method_col_values,
-                $db_types
-            );
-            if (! $success) {
-                $this->add_error($wpdb->last_error);
-                return false;
-            } else {
-                $id = $wpdb->insert_id;
-            }
-        }
+				);
+				$desc = sprintf(__('After clicking \'Finalize Registration\', you will be forwarded to PayPal to make your payment. Make sure you return to this site in order to properly finalize your registration.', 'event_espresso'), '<strong>', '</strong>');
+				break;
+			default:
+				// if we don't recognize the payment method, just put everything in it into extra meta. At least this way its preserved somewhere
+				$extra_meta_key_values = $old_gateway_settings;
+				$desc = '';
+		}
+		$pretty_name = isset($old_gateway_settings['display_name']) ? $old_gateway_settings['display_name'] : $old_gateway_slug;
+		$offline_gateways = array( 'Bank', 'Check', 'Invoice' );
+		if ($active && in_array($old_gateway_slug, $offline_gateways)) {
+			$scope = array( 'CART', 'ADMIN');
+		} elseif ($active && ! in_array($old_gateway_slug, $offline_gateways)) {
+			$scope = array( 'CART' );
+		} elseif (! $active && in_array($old_gateway_slug, $offline_gateways)) {
+			$scope = array( 'ADMIN' );
+		} else {
+			$scope = array();
+		}
+		$payment_method_col_values = array(
+			'PMD_type' => $old_gateway_slug,
+			'PMD_name' => $pretty_name,
+			'PMD_desc' => $desc,
+			'PMD_admin_name' => $pretty_name,
+			'PMD_slug' => sanitize_key($old_gateway_slug),
+			'PMD_debug_mode' => isset($old_gateway_settings['use_sandbox']) ? $old_gateway_settings['use_sandbox'] : false,
+			'PMD_button_url' => isset($old_gateway_settings['button_url']) ? $old_gateway_settings['button_url'] : null,
+			'PMD_scope' =>  serialize($scope)
+		);
+		$db_types = array(
+			'%s',// PMD_type
+			'%s',// PMD_name
+			'%s',// PMD_desc
+			'%s',// PMD_admin_name
+			'%s',// PMD_slug
+			'%d',// PMD_debug_mode
+			'%s',// PMD_button_url
+			'%s',// PMD_scope
+		);
+		global $wpdb;
+		// first: check if it already exists
+		$id = $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM {$this->_new_table_name} WHERE PMD_slug=%s", $payment_method_col_values['PMD_slug']));
+		if ($id) {
+			// just update that payment method instead of creating a new one
+			$success = $wpdb->update(
+				$this->_new_table_name,
+				$payment_method_col_values,
+				array(
+						'PMD_ID'=>$id
+					),
+				$db_types,
+				array(
+						'%d',// PMD_ID
+					)
+			);
+			if (! $success) {
+				$this->add_error(sprintf(__('Could not update payment method %d with properties %s because %s', "event_espresso"), $id, wp_json_encode($payment_method_col_values), $wpdb->last_error));
+			}
+		} else {
+			$success = $wpdb->insert(
+				$this->_new_table_name,
+				$payment_method_col_values,
+				$db_types
+			);
+			if (! $success) {
+				$this->add_error($wpdb->last_error);
+				return false;
+			} else {
+				$id = $wpdb->insert_id;
+			}
+		}
 
-        if ($id) {
-            $this->_convert_extra_meta_values($id, $extra_meta_key_values);
-            $this->get_migration_script()->set_mapping('EE_Gateway_Config', $old_gateway_slug, $this->_new_table_name, $id);
-            return true;
-        }
-        return false;
-    }
+		if ($id) {
+			$this->_convert_extra_meta_values($id, $extra_meta_key_values);
+			$this->get_migration_script()->set_mapping('EE_Gateway_Config', $old_gateway_slug, $this->_new_table_name, $id);
+			return true;
+		}
+		return false;
+	}
 
 
 
-    /**
-     * Converts old gateway settings which don't map onto the Payment_Method model
-     * to extra meta fields
-     * @param int $id
-     * @param array $extra_meta_key_values
-     */
-    private function _convert_extra_meta_values($id, $extra_meta_key_values)
-    {
-        global $wpdb;
-        foreach ($extra_meta_key_values as $key => $value) {
-            $exm_args = array(
-                'OBJ_ID'=>$id,
-                'EXM_type'=>'Payment_Method',
-                'EXM_key'=>$key,
-                'EXM_value'=> maybe_serialize($value)
-            );
-            $success = $wpdb->insert(
-                $this->_extra_meta_table_name,
-                $exm_args,
-                array(
-                        '%d',// OBJ_ID
-                        '%s',// EXM_type
-                        '%s',// EXM_key
-                        '%s',// EXM_value
-                    )
-            );
-            if (! $success) {
-                $this->add_error(sprintf(__('Could not insert extra meta key with values %s. %s', "event_espresso"), wp_json_encode($exm_args), $wpdb->last_error));
-            }
-        }
-    }
+	/**
+	 * Converts old gateway settings which don't map onto the Payment_Method model
+	 * to extra meta fields
+	 * @param int $id
+	 * @param array $extra_meta_key_values
+	 */
+	private function _convert_extra_meta_values($id, $extra_meta_key_values)
+	{
+		global $wpdb;
+		foreach ($extra_meta_key_values as $key => $value) {
+			$exm_args = array(
+				'OBJ_ID'=>$id,
+				'EXM_type'=>'Payment_Method',
+				'EXM_key'=>$key,
+				'EXM_value'=> maybe_serialize($value)
+			);
+			$success = $wpdb->insert(
+				$this->_extra_meta_table_name,
+				$exm_args,
+				array(
+						'%d',// OBJ_ID
+						'%s',// EXM_type
+						'%s',// EXM_key
+						'%s',// EXM_value
+					)
+			);
+			if (! $success) {
+				$this->add_error(sprintf(__('Could not insert extra meta key with values %s. %s', "event_espresso"), wp_json_encode($exm_args), $wpdb->last_error));
+			}
+		}
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -77,7 +77,7 @@ 
         $gateways_to_deal_with = array_slice(EE_Config::instance()->gateway->payment_settings, $this->count_records_migrated(), $num_items_to_migrate);
         foreach ($gateways_to_deal_with as $old_gateway_slug => $old_gateway_settings) {
             if (in_array($old_gateway_slug, $this->_gateway_we_know_to_migrate)) {
-                if (! $old_gateway_settings) {
+                if ( ! $old_gateway_settings) {
                     // no settings existed for this gateway anyways... weird...
                     $items_actually_migrated++;
                     continue;
@@ -86,10 +86,10 @@ 
                 $success = $this->_convert_gateway_settings(
                     $old_gateway_slug,
                     $old_gateway_settings,
-                    isset(EE_Config::instance()->gateway->active_gateways[ $old_gateway_slug ])
+                    isset(EE_Config::instance()->gateway->active_gateways[$old_gateway_slug])
                 );
                 if ($success) {
-                    EE_Config::instance()->gateway->payment_settings[ $old_gateway_slug ] = 'Deprecated';
+                    EE_Config::instance()->gateway->payment_settings[$old_gateway_slug] = 'Deprecated';
                 }
             }
             $items_actually_migrated++;
@@ -148,7 +148,7 @@ 
                     'legacy_invoice_css' => $old_gateway_settings['invoice_css']
                 );
                 // if they didnt want the invoiec gateway to show, pretend it was inactive
-                if (! $old_gateway_settings['show']) {
+                if ( ! $old_gateway_settings['show']) {
                     $active = false;
                 }
                 $desc = __('On the next page you will be able to access your invoice and instructions on how to pay it.', 'event_espresso');
@@ -157,7 +157,7 @@ 
                 $extra_meta_key_values = array(
                     'access_key' => $old_gateway_settings['access_key']
                 );
-                $desc =  __('On the next page you will be able to enter your billing information to make the payment.', 'event_espresso');
+                $desc = __('On the next page you will be able to enter your billing information to make the payment.', 'event_espresso');
                 break;
             case 'Paypal_Pro':
                 $extra_meta_key_values = array(
@@ -183,13 +183,13 @@ 
                 $desc = '';
         }
         $pretty_name = isset($old_gateway_settings['display_name']) ? $old_gateway_settings['display_name'] : $old_gateway_slug;
-        $offline_gateways = array( 'Bank', 'Check', 'Invoice' );
+        $offline_gateways = array('Bank', 'Check', 'Invoice');
         if ($active && in_array($old_gateway_slug, $offline_gateways)) {
-            $scope = array( 'CART', 'ADMIN');
+            $scope = array('CART', 'ADMIN');
         } elseif ($active && ! in_array($old_gateway_slug, $offline_gateways)) {
-            $scope = array( 'CART' );
-        } elseif (! $active && in_array($old_gateway_slug, $offline_gateways)) {
-            $scope = array( 'ADMIN' );
+            $scope = array('CART');
+        } elseif ( ! $active && in_array($old_gateway_slug, $offline_gateways)) {
+            $scope = array('ADMIN');
         } else {
             $scope = array();
         }
@@ -204,14 +204,14 @@ 
             'PMD_scope' =>  serialize($scope)
         );
         $db_types = array(
-            '%s',// PMD_type
-            '%s',// PMD_name
-            '%s',// PMD_desc
-            '%s',// PMD_admin_name
-            '%s',// PMD_slug
-            '%d',// PMD_debug_mode
-            '%s',// PMD_button_url
-            '%s',// PMD_scope
+            '%s', // PMD_type
+            '%s', // PMD_name
+            '%s', // PMD_desc
+            '%s', // PMD_admin_name
+            '%s', // PMD_slug
+            '%d', // PMD_debug_mode
+            '%s', // PMD_button_url
+            '%s', // PMD_scope
         );
         global $wpdb;
         // first: check if it already exists
@@ -226,10 +226,10 @@ 
                     ),
                 $db_types,
                 array(
-                        '%d',// PMD_ID
+                        '%d', // PMD_ID
                     )
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error(sprintf(__('Could not update payment method %d with properties %s because %s', "event_espresso"), $id, wp_json_encode($payment_method_col_values), $wpdb->last_error));
             }
         } else {
@@ -238,7 +238,7 @@ 
                 $payment_method_col_values,
                 $db_types
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($wpdb->last_error);
                 return false;
             } else {
@@ -276,13 +276,13 @@ 
                 $this->_extra_meta_table_name,
                 $exm_args,
                 array(
-                        '%d',// OBJ_ID
-                        '%s',// EXM_type
-                        '%s',// EXM_key
-                        '%s',// EXM_value
+                        '%d', // OBJ_ID
+                        '%s', // EXM_type
+                        '%s', // EXM_key
+                        '%s', // EXM_value
                     )
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error(sprintf(__('Could not insert extra meta key with values %s. %s', "event_espresso"), wp_json_encode($exm_args), $wpdb->last_error));
             }
         }

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

Indentation +221 added lines, -221 removed lines

@@ -12,225 +12,225 @@
 class EE_DMS_4_7_0_Registration_Payments extends EE_Data_Migration_Script_Stage_Table
 {
 
-    protected $_payment_table;
-
-    protected $_registration_table;
-
-    protected $_registration_payment_table;
-
-    public function __construct()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $this->_pretty_name = __('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 $transaction
-     * @return void
-     */
-    protected function _migrate_old_row($transaction)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $TXN_ID = absint($transaction['TXN_ID']);
-        if (! $TXN_ID) {
-            $this->add_error(
-                sprintf(
-                    __('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 $PAY_ID => $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($TXN_ID)
-    {
-        /** @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($TXN_ID)
-    {
-        /** @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 array
-     */
-    protected function _get_possibly_updated_REG_paid($REG_ID)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $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 bool
-     */
-    protected function _process_registration_payments($payment, $registrations = array())
-    {
-        // 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
-            $possibly_updated_REG_paid = $this->_get_possibly_updated_REG_paid($REG_ID);
-            if (is_float($possibly_updated_REG_paid)) {
-                $registration->REG_paid = $possibly_updated_REG_paid;
-            }
-            // and ensure REG_paid has a valid value
-            $registration->REG_paid = ! empty($registration->REG_paid) ? (float) $registration->REG_paid : 0.00;
-            // 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, $payment_amount)) {
-                // calculate and set new REG_paid
-                $registration->REG_paid = $registration->REG_paid + $payment_amount;
-                $this->_update_registration_paid($registration->REG_ID, $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($REG_ID = 0, $PAY_ID = 0, $PAY_amount = 0.00)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $success = $wpdb->insert(
-            $this->_registration_payment_table,
-            array( 'REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount, ),  // data
-            array( '%f' )   // data format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    __('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($REG_ID = 0, $REG_paid = 0.00)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $success = $wpdb->update(
-            $this->_registration_table,
-            array( 'REG_paid' => $REG_paid ),  // data
-            array( 'REG_ID' => $REG_ID ),  // where
-            array( '%f' ),   // data format
-            array( '%d' )  // where format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    __('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 $_payment_table;
+
+	protected $_registration_table;
+
+	protected $_registration_payment_table;
+
+	public function __construct()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$this->_pretty_name = __('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 $transaction
+	 * @return void
+	 */
+	protected function _migrate_old_row($transaction)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$TXN_ID = absint($transaction['TXN_ID']);
+		if (! $TXN_ID) {
+			$this->add_error(
+				sprintf(
+					__('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 $PAY_ID => $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($TXN_ID)
+	{
+		/** @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($TXN_ID)
+	{
+		/** @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 array
+	 */
+	protected function _get_possibly_updated_REG_paid($REG_ID)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $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 bool
+	 */
+	protected function _process_registration_payments($payment, $registrations = array())
+	{
+		// 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
+			$possibly_updated_REG_paid = $this->_get_possibly_updated_REG_paid($REG_ID);
+			if (is_float($possibly_updated_REG_paid)) {
+				$registration->REG_paid = $possibly_updated_REG_paid;
+			}
+			// and ensure REG_paid has a valid value
+			$registration->REG_paid = ! empty($registration->REG_paid) ? (float) $registration->REG_paid : 0.00;
+			// 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, $payment_amount)) {
+				// calculate and set new REG_paid
+				$registration->REG_paid = $registration->REG_paid + $payment_amount;
+				$this->_update_registration_paid($registration->REG_ID, $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($REG_ID = 0, $PAY_ID = 0, $PAY_amount = 0.00)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$success = $wpdb->insert(
+			$this->_registration_payment_table,
+			array( 'REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount, ),  // data
+			array( '%f' )   // data format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					__('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($REG_ID = 0, $REG_paid = 0.00)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$success = $wpdb->update(
+			$this->_registration_table,
+			array( 'REG_paid' => $REG_paid ),  // data
+			array( 'REG_ID' => $REG_ID ),  // where
+			array( '%f' ),   // data format
+			array( '%d' )  // where format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					__('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 +14 added lines, -14 removed lines

@@ -24,10 +24,10 @@ 
         global $wpdb;
         $this->_pretty_name = __('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();
@@ -44,7 +44,7 @@ 
         /** @type WPDB $wpdb */
         global $wpdb;
         $TXN_ID = absint($transaction['TXN_ID']);
-        if (! $TXN_ID) {
+        if ( ! $TXN_ID) {
             $this->add_error(
                 sprintf(
                     __('Invalid transaction with ID=%1$d. Error: "%2$s"', 'event_espresso'),
@@ -136,12 +136,12 @@ 
         $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
@@ -153,7 +153,7 @@ 
             $registration->REG_paid = ! empty($registration->REG_paid) ? (float) $registration->REG_paid : 0.00;
             // 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
@@ -185,8 +185,8 @@ 
         global $wpdb;
         $success = $wpdb->insert(
             $this->_registration_payment_table,
-            array( 'REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount, ),  // data
-            array( '%f' )   // data format
+            array('REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount,), // data
+            array('%f')   // data format
         );
         if ($success === false) {
             $this->add_error(
@@ -216,10 +216,10 @@ 
         global $wpdb;
         $success = $wpdb->update(
             $this->_registration_table,
-            array( 'REG_paid' => $REG_paid ),  // data
-            array( 'REG_ID' => $REG_ID ),  // where
-            array( '%f' ),   // data format
-            array( '%d' )  // where format
+            array('REG_paid' => $REG_paid), // data
+            array('REG_ID' => $REG_ID), // where
+            array('%f'), // data format
+            array('%d')  // where format
         );
         if ($success === false) {
             $this->add_error(

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

Indentation +200 added lines, -200 removed lines

@@ -12,73 +12,73 @@ 
 class EE_DMS_4_7_0_Add_Taxes_To_REG_Final_Price extends EE_Data_Migration_Script_Stage_Table
 {
 
-    protected $_ticket_table;
-
-    protected $_line_item_table;
-
-    public function __construct()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $this->_pretty_name = __('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()
-    {
-        $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()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $SQL = "SELECT count( reg.REG_ID ) ";
-        $SQL .= $this->_get_rest_of_sql_for_query();
-        $count = $wpdb->get_var($SQL);
-        return $count;
-    }
-
-
-
-    /**
-     * Gets data for all registrations with taxable tickets in the esp_line_item table
-     * @global wpdb $wpdb
-     * @param int $limit
-     * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
-     */
-    protected function _get_rows($limit)
-    {
-        /** @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 $_ticket_table;
+
+	protected $_line_item_table;
+
+	public function __construct()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$this->_pretty_name = __('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()
+	{
+		$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()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$SQL = "SELECT count( reg.REG_ID ) ";
+		$SQL .= $this->_get_rest_of_sql_for_query();
+		$count = $wpdb->get_var($SQL);
+		return $count;
+	}
+
+
+
+	/**
+	 * Gets data for all registrations with taxable tickets in the esp_line_item table
+	 * @global wpdb $wpdb
+	 * @param int $limit
+	 * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
+	 */
+	protected function _get_rows($limit)
+	{
+		/** @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,
@@ -95,137 +95,137 @@ 
             LIMIT 1, 50
          */
 
-        return $wpdb->get_results($SQL, ARRAY_A);
-    }
-
-
-
-    /**
-     * @param array $row
-     * @return void
-     */
-    protected function _migrate_old_row($row)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        // ensure all required values are present
-        if (! isset($row['REG_ID'], $row['REG_final_price'], $row['LIN_ID'])) {
-            $this->add_error(
-                sprintf(
-                    __('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 />',
-                    isset($row['REG_ID']) ? $row['REG_ID'] : '',
-                    isset($row['REG_final_price']) ? $row['REG_final_price'] : '',
-                    isset($row['LIN_ID']) ? $row['LIN_ID'] : '',
-                    $wpdb->last_error
-                )
-            );
-            return;
-        }
-        // get tax subtotal
-        $tax_subtotal_line_item_ID = $this->_get_line_item_ID_for_tax_subtotal($row['LIN_ID']);
-        if (! $tax_subtotal_line_item_ID) {
-            $this->add_error(
-                sprintf(
-                    __('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($row['REG_ID'], $row['REG_final_price'], $taxes);
-    }
-
-
-
-    /**
-     * _get_tax_subtotal
-     *
-     * @param int $LIN_ID
-     * @return int
-     */
-    protected function _get_line_item_ID_for_tax_subtotal($LIN_ID)
-    {
-        /** @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 $wpdb->get_var($wpdb->prepare($SQL, $LIN_ID));
-    }
-
-
-
-    /**
-     * _get_tax_subtotal
-     *
-     * @param int $LIN_ID
-     * @return array
-     */
-    protected function _get_tax_amounts($LIN_ID)
-    {
-        /** @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($REG_ID = 0, $final_price = 0.00, $taxes = array())
-    {
-        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, $final_price);
-        }
-    }
-
-
-
-    /**
-     * _update_registration_final_price
-     *
-     * @param int $REG_ID
-     * @param float $REG_final_price
-     * @return void
-     */
-    protected function _update_registration_final_price($REG_ID = 0, $REG_final_price = 0.00)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $success = $wpdb->update(
-            $this->_old_table,
-            array( 'REG_final_price' => $REG_final_price ),  // data
-            array( 'REG_ID' => $REG_ID ),  // where
-            array( '%f' ),   // data format
-            array( '%d' )  // where format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    __('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 $row
+	 * @return void
+	 */
+	protected function _migrate_old_row($row)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		// ensure all required values are present
+		if (! isset($row['REG_ID'], $row['REG_final_price'], $row['LIN_ID'])) {
+			$this->add_error(
+				sprintf(
+					__('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 />',
+					isset($row['REG_ID']) ? $row['REG_ID'] : '',
+					isset($row['REG_final_price']) ? $row['REG_final_price'] : '',
+					isset($row['LIN_ID']) ? $row['LIN_ID'] : '',
+					$wpdb->last_error
+				)
+			);
+			return;
+		}
+		// get tax subtotal
+		$tax_subtotal_line_item_ID = $this->_get_line_item_ID_for_tax_subtotal($row['LIN_ID']);
+		if (! $tax_subtotal_line_item_ID) {
+			$this->add_error(
+				sprintf(
+					__('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($row['REG_ID'], $row['REG_final_price'], $taxes);
+	}
+
+
+
+	/**
+	 * _get_tax_subtotal
+	 *
+	 * @param int $LIN_ID
+	 * @return int
+	 */
+	protected function _get_line_item_ID_for_tax_subtotal($LIN_ID)
+	{
+		/** @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 $wpdb->get_var($wpdb->prepare($SQL, $LIN_ID));
+	}
+
+
+
+	/**
+	 * _get_tax_subtotal
+	 *
+	 * @param int $LIN_ID
+	 * @return array
+	 */
+	protected function _get_tax_amounts($LIN_ID)
+	{
+		/** @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($REG_ID = 0, $final_price = 0.00, $taxes = array())
+	{
+		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, $final_price);
+		}
+	}
+
+
+
+	/**
+	 * _update_registration_final_price
+	 *
+	 * @param int $REG_ID
+	 * @param float $REG_final_price
+	 * @return void
+	 */
+	protected function _update_registration_final_price($REG_ID = 0, $REG_final_price = 0.00)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$success = $wpdb->update(
+			$this->_old_table,
+			array( 'REG_final_price' => $REG_final_price ),  // data
+			array( 'REG_ID' => $REG_ID ),  // where
+			array( '%f' ),   // data format
+			array( '%d' )  // where format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					__('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

@@ -22,9 +22,9 @@ 
         global $wpdb;
         $this->_pretty_name = __('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();
     }
 
@@ -109,7 +109,7 @@ 
         /** @type WPDB $wpdb */
         global $wpdb;
         // ensure all required values are present
-        if (! isset($row['REG_ID'], $row['REG_final_price'], $row['LIN_ID'])) {
+        if ( ! isset($row['REG_ID'], $row['REG_final_price'], $row['LIN_ID'])) {
             $this->add_error(
                 sprintf(
                     __('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'),
@@ -124,7 +124,7 @@ 
         }
         // get tax subtotal
         $tax_subtotal_line_item_ID = $this->_get_line_item_ID_for_tax_subtotal($row['LIN_ID']);
-        if (! $tax_subtotal_line_item_ID) {
+        if ( ! $tax_subtotal_line_item_ID) {
             $this->add_error(
                 sprintf(
                     __('Invalid line item ID returned. Error: "%1$s"', 'event_espresso'),
@@ -191,7 +191,7 @@ 
         if (is_array($taxes) && ! empty($taxes)) {
             $total_taxes = 0;
             foreach ($taxes as $tax) {
-                $total_taxes += $final_price * ( $tax->LIN_percent / 100 );
+                $total_taxes += $final_price * ($tax->LIN_percent / 100);
             }
             $final_price += $total_taxes;
             $this->_update_registration_final_price($REG_ID, $final_price);
@@ -213,10 +213,10 @@ 
         global $wpdb;
         $success = $wpdb->update(
             $this->_old_table,
-            array( 'REG_final_price' => $REG_final_price ),  // data
-            array( 'REG_ID' => $REG_ID ),  // where
-            array( '%f' ),   // data format
-            array( '%d' )  // where format
+            array('REG_final_price' => $REG_final_price), // data
+            array('REG_ID' => $REG_ID), // where
+            array('%f'), // data format
+            array('%d')  // where format
         );
         if ($success === false) {
             $this->add_error(

core/data_migration_scripts/EE_DMS_Unknown_1_0_0.core.php

Indentation +40 added lines, -40 removed lines

@@ -18,44 +18,44 @@
 class EE_DMS_Unknown_1_0_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * Returns whether or not 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
-     *
-     * @param string $version_string
-     * @return boolean
-     */
-    public function can_migrate_from_version($version_string)
-    {
-        return false;
-    }
-
-    public function schema_changes_after_migration()
-    {
-        return;
-    }
-
-    public function schema_changes_before_migration()
-    {
-        return;
-    }
-
-
-    /**
-     * All children of this must call parent::__construct() at the end of their constructor or suffer the consequences!
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_migration_stages = array();
-        $this->_pretty_name = __("Fatal Uncatchable Error Occurred", "event_espresso");
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-    public function migration_page_hooks()
-    {
-    }
+	/**
+	 * Returns whether or not 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
+	 *
+	 * @param string $version_string
+	 * @return boolean
+	 */
+	public function can_migrate_from_version($version_string)
+	{
+		return false;
+	}
+
+	public function schema_changes_after_migration()
+	{
+		return;
+	}
+
+	public function schema_changes_before_migration()
+	{
+		return;
+	}
+
+
+	/**
+	 * All children of this must call parent::__construct() at the end of their constructor or suffer the consequences!
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_migration_stages = array();
+		$this->_pretty_name = __("Fatal Uncatchable Error Occurred", "event_espresso");
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+	public function migration_page_hooks()
+	{
+	}
 }

core/data_migration_scripts/4_9_0_stages/EE_DMS_4_9_0_Answers_With_No_Registration.dmsstage.php

Indentation +38 added lines, -38 removed lines

@@ -15,44 +15,44 @@
 
 
 
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_9_0_Answers_With_No_Registration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = __('Answer Cleanup', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_9_0_Answers_With_No_Registration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = __('Answer Cleanup', 'event_espresso');
+		parent::__construct();
+	}
 
-    /**
-     * Counts the records to migrate; the public version may cache it
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
-    /**
-     * 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
-     */
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        global $wpdb;
-        $wpdb->delete(
-            $wpdb->prefix . 'esp_answer',
-            array( 'REG_ID' => 0 ),
-            array( '%d' )
-        );
-        $this->set_completed();
-        return 1;
-    }
+	/**
+	 * 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
+	 */
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		global $wpdb;
+		$wpdb->delete(
+			$wpdb->prefix . 'esp_answer',
+			array( 'REG_ID' => 0 ),
+			array( '%d' )
+		);
+		$this->set_completed();
+		return 1;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -48,9 +48,9 @@
     {
         global $wpdb;
         $wpdb->delete(
-            $wpdb->prefix . 'esp_answer',
-            array( 'REG_ID' => 0 ),
-            array( '%d' )
+            $wpdb->prefix.'esp_answer',
+            array('REG_ID' => 0),
+            array('%d')
         );
         $this->set_completed();
         return 1;

core/data_migration_scripts/4_9_0_stages/EE_DMS_4_9_0_Email_System_Question.dmsstage.php

Indentation +41 added lines, -41 removed lines

@@ -14,48 +14,48 @@
 
 
 
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_9_0_Email_System_Question
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __('Email - System Question', 'event_espresso');
-        $this->_old_table = $wpdb->prefix.'esp_question';
-        $this->_extra_where_sql = "WHERE QST_system = 'email'";
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_9_0_Email_System_Question
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __('Email - System Question', 'event_espresso');
+		$this->_old_table = $wpdb->prefix.'esp_question';
+		$this->_extra_where_sql = "WHERE QST_system = 'email'";
+		parent::__construct();
+	}
 
 
 
-    /**
-     * updates the question with the new question type
-     * @param array $question an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($question)
-    {
-        if ($question['QST_ID'] && $question['QST_system'] == 'email') {
-            global $wpdb;
-            $success = $wpdb->update(
-                $this->_old_table,
-                array( 'QST_type' => 'EMAIL' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
-            );
-            if (! $success) {
-                $this->add_error(
-                    sprintf(
-                        __('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
-                        wp_json_encode($question['QST_system']),
-                        $question['QST_ID'],
-                        $wpdb->last_error
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * updates the question with the new question type
+	 * @param array $question an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($question)
+	{
+		if ($question['QST_ID'] && $question['QST_system'] == 'email') {
+			global $wpdb;
+			$success = $wpdb->update(
+				$this->_old_table,
+				array( 'QST_type' => 'EMAIL' ),  // data
+				array( 'QST_ID' => $question['QST_ID'] ),  // where
+				array( '%s' ),   // data format
+				array( '%d' )  // where format
+			);
+			if (! $success) {
+				$this->add_error(
+					sprintf(
+						__('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),
+						wp_json_encode($question['QST_system']),
+						$question['QST_ID'],
+						$wpdb->last_error
+					)
+				);
+			}
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -41,12 +41,12 @@
             global $wpdb;
             $success = $wpdb->update(
                 $this->_old_table,
-                array( 'QST_type' => 'EMAIL' ),  // data
-                array( 'QST_ID' => $question['QST_ID'] ),  // where
-                array( '%s' ),   // data format
-                array( '%d' )  // where format
+                array('QST_type' => 'EMAIL'), // data
+                array('QST_ID' => $question['QST_ID']), // where
+                array('%s'), // data format
+                array('%d')  // where format
             );
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error(
                     sprintf(
                         __('Could not update question system name "%1$s" for question ID=%2$d because "%3$s"', 'event_espresso'),

core/data_migration_scripts/EE_Data_Migration_Class_Base.core.php

Spacing +4 added lines, -4 removed lines

@@ -185,7 +185,7 @@ 
      */
     public function add_error($error, $force = false)
     {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
+        if ( ! defined('EE_DMS_ERROR_LIMIT')) {
             $limit = 50;
         } else {
             $limit = EE_DMS_ERROR_LIMIT;
@@ -201,7 +201,7 @@ 
                 $this->_errors[] = "Limit reached; removed first half of errors to save space";
                 $this->_errors[] = $error;
             } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
+                $this->_errors[$limit] = 'More, but limit reached...';
             }
         } else {
             $this->_errors[] = $error;
@@ -343,7 +343,7 @@ 
         $new_columns_and_values_for_string = array();
         $count = 0;
         foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+            $new_columns_and_values_for_string[] = " $column => $value (".$data_types[$count++].")";
         }
         return sprintf(
             __(
@@ -374,7 +374,7 @@ 
         foreach ($array_of_data as $name => $value) {
             $unserialized_data = @unserialize($value);
             if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
+                $fields_to_include[$name] = $value;
             }
         }
         return wp_json_encode($fields_to_include);

Indentation +404 added lines, -404 removed lines

@@ -17,408 +17,408 @@
 abstract class EE_Data_Migration_Class_Base
 {
 
-    /**
-     * @var $records_to_migrate int count of all that have been migrated
-     */
-    protected $_records_to_migrate = 0;
-
-    /**
-     *
-     * @var $records_migrated int
-     */
-    protected $_records_migrated = 0;
-
-    /**
-     * Whether this migration script is done or not. This COULD be deduced by
-     * _records_to_migrate and _records_migrated, but that might nto be accurate
-     *
-     * @var string one of EE_Data_migration_Manager::status_* constants
-     */
-    protected $_status = null;
-
-    /**
-     * internationalized name of this class. Convention is to NOT restate that
-     * this class if a migration script or a migration script stage
-     *
-     * @var string (i18ned)
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var array
-     */
-    protected $_errors = array();
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * Just initializes the status of the migration
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_table_manager = $table_manager;
-        $this->_table_analysis = $table_analysis;
-        $this->set_status(EE_Data_Migration_Manager::status_continue);
-    }
-
-
-    /**
-     * Just gets the pretty name for this migration script or stage
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function pretty_name()
-    {
-        if ($this->_pretty_name === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_pretty_name;
-    }
-
-    /**
-     *
-     * @return int
-     */
-    public function count_records_to_migrate()
-    {
-        if ($this->_records_to_migrate == null) {
-            $this->_records_to_migrate = $this->_count_records_to_migrate();
-        }
-        return $this->_records_to_migrate;
-    }
-
-    /**
-     * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
-     * EE_Data_migration_Script_Stage
-     *
-     * @return int
-     */
-    abstract public function count_records_migrated();
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    abstract protected function _count_records_to_migrate();
-
-    /**
-     * Returns a string indicating the migration script's status.
-     *
-     * @return string one of EE_Data_Migration_Manager::status_* constants
-     * @throws EE_Error
-     */
-    public function get_status()
-    {
-        if ($this->_status === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_status;
-    }
-
-    /**
-     *
-     * @param string $status
-     * @return void
-     */
-    protected function set_status($status)
-    {
-        $this->_status = $status;
-    }
-
-    /**
-     * @return array of strings
-     */
-    abstract public function get_errors();
-
-    /**
-     * Returns the last error that occurred. If none occurred, returns null
-     *
-     * @return string
-     */
-    public function get_last_error()
-    {
-        $errors = $this->get_errors();
-        if ($errors) {
-            return end($errors);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Adds an error to the array of errors on this class.
-     *
-     * @param string  $error a string describing the error that will be useful for debugging. Consider including all
-     *                       the data that led to the error, and a stack trace etc.
-     * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
-     *                       already at their limit, we will purposefully forget the first half
-     */
-    public function add_error($error, $force = false)
-    {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
-            $limit = 50;
-        } else {
-            $limit = EE_DMS_ERROR_LIMIT;
-        }
-        // make sure errors is an array, see ticket #8261
-        if (is_string($this->_errors)) {
-            $this->_errors = array($this->_errors);
-        }
-        if (count($this->_errors) >= $limit) {
-            if ($force) {
-                // get rid of the first half of the errors and any above the limit
-                $this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
-                $this->_errors[] = "Limit reached; removed first half of errors to save space";
-                $this->_errors[] = $error;
-            } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
-            }
-        } else {
-            $this->_errors[] = $error;
-        }
-    }
-
-    /**
-     * Indicates there was a fatal error and the migration cannot possibly continue
-     *
-     * @return boolean
-     */
-    public function is_broken()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     * @deprecated since 4.6.12
-     */
-    public function is_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->is_broken();
-    }
-
-    /**
-     * Sets the status to as having a fatal error
-     */
-    public function set_broken()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     *
-     * @deprecated since 4.6.12
-     */
-    public function set_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->set_broken();
-    }
-
-    /**
-     * Checks if this thing believes it is completed
-     *
-     * @return boolean
-     */
-    public function is_completed()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
-     *
-     * @return boolean
-     */
-    public function has_more_to_do()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_continue;
-    }
-
-    /**
-     * Marks that we believe this migration thing is completed
-     */
-    public function set_completed()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Marks that we think this migration class can continue to migrate
-     */
-    public function reattempt()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_continue;
-        $this->add_error(__('Reattempt migration', 'event_espresso'), true);
-    }
-
-    /**
-     * 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 = get_object_vars($this);
-        $properties['class'] = get_class($this);
-        unset($properties['_migration_script']);
-        unset($properties['_table_manager']);
-        unset($properties['_table_analysis']);
-        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
-     */
-    abstract public function instantiate_from_array_of_properties($array_of_properties);
-
-    /**
-     * Convenience method for showing a database insertion error
-     *
-     * @param string $old_table
-     * @param array  $old_row_as_array
-     * @param string $new_table
-     * @param array  $new_row_as_array columns=>values like used in wpdb->insert
-     * @param array  $data_types       numerically indexed
-     * @return string
-     */
-    protected function _create_error_message_for_db_insertion(
-        $old_table,
-        $old_row_as_array,
-        $new_table,
-        $new_row_as_array,
-        $data_types
-    ) {
-        global $wpdb;
-        $old_columns_and_values_for_string = array();
-        foreach ($old_row_as_array as $column => $value) {
-            $old_columns_and_values_for_string[] = "$column => $value";
-        }
-        $new_columns_and_values_for_string = array();
-        $count = 0;
-        foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
-        }
-        return sprintf(
-            __(
-                'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
-                'event_espresso'
-            ),
-            implode(", ", $new_columns_and_values_for_string),
-            $new_table,
-            implode(", ", $old_columns_and_values_for_string),
-            $old_table,
-            '<br/>',
-            $wpdb->last_error
-        );
-    }
-
-
-    /**
-     * Same as json_encode, just avoids putting
-     * serialized arrays into the http build query, as that would
-     *
-     * @param array $array_of_data
-     * @return string
-     */
-    protected function _json_encode($array_of_data)
-    {
-        // we'd rather NOT serialize the transaction details
-        $fields_to_include = array();
-        foreach ($array_of_data as $name => $value) {
-            $unserialized_data = @unserialize($value);
-            if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
-            }
-        }
-        return wp_json_encode($fields_to_include);
-    }
-
-    /**
-     * Gets the table manager (or throws an exception if it cannot be retrieved)
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var $records_to_migrate int count of all that have been migrated
+	 */
+	protected $_records_to_migrate = 0;
+
+	/**
+	 *
+	 * @var $records_migrated int
+	 */
+	protected $_records_migrated = 0;
+
+	/**
+	 * Whether this migration script is done or not. This COULD be deduced by
+	 * _records_to_migrate and _records_migrated, but that might nto be accurate
+	 *
+	 * @var string one of EE_Data_migration_Manager::status_* constants
+	 */
+	protected $_status = null;
+
+	/**
+	 * internationalized name of this class. Convention is to NOT restate that
+	 * this class if a migration script or a migration script stage
+	 *
+	 * @var string (i18ned)
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_errors = array();
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_table_manager = $table_manager;
+		$this->_table_analysis = $table_analysis;
+		$this->set_status(EE_Data_Migration_Manager::status_continue);
+	}
+
+
+	/**
+	 * Just gets the pretty name for this migration script or stage
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		if ($this->_pretty_name === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_pretty_name;
+	}
+
+	/**
+	 *
+	 * @return int
+	 */
+	public function count_records_to_migrate()
+	{
+		if ($this->_records_to_migrate == null) {
+			$this->_records_to_migrate = $this->_count_records_to_migrate();
+		}
+		return $this->_records_to_migrate;
+	}
+
+	/**
+	 * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
+	 * EE_Data_migration_Script_Stage
+	 *
+	 * @return int
+	 */
+	abstract public function count_records_migrated();
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	abstract protected function _count_records_to_migrate();
+
+	/**
+	 * Returns a string indicating the migration script's status.
+	 *
+	 * @return string one of EE_Data_Migration_Manager::status_* constants
+	 * @throws EE_Error
+	 */
+	public function get_status()
+	{
+		if ($this->_status === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_status;
+	}
+
+	/**
+	 *
+	 * @param string $status
+	 * @return void
+	 */
+	protected function set_status($status)
+	{
+		$this->_status = $status;
+	}
+
+	/**
+	 * @return array of strings
+	 */
+	abstract public function get_errors();
+
+	/**
+	 * Returns the last error that occurred. If none occurred, returns null
+	 *
+	 * @return string
+	 */
+	public function get_last_error()
+	{
+		$errors = $this->get_errors();
+		if ($errors) {
+			return end($errors);
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Adds an error to the array of errors on this class.
+	 *
+	 * @param string  $error a string describing the error that will be useful for debugging. Consider including all
+	 *                       the data that led to the error, and a stack trace etc.
+	 * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
+	 *                       already at their limit, we will purposefully forget the first half
+	 */
+	public function add_error($error, $force = false)
+	{
+		if (! defined('EE_DMS_ERROR_LIMIT')) {
+			$limit = 50;
+		} else {
+			$limit = EE_DMS_ERROR_LIMIT;
+		}
+		// make sure errors is an array, see ticket #8261
+		if (is_string($this->_errors)) {
+			$this->_errors = array($this->_errors);
+		}
+		if (count($this->_errors) >= $limit) {
+			if ($force) {
+				// get rid of the first half of the errors and any above the limit
+				$this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
+				$this->_errors[] = "Limit reached; removed first half of errors to save space";
+				$this->_errors[] = $error;
+			} else {
+				$this->_errors[ $limit ] = 'More, but limit reached...';
+			}
+		} else {
+			$this->_errors[] = $error;
+		}
+	}
+
+	/**
+	 * Indicates there was a fatal error and the migration cannot possibly continue
+	 *
+	 * @return boolean
+	 */
+	public function is_broken()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 * @deprecated since 4.6.12
+	 */
+	public function is_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->is_broken();
+	}
+
+	/**
+	 * Sets the status to as having a fatal error
+	 */
+	public function set_broken()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 *
+	 * @deprecated since 4.6.12
+	 */
+	public function set_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->set_broken();
+	}
+
+	/**
+	 * Checks if this thing believes it is completed
+	 *
+	 * @return boolean
+	 */
+	public function is_completed()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
+	 *
+	 * @return boolean
+	 */
+	public function has_more_to_do()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_continue;
+	}
+
+	/**
+	 * Marks that we believe this migration thing is completed
+	 */
+	public function set_completed()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Marks that we think this migration class can continue to migrate
+	 */
+	public function reattempt()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_continue;
+		$this->add_error(__('Reattempt migration', 'event_espresso'), true);
+	}
+
+	/**
+	 * 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 = get_object_vars($this);
+		$properties['class'] = get_class($this);
+		unset($properties['_migration_script']);
+		unset($properties['_table_manager']);
+		unset($properties['_table_analysis']);
+		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
+	 */
+	abstract public function instantiate_from_array_of_properties($array_of_properties);
+
+	/**
+	 * Convenience method for showing a database insertion error
+	 *
+	 * @param string $old_table
+	 * @param array  $old_row_as_array
+	 * @param string $new_table
+	 * @param array  $new_row_as_array columns=>values like used in wpdb->insert
+	 * @param array  $data_types       numerically indexed
+	 * @return string
+	 */
+	protected function _create_error_message_for_db_insertion(
+		$old_table,
+		$old_row_as_array,
+		$new_table,
+		$new_row_as_array,
+		$data_types
+	) {
+		global $wpdb;
+		$old_columns_and_values_for_string = array();
+		foreach ($old_row_as_array as $column => $value) {
+			$old_columns_and_values_for_string[] = "$column => $value";
+		}
+		$new_columns_and_values_for_string = array();
+		$count = 0;
+		foreach ($new_row_as_array as $column => $value) {
+			$new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+		}
+		return sprintf(
+			__(
+				'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
+				'event_espresso'
+			),
+			implode(", ", $new_columns_and_values_for_string),
+			$new_table,
+			implode(", ", $old_columns_and_values_for_string),
+			$old_table,
+			'<br/>',
+			$wpdb->last_error
+		);
+	}
+
+
+	/**
+	 * Same as json_encode, just avoids putting
+	 * serialized arrays into the http build query, as that would
+	 *
+	 * @param array $array_of_data
+	 * @return string
+	 */
+	protected function _json_encode($array_of_data)
+	{
+		// we'd rather NOT serialize the transaction details
+		$fields_to_include = array();
+		foreach ($array_of_data as $name => $value) {
+			$unserialized_data = @unserialize($value);
+			if ($unserialized_data === false) {
+				$fields_to_include[ $name ] = $value;
+			}
+		}
+		return wp_json_encode($fields_to_include);
+	}
+
+	/**
+	 * Gets the table manager (or throws an exception if it cannot be retrieved)
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }