eventespresso / event-espresso-core

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_org_options.dmsstage.php

Doc Comments -1 removed lines

@@ -273,7 +273,6 @@
     /**
      * Creates a 4.1 member price discount
      * @global type $wpdb
-     * @param type $old_price
      * @return int
      */
     private function _insert_new_global_surcharge_price($org_options)

Spacing +33 added lines, -33 removed lines

@@ -110,17 +110,17 @@ 
         $old_org_options = get_option('events_organization_settings');
         foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
             // only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
-            if (isset($old_org_options[ $option_name ])) {
-                $this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
+            if (isset($old_org_options[$option_name])) {
+                $this->_handle_org_option($option_name, $old_org_options[$option_name]);
             }
-            if ($option_name=='surcharge') {
+            if ($option_name == 'surcharge') {
                 $this->_insert_new_global_surcharge_price($old_org_options);
             }
             $items_actually_migrated++;
         }
 
         $success = EE_Config::instance()->update_espresso_config(false, true);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false)));
             EE_Error::overwrite_errors();
         }
@@ -176,24 +176,24 @@ 
                 $c->organization->email = $value;
                 break;
             case 'default_payment_status':
-                $c->registration->default_STS_ID =  $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
+                $c->registration->default_STS_ID = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
                 break;
             case 'organization_country':
-                $iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value);
+                $iso = $this->get_migration_script()->get_iso_from_3_1_country_id($value);
                 $c->organization->CNT_ISO = $iso;
                 $country_row = $this->get_migration_script()->get_or_create_country($iso);
-                if (! $country_row) {
+                if ( ! $country_row) {
                     $this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso));
                 }
                 // can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
-                $c->currency->code = $country_row['CNT_cur_code'];          // currency code: USD, CAD, EUR
-                $c->currency->name = $country_row['CNT_cur_single'];    // Dollar
-                $c->currency->plural = $country_row['CNT_cur_plural'];  // Dollars
-                $c->currency->sign =  $country_row['CNT_cur_sign'];             // currency sign: $
-                $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN);        // currency sign before or after: $TRUE  or  FALSE$
-                $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
-                $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk'];    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $c->currency->thsnds = $country_row['CNT_cur_thsnds'];  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+                $c->currency->code = $country_row['CNT_cur_code']; // currency code: USD, CAD, EUR
+                $c->currency->name = $country_row['CNT_cur_single']; // Dollar
+                $c->currency->plural = $country_row['CNT_cur_plural']; // Dollars
+                $c->currency->sign = $country_row['CNT_cur_sign']; // currency sign: $
+                $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN); // currency sign before or after: $TRUE  or  FALSE$
+                $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc']; // decimal places: 2 = 0.00  3 = 0.000
+                $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk']; // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+                $c->currency->thsnds = $country_row['CNT_cur_thsnds']; // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
   //            $c->currency = new EE_Currency_Config($c->organization->CNT_ISO);break;
   //        case 'currency_symbol': ignore the currency symbol. we'll just go by their country.
   //            $c->currency->sign = $value;break;
@@ -280,7 +280,7 @@ 
     {
         $amount = floatval($org_options['surcharge']);
         // dont createa a price if the surcharge is 0
-        if ($amount <=.01) {
+        if ($amount <= .01) {
             return 0;
         }
         if ($org_options['surcharge_type'] == 'flat_rate') {
@@ -301,18 +301,18 @@ 
 
         );
         $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
+            '%d', // PRT_ID
+            '%f', // PRT_amount
+            '%s', // PRC_name
+            '%d', // PRC_is_default
+            '%d', // PRC_overrides
+            '%d', // PRC_order
+            '%d', // PRC_deleted
+            '%d', // PRC_parent
         );
         $price_table = $wpdb->prefix."esp_price";
         $success = $wpdb->insert($price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion(
                 'org_options',
                 array(
@@ -342,8 +342,8 @@ 
       'payment_message',
       'message',
       'default_payment_status',
-      'surcharge',// unused?
-      'country_id',// unused?
+      'surcharge', // unused?
+      'country_id', // unused?
       'organization_country',
 //    'currency_symbol',
       'expire_on_registration_end',
@@ -355,13 +355,13 @@ 
       'show_pending_payment_options',
       'show_reg_footer',
       'skip_confirmation_page',
-      'allow_mer_discounts',// no equiv
-      'allow_mer_vouchers',// no equiv
+      'allow_mer_discounts', // no equiv
+      'allow_mer_vouchers', // no equiv
       'display_short_description_in_event_list',
       'display_description_on_multi_reg_page',
       'display_address_in_event_list',
       'display_address_in_regform',
-      'use_custom_post_types',// no equiv
+      'use_custom_post_types', // no equiv
       'display_ical_download',
       'display_featured_image',
       'themeroller',
@@ -380,11 +380,11 @@ 
       'espresso_dashboard_widget',
       'time_reg_limit',
 //    'use_attendee_pre_approval', removed in 4.1- instead this is factored into the default reg status
-      'use_personnel_manager',// no equiv
+      'use_personnel_manager', // no equiv
       'use_event_timezones',
       'full_logging',
-      'surcharge_type',// unused
-      'surcharge_text',// unused
+      'surcharge_type', // unused
+      'surcharge_text', // unused
       'affiliate_id',
       'site_license_key',
     );

Indentation +270 added lines, -270 removed lines

@@ -103,286 +103,286 @@
 class EE_DMS_4_1_0_org_options extends EE_Data_Migration_Script_Stage
 {
 
-    public function _migration_step($num_items = 50)
-    {
+	public function _migration_step($num_items = 50)
+	{
 
-        $items_actually_migrated = 0;
-        $old_org_options = get_option('events_organization_settings');
-        foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
-            // only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
-            if (isset($old_org_options[ $option_name ])) {
-                $this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
-            }
-            if ($option_name=='surcharge') {
-                $this->_insert_new_global_surcharge_price($old_org_options);
-            }
-            $items_actually_migrated++;
-        }
+		$items_actually_migrated = 0;
+		$old_org_options = get_option('events_organization_settings');
+		foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
+			// only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
+			if (isset($old_org_options[ $option_name ])) {
+				$this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
+			}
+			if ($option_name=='surcharge') {
+				$this->_insert_new_global_surcharge_price($old_org_options);
+			}
+			$items_actually_migrated++;
+		}
 
-        $success = EE_Config::instance()->update_espresso_config(false, true);
-        if (! $success) {
-            $this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false)));
-            EE_Error::overwrite_errors();
-        }
-        EE_Network_Config::instance()->update_config(false, false);
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            // we may have added new pages and this might be necessary
-            flush_rewrite_rules();
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        $count_of_options_to_migrate = count($this->_org_options_we_know_how_to_migrate);
-        return $count_of_options_to_migrate;
-    }
-    public function __construct()
-    {
-        $this->_pretty_name = __("Organization Options/Config", "event_espresso");
-        $this->_org_options_we_know_how_to_migrate = apply_filters('FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate', $this->_org_options_we_know_how_to_migrate);
-        parent::__construct();
-    }
+		$success = EE_Config::instance()->update_espresso_config(false, true);
+		if (! $success) {
+			$this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false)));
+			EE_Error::overwrite_errors();
+		}
+		EE_Network_Config::instance()->update_config(false, false);
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			// we may have added new pages and this might be necessary
+			flush_rewrite_rules();
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		$count_of_options_to_migrate = count($this->_org_options_we_know_how_to_migrate);
+		return $count_of_options_to_migrate;
+	}
+	public function __construct()
+	{
+		$this->_pretty_name = __("Organization Options/Config", "event_espresso");
+		$this->_org_options_we_know_how_to_migrate = apply_filters('FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate', $this->_org_options_we_know_how_to_migrate);
+		parent::__construct();
+	}
 
-    private function _handle_org_option($option_name, $value)
-    {
-        $c = EE_Config::instance();
-        $cn = EE_Network_Config::instance();
-        switch ($option_name) {
-            case 'organization':
-                $c->organization->name = $value;
-                break;
-            case 'organization_street1':
-                $c->organization->address_1 = $value;
-                break;
-            case 'organization_street2':
-                $c->organization->address_2 = $value;
-                break;
-            case 'organization_city':
-                $c->organization->city = $value;
-                break;
-            case 'organization_state':
-                try {
-                    $state = $this->get_migration_script()->get_or_create_state($value);
-                    $state_id = $state['STA_ID'];
-                    $c->organization->STA_ID = $state_id;
-                } catch (EE_Error $e) {
-                }
-                break;
-            case 'organization_zip':
-                $c->organization->zip = $value;
-                break;
-            case 'contact_email':
-                $c->organization->email = $value;
-                break;
-            case 'default_payment_status':
-                $c->registration->default_STS_ID =  $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
-                break;
-            case 'organization_country':
-                $iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value);
-                $c->organization->CNT_ISO = $iso;
-                $country_row = $this->get_migration_script()->get_or_create_country($iso);
-                if (! $country_row) {
-                    $this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso));
-                }
-                // can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
-                $c->currency->code = $country_row['CNT_cur_code'];          // currency code: USD, CAD, EUR
-                $c->currency->name = $country_row['CNT_cur_single'];    // Dollar
-                $c->currency->plural = $country_row['CNT_cur_plural'];  // Dollars
-                $c->currency->sign =  $country_row['CNT_cur_sign'];             // currency sign: $
-                $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN);        // currency sign before or after: $TRUE  or  FALSE$
-                $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
-                $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk'];    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $c->currency->thsnds = $country_row['CNT_cur_thsnds'];  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+	private function _handle_org_option($option_name, $value)
+	{
+		$c = EE_Config::instance();
+		$cn = EE_Network_Config::instance();
+		switch ($option_name) {
+			case 'organization':
+				$c->organization->name = $value;
+				break;
+			case 'organization_street1':
+				$c->organization->address_1 = $value;
+				break;
+			case 'organization_street2':
+				$c->organization->address_2 = $value;
+				break;
+			case 'organization_city':
+				$c->organization->city = $value;
+				break;
+			case 'organization_state':
+				try {
+					$state = $this->get_migration_script()->get_or_create_state($value);
+					$state_id = $state['STA_ID'];
+					$c->organization->STA_ID = $state_id;
+				} catch (EE_Error $e) {
+				}
+				break;
+			case 'organization_zip':
+				$c->organization->zip = $value;
+				break;
+			case 'contact_email':
+				$c->organization->email = $value;
+				break;
+			case 'default_payment_status':
+				$c->registration->default_STS_ID =  $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
+				break;
+			case 'organization_country':
+				$iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value);
+				$c->organization->CNT_ISO = $iso;
+				$country_row = $this->get_migration_script()->get_or_create_country($iso);
+				if (! $country_row) {
+					$this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso));
+				}
+				// can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
+				$c->currency->code = $country_row['CNT_cur_code'];          // currency code: USD, CAD, EUR
+				$c->currency->name = $country_row['CNT_cur_single'];    // Dollar
+				$c->currency->plural = $country_row['CNT_cur_plural'];  // Dollars
+				$c->currency->sign =  $country_row['CNT_cur_sign'];             // currency sign: $
+				$c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN);        // currency sign before or after: $TRUE  or  FALSE$
+				$c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
+				$c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk'];    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$c->currency->thsnds = $country_row['CNT_cur_thsnds'];  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
   //            $c->currency = new EE_Currency_Config($c->organization->CNT_ISO);break;
   //        case 'currency_symbol': ignore the currency symbol. we'll just go by their country.
   //            $c->currency->sign = $value;break;
-            case 'show_pending_payment_options':
-                $c->registration->show_pending_payment_options = ($value == 'Y');
-                break;
-            case 'display_address_in_regform':
-                $c->template_settings->display_address_in_regform = ($value == 'Y');
-                break;
-            case 'default_logo_url':
-                $c->organization->logo_url = $value;
-                break;
-            case 'event_page_id':
-                // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
-                // to ESPRESSO_THANK_YOU
-                $reg_page_post = get_post($value);
-                $reg_page_post->post_content = str_replace("[ESPRESSO_EVENTS]", "[ESPRESSO_CHECKOUT]", $reg_page_post->post_content);
-                wp_update_post($reg_page_post);
-                $c->core->reg_page_id = $value;
-                break;
-            case 'return_url':
-                // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
-                // to ESPRESSO_THANK_YOU
-                $thank_you_page_post = get_post($value);
-                $thank_you_page_post->post_content = str_replace("[ESPRESSO_PAYMENTS]", "[ESPRESSO_THANK_YOU]", $thank_you_page_post->post_content);
-                wp_update_post($thank_you_page_post);
-                $c->core->thank_you_page_id = $value;
-                break;
-            case 'cancel_return':
-                $c->core->cancel_page_id = $value;
+			case 'show_pending_payment_options':
+				$c->registration->show_pending_payment_options = ($value == 'Y');
+				break;
+			case 'display_address_in_regform':
+				$c->template_settings->display_address_in_regform = ($value == 'Y');
+				break;
+			case 'default_logo_url':
+				$c->organization->logo_url = $value;
+				break;
+			case 'event_page_id':
+				// also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
+				// to ESPRESSO_THANK_YOU
+				$reg_page_post = get_post($value);
+				$reg_page_post->post_content = str_replace("[ESPRESSO_EVENTS]", "[ESPRESSO_CHECKOUT]", $reg_page_post->post_content);
+				wp_update_post($reg_page_post);
+				$c->core->reg_page_id = $value;
+				break;
+			case 'return_url':
+				// also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
+				// to ESPRESSO_THANK_YOU
+				$thank_you_page_post = get_post($value);
+				$thank_you_page_post->post_content = str_replace("[ESPRESSO_PAYMENTS]", "[ESPRESSO_THANK_YOU]", $thank_you_page_post->post_content);
+				wp_update_post($thank_you_page_post);
+				$c->core->thank_you_page_id = $value;
+				break;
+			case 'cancel_return':
+				$c->core->cancel_page_id = $value;
 
-                break;
-            case 'notify_url':
-                $c->core->txn_page_id = $value;
-                break;
-            case 'use_captcha':
-                $c->registration->use_captcha = ($value == 'Y');
-                break;
-            case 'recaptcha_publickey':
-                $c->registration->recaptcha_publickey = $value;
-                break;
-            case 'recaptcha_privatekey':
-                $c->registration->recaptcha_privatekey = $value;
-                break;
-            case 'recaptcha_theme':
-                $c->registration->recaptcha_theme = $value;
-                break;
-            case 'recaptcha_width':
-                $c->registration->recaptcha_width = $value;
-                break;
-            case 'recaptcha_language':
-                $c->registration->recaptcha_language = $value;
-                break;
-            case 'espresso_dashboard_widget':
-                $c->admin->use_dashboard_widget = ($value == 'Y');
-                break;
-            case 'use_personnel_manager':
-                $c->admin->use_personnel_manager = ($value == 'Y');
-                break;
-            case 'use_event_timezones':
-                $c->admin->use_event_timezones = ($value == 'Y');
-                break;
-            case 'affiliate_id':
-                $c->admin->affiliate_id = $value;
-                break;
-            case 'site_license_key':
-                $cn->core->site_license_key = $value;
-                break;
-            default:
-                do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value);
-        }
-    }
+				break;
+			case 'notify_url':
+				$c->core->txn_page_id = $value;
+				break;
+			case 'use_captcha':
+				$c->registration->use_captcha = ($value == 'Y');
+				break;
+			case 'recaptcha_publickey':
+				$c->registration->recaptcha_publickey = $value;
+				break;
+			case 'recaptcha_privatekey':
+				$c->registration->recaptcha_privatekey = $value;
+				break;
+			case 'recaptcha_theme':
+				$c->registration->recaptcha_theme = $value;
+				break;
+			case 'recaptcha_width':
+				$c->registration->recaptcha_width = $value;
+				break;
+			case 'recaptcha_language':
+				$c->registration->recaptcha_language = $value;
+				break;
+			case 'espresso_dashboard_widget':
+				$c->admin->use_dashboard_widget = ($value == 'Y');
+				break;
+			case 'use_personnel_manager':
+				$c->admin->use_personnel_manager = ($value == 'Y');
+				break;
+			case 'use_event_timezones':
+				$c->admin->use_event_timezones = ($value == 'Y');
+				break;
+			case 'affiliate_id':
+				$c->admin->affiliate_id = $value;
+				break;
+			case 'site_license_key':
+				$cn->core->site_license_key = $value;
+				break;
+			default:
+				do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value);
+		}
+	}
 
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_global_surcharge_price($org_options)
-    {
-        $amount = floatval($org_options['surcharge']);
-        // dont createa a price if the surcharge is 0
-        if ($amount <=.01) {
-            return 0;
-        }
-        if ($org_options['surcharge_type'] == 'flat_rate') {
-            $price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge;
-        } else {
-            $price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge;
-        }
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>$price_type,
-            'PRC_amount'=>$amount,
-            'PRC_name'=>  $org_options['surcharge_text'],
-            'PRC_is_default'=>true,
-            'PRC_overrides'=>false,
-            'PRC_order'=>100,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_global_surcharge_price($org_options)
+	{
+		$amount = floatval($org_options['surcharge']);
+		// dont createa a price if the surcharge is 0
+		if ($amount <=.01) {
+			return 0;
+		}
+		if ($org_options['surcharge_type'] == 'flat_rate') {
+			$price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge;
+		} else {
+			$price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge;
+		}
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>$price_type,
+			'PRC_amount'=>$amount,
+			'PRC_name'=>  $org_options['surcharge_text'],
+			'PRC_is_default'=>true,
+			'PRC_overrides'=>false,
+			'PRC_order'=>100,
+			'PRC_deleted'=>false,
+			'PRC_parent'=>null
 
-        );
-        $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        );
-        $price_table = $wpdb->prefix."esp_price";
-        $success = $wpdb->insert($price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion(
-                'org_options',
-                array(
-                        'surcharge'=>$org_options['surcharge'],
-                        'surcharge_type'=>$org_options['surcharge_type'],
-                        'surcharge_text'=>$org_options['surcharge_text']),
-                $price_table,
-                $cols_n_values,
-                $datatypes
-            ));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		);
+		$datatypes = array(
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		);
+		$price_table = $wpdb->prefix."esp_price";
+		$success = $wpdb->insert($price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion(
+				'org_options',
+				array(
+						'surcharge'=>$org_options['surcharge'],
+						'surcharge_type'=>$org_options['surcharge_type'],
+						'surcharge_text'=>$org_options['surcharge_text']),
+				$price_table,
+				$cols_n_values,
+				$datatypes
+			));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    protected $_org_options_we_know_how_to_migrate = array(
-      'organization',
-      'organization_street1',
-      'organization_street2',
-      'organization_city',
-      'organization_state',
-      'organization_zip',
-      'contact_email',
-      'default_mail',
-      'payment_subject',
-      'payment_message',
-      'message',
-      'default_payment_status',
-      'surcharge',// unused?
-      'country_id',// unused?
-      'organization_country',
+	protected $_org_options_we_know_how_to_migrate = array(
+	  'organization',
+	  'organization_street1',
+	  'organization_street2',
+	  'organization_city',
+	  'organization_state',
+	  'organization_zip',
+	  'contact_email',
+	  'default_mail',
+	  'payment_subject',
+	  'payment_message',
+	  'message',
+	  'default_payment_status',
+	  'surcharge',// unused?
+	  'country_id',// unused?
+	  'organization_country',
 //    'currency_symbol',
-      'expire_on_registration_end',
-      'email_before_payment',
-      'email_fancy_headers',
-      'enable_default_style',
-      'event_ssl_active',
-      'selected_style',
-      'show_pending_payment_options',
-      'show_reg_footer',
-      'skip_confirmation_page',
-      'allow_mer_discounts',// no equiv
-      'allow_mer_vouchers',// no equiv
-      'display_short_description_in_event_list',
-      'display_description_on_multi_reg_page',
-      'display_address_in_event_list',
-      'display_address_in_regform',
-      'use_custom_post_types',// no equiv
-      'display_ical_download',
-      'display_featured_image',
-      'themeroller',
-      'default_logo_url',
-      'event_page_id',
-      'return_url',
-      'cancel_return',
-      'notify_url',
-      'events_in_dashboard',
-      'use_captcha',
-      'recaptcha_publickey',
-      'recaptcha_privatekey',
-      'recaptcha_theme',
-      'recaptcha_width',
-      'recaptcha_language',
-      'espresso_dashboard_widget',
-      'time_reg_limit',
+	  'expire_on_registration_end',
+	  'email_before_payment',
+	  'email_fancy_headers',
+	  'enable_default_style',
+	  'event_ssl_active',
+	  'selected_style',
+	  'show_pending_payment_options',
+	  'show_reg_footer',
+	  'skip_confirmation_page',
+	  'allow_mer_discounts',// no equiv
+	  'allow_mer_vouchers',// no equiv
+	  'display_short_description_in_event_list',
+	  'display_description_on_multi_reg_page',
+	  'display_address_in_event_list',
+	  'display_address_in_regform',
+	  'use_custom_post_types',// no equiv
+	  'display_ical_download',
+	  'display_featured_image',
+	  'themeroller',
+	  'default_logo_url',
+	  'event_page_id',
+	  'return_url',
+	  'cancel_return',
+	  'notify_url',
+	  'events_in_dashboard',
+	  'use_captcha',
+	  'recaptcha_publickey',
+	  'recaptcha_privatekey',
+	  'recaptcha_theme',
+	  'recaptcha_width',
+	  'recaptcha_language',
+	  'espresso_dashboard_widget',
+	  'time_reg_limit',
 //    'use_attendee_pre_approval', removed in 4.1- instead this is factored into the default reg status
-      'use_personnel_manager',// no equiv
-      'use_event_timezones',
-      'full_logging',
-      'surcharge_type',// unused
-      'surcharge_text',// unused
-      'affiliate_id',
-      'site_license_key',
-    );
+	  'use_personnel_manager',// no equiv
+	  'use_event_timezones',
+	  'full_logging',
+	  'surcharge_type',// unused
+	  'surcharge_text',// unused
+	  'affiliate_id',
+	  'site_license_key',
+	);
 }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_prices.dmsstage.php

Doc Comments +3 added lines, -4 removed lines

@@ -349,8 +349,8 @@ 
     /**
      * Adds a join between a ticket and a price
      * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
+     * @param integer $new_ticket_id
+     * @param integer $new_price_id
      * @return int
      */
     private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
@@ -376,8 +376,7 @@ 
     /**
      * Adds a join between a ticket and a datetime
      * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
+     * @param integer $new_ticket_id
      * @return int
      */
     private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)

Indentation +292 added lines, -292 removed lines

@@ -87,57 +87,57 @@ 
  */
 class EE_DMS_4_1_0_prices extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_price_table;
-    private $_new_ticket_table;
-    private $_new_ticket_price_table;
-    private $_new_datetime_ticket_table;
-    /**
-     * A count of all the different tickets created, used for setting the new ones' TKT_Order
-     * @var int
-     */
-    private $_ticket_count = 0;
-    const price_type_base = 1;
-    const price_type_member_discount = 3;
-    const price_type_percent_surcharge = 4;
-    const price_type_flat_surcharge = 5;
+	private $_new_price_table;
+	private $_new_ticket_table;
+	private $_new_ticket_price_table;
+	private $_new_datetime_ticket_table;
+	/**
+	 * A count of all the different tickets created, used for setting the new ones' TKT_Order
+	 * @var int
+	 */
+	private $_ticket_count = 0;
+	const price_type_base = 1;
+	const price_type_member_discount = 3;
+	const price_type_percent_surcharge = 4;
+	const price_type_flat_surcharge = 5;
 
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Prices", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_prices";
-        $this->select_expression = 'p.*, e.event_status';
-        $this->_extra_where_sql = ' AS p 
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Prices", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_prices";
+		$this->select_expression = 'p.*, e.event_status';
+		$this->_extra_where_sql = ' AS p 
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON p.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_new_price_table = $wpdb->prefix."esp_price";
-        $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
-        $this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
-        $this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // create the base price
-        $new_price_id = $this->_insert_new_price($old_row);
-        // create the member discount if there is any
-        // commented-out because we may actually NOT be supporting this in 4.1
+		$this->_new_price_table = $wpdb->prefix."esp_price";
+		$this->_new_ticket_table = $wpdb->prefix."esp_ticket";
+		$this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
+		$this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// create the base price
+		$new_price_id = $this->_insert_new_price($old_row);
+		// create the member discount if there is any
+		// commented-out because we may actually NOT be supporting this in 4.1
 //      if($old_row['event_cost'] != $old_row['member_price']){
 //          $member_price_discount_id = $this->_insert_new_member_price($old_row);
 //      }else{
 //          $member_price_discount_id = 0;
 //      }
-        // create the surcharge if there is any
-        if (floatval($old_row['surcharge']) >= 0.01) {
-            $surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
-        } else {
-            $surcharge_price_id = 0;
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
-        }
-        // associate the ticket to all datetimes for event (ie, this ONE ticket grants access to ALL datetimes, not just one of the attendee's choice.
-        // if the latter were the case, then we'd create a separate ticket for each datetime and ahve their association be one-to-one)
-        // create ticket
+		// create the surcharge if there is any
+		if (floatval($old_row['surcharge']) >= 0.01) {
+			$surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
+		} else {
+			$surcharge_price_id = 0;
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
+		}
+		// associate the ticket to all datetimes for event (ie, this ONE ticket grants access to ALL datetimes, not just one of the attendee's choice.
+		// if the latter were the case, then we'd create a separate ticket for each datetime and ahve their association be one-to-one)
+		// create ticket
 //      $ticket_id = $this->_insert_new_ticket($old_row);
 //      if($ticket_id){
 //          $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $ticket_id);
@@ -149,62 +149,62 @@ 
 //              $this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
 //          }
 //      }
-        // create a ticket for each old price -old datetime combo
-        $tickets_for_old_price = array();
-        foreach ($this->_get_datetime_ids_for_old_event_id($old_row['event_id']) as $new_datetime_id) {
-            $ticket_id = $this->_insert_new_ticket($old_row);
-            $tickets_for_old_price[] = $ticket_id;
-            // associate to old prices
-            $this->_insert_ticket_price_relation($ticket_id, $new_price_id);
-            $this->_insert_ticket_price_relation($ticket_id, $surcharge_price_id);
-            $this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $tickets_for_old_price);
-    }
-    /**
-     * Creates a 4.1 price base type
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_price($old_price)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>self::price_type_base,
-            'PRC_amount'=>floatval($old_price['event_cost']),
-            'PRC_name'=>$old_price['price_type'],
-            'PRC_is_default'=>false,
-            'PRC_overrides'=>false,
-            'PRC_order'=>0,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+		// create a ticket for each old price -old datetime combo
+		$tickets_for_old_price = array();
+		foreach ($this->_get_datetime_ids_for_old_event_id($old_row['event_id']) as $new_datetime_id) {
+			$ticket_id = $this->_insert_new_ticket($old_row);
+			$tickets_for_old_price[] = $ticket_id;
+			// associate to old prices
+			$this->_insert_ticket_price_relation($ticket_id, $new_price_id);
+			$this->_insert_ticket_price_relation($ticket_id, $surcharge_price_id);
+			$this->_insert_datetime_ticket_relation($new_datetime_id, $ticket_id);
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_ticket_table, $tickets_for_old_price);
+	}
+	/**
+	 * Creates a 4.1 price base type
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_price($old_price)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>self::price_type_base,
+			'PRC_amount'=>floatval($old_price['event_cost']),
+			'PRC_name'=>$old_price['price_type'],
+			'PRC_is_default'=>false,
+			'PRC_overrides'=>false,
+			'PRC_order'=>0,
+			'PRC_deleted'=>false,
+			'PRC_parent'=>null
 
-        );
-        $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        );
-        $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
+		);
+		$datatypes = array(
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		);
+		$success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
 //  private function _insert_new_member_price($old_price){
 //      $discount_amount = floatval($old_price['event_cost']) - floatval($old_price['member_price']);
 //      global $wpdb;
@@ -237,207 +237,207 @@ 
 //      $new_id = $wpdb->insert_id;
 //      return $new_id;
 //  }
-    /**
-     * Creates a 4.1 member price discount
-     * @global type $wpdb
-     * @param type $old_price
-     * @return int
-     */
-    private function _insert_new_surcharge_price($old_price)
-    {
+	/**
+	 * Creates a 4.1 member price discount
+	 * @global type $wpdb
+	 * @param type $old_price
+	 * @return int
+	 */
+	private function _insert_new_surcharge_price($old_price)
+	{
 
-        if ($old_price['surcharge_type'] == 'flat_rate') {
-            $price_type = self::price_type_flat_surcharge;
-        } else {
-            $price_type = self::price_type_percent_surcharge;
-        }
-        global $wpdb;
-        $cols_n_values = array(
-            'PRT_ID'=>$price_type,
-            'PRC_amount'=>floatval($old_price['surcharge']),
-            'PRC_name'=>  __("Surcharge", "event_espresso"),
-            'PRC_is_default'=>false,
-            'PRC_overrides'=>false,
-            'PRC_order'=>20,
-            'PRC_deleted'=>false,
-            'PRC_parent'=>null
+		if ($old_price['surcharge_type'] == 'flat_rate') {
+			$price_type = self::price_type_flat_surcharge;
+		} else {
+			$price_type = self::price_type_percent_surcharge;
+		}
+		global $wpdb;
+		$cols_n_values = array(
+			'PRT_ID'=>$price_type,
+			'PRC_amount'=>floatval($old_price['surcharge']),
+			'PRC_name'=>  __("Surcharge", "event_espresso"),
+			'PRC_is_default'=>false,
+			'PRC_overrides'=>false,
+			'PRC_order'=>20,
+			'PRC_deleted'=>false,
+			'PRC_parent'=>null
 
-        );
-        $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        );
-        $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
-    /**
-     * Inserts a 4.1 ticket based off the 3.1 price, and the price IDs we've already made from the 3.1 price
-     * @param $old_price_row array where keys are columns
-     * @param $new_base_price_id int
-     * @param $new_member_discount_id int
-     * @param $new_surcharge_id int
-     * @return int new ticket id
-     */
-    private function _insert_new_ticket($old_price_row)
-    {
-        global $wpdb;
-        $event_row = $this->_get_event_row($old_price_row['event_id']);
-        if ($old_price_row['surcharge_type'] == 'flat_rate') {
-            $final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
-        } else {// percent surcharge
-            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
-        }
-        $start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
-        $start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
-        $end_date = $event_row['registration_end']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_endT']);
-        $end_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $end_date, $event_row['timezone_string']);
-        $cols_n_values = array(
-            'TTM_ID'=>0,
-            'TKT_name'=>$old_price_row['price_type'],
-            'TKT_description'=>'',
-            'TKT_start_date'=>$start_date_utc,
-            'TKT_end_date'=>$end_date_utc,
-            'TKT_min'=>0,
-            'TKT_max'=>-1,
-            'TKT_price'=>$final_ticket_price,
-            'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
-            'TKT_qty'=> -1,
-            'TKT_uses'=> 1,
-            'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
-            'TKT_is_default'=>false,
-            'TKT_order'=>$this->_get_ticket_count(),
-            'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
-            'TKT_deleted'=>false,
-            'TKT_parent'=>0
+		);
+		$datatypes = array(
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		);
+		$success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
+	/**
+	 * Inserts a 4.1 ticket based off the 3.1 price, and the price IDs we've already made from the 3.1 price
+	 * @param $old_price_row array where keys are columns
+	 * @param $new_base_price_id int
+	 * @param $new_member_discount_id int
+	 * @param $new_surcharge_id int
+	 * @return int new ticket id
+	 */
+	private function _insert_new_ticket($old_price_row)
+	{
+		global $wpdb;
+		$event_row = $this->_get_event_row($old_price_row['event_id']);
+		if ($old_price_row['surcharge_type'] == 'flat_rate') {
+			$final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
+		} else {// percent surcharge
+			$final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
+		}
+		$start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
+		$start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
+		$end_date = $event_row['registration_end']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_endT']);
+		$end_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $end_date, $event_row['timezone_string']);
+		$cols_n_values = array(
+			'TTM_ID'=>0,
+			'TKT_name'=>$old_price_row['price_type'],
+			'TKT_description'=>'',
+			'TKT_start_date'=>$start_date_utc,
+			'TKT_end_date'=>$end_date_utc,
+			'TKT_min'=>0,
+			'TKT_max'=>-1,
+			'TKT_price'=>$final_ticket_price,
+			'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
+			'TKT_qty'=> -1,
+			'TKT_uses'=> 1,
+			'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
+			'TKT_is_default'=>false,
+			'TKT_order'=>$this->_get_ticket_count(),
+			'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
+			'TKT_deleted'=>false,
+			'TKT_parent'=>0
 
-        );
-        $datatypes = array(
-            '%d',// TTM_ID
-            '%s',// TKT_name
-            '%s',// TKT_description
-            '%s',// TKT_start_date
-            '%s',// TKT_end_date
-            '%d',// TKT_min
-            '%d',// TKT_max
-            '%f',// TKT_price
-            '%d',// TKT_sold
-            '%d',// TKT_qty
-            '%d',// TKT_uses
-            '%d',// TKT_taxable
-            '%d',// TKT_is_default
-            '%d',// TKT_order
-            '%d',// TKT_row
-            '%d',// TKT_deleted
-            '%d',// TKT_parent
-        );
-        $success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		);
+		$datatypes = array(
+			'%d',// TTM_ID
+			'%s',// TKT_name
+			'%s',// TKT_description
+			'%s',// TKT_start_date
+			'%s',// TKT_end_date
+			'%d',// TKT_min
+			'%d',// TKT_max
+			'%f',// TKT_price
+			'%d',// TKT_sold
+			'%d',// TKT_qty
+			'%d',// TKT_uses
+			'%d',// TKT_taxable
+			'%d',// TKT_is_default
+			'%d',// TKT_order
+			'%d',// TKT_row
+			'%d',// TKT_deleted
+			'%d',// TKT_parent
+		);
+		$success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Adds a join between a ticket and a price
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
-     * @return int
-     */
-    private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'TKT_ID'=>$new_ticket_id,
-            'PRC_ID'=>$new_price_id,
-        );
-        $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// PRC_ID
-        );
-        $success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	/**
+	 * Adds a join between a ticket and a price
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @param type $new_price_id
+	 * @return int
+	 */
+	private function _insert_ticket_price_relation($new_ticket_id, $new_price_id)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'TKT_ID'=>$new_ticket_id,
+			'PRC_ID'=>$new_price_id,
+		);
+		$datatypes = array(
+			'%d',// TKT_ID
+			'%d',// PRC_ID
+		);
+		$success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Adds a join between a ticket and a datetime
-     * @global type $wpdb
-     * @param type $new_ticket_id
-     * @param type $new_price_id
-     * @return int
-     */
-    private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'TKT_ID'=>$new_ticket_id,
-            'DTT_ID'=>$new_datetime_id,
-        );
-        $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// DTT_ID
-        );
-        $success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	/**
+	 * Adds a join between a ticket and a datetime
+	 * @global type $wpdb
+	 * @param type $new_ticket_id
+	 * @param type $new_price_id
+	 * @return int
+	 */
+	private function _insert_datetime_ticket_relation($new_datetime_id, $new_ticket_id)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'TKT_ID'=>$new_ticket_id,
+			'DTT_ID'=>$new_datetime_id,
+		);
+		$datatypes = array(
+			'%d',// TKT_ID
+			'%d',// DTT_ID
+		);
+		$success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Simply gets the 3.1 event row data
-     * @global type $wpdb
-     * @param type $event_id
-     * @return array
-     */
-    private function _get_event_row($event_id)
-    {
-        global $wpdb;
-        $old_event_table = $wpdb->prefix."events_detail";
-        return $wpdb->get_row($wpdb->prepare("SELECT * FROM $old_event_table WHERE id=%d", $event_id), ARRAY_A);
-    }
-    /**
-     * Gets a higher ticket count than last time it was called (and is persisted between HTTP requests).
-     * Yes we COULD run a query joining events->datetimes->ticket_datetimes->tickets, but this should work fine too
-     * @return int
-     */
-    private function _get_ticket_count()
-    {
-        return $this->_ticket_count++;
-    }
+	/**
+	 * Simply gets the 3.1 event row data
+	 * @global type $wpdb
+	 * @param type $event_id
+	 * @return array
+	 */
+	private function _get_event_row($event_id)
+	{
+		global $wpdb;
+		$old_event_table = $wpdb->prefix."events_detail";
+		return $wpdb->get_row($wpdb->prepare("SELECT * FROM $old_event_table WHERE id=%d", $event_id), ARRAY_A);
+	}
+	/**
+	 * Gets a higher ticket count than last time it was called (and is persisted between HTTP requests).
+	 * Yes we COULD run a query joining events->datetimes->ticket_datetimes->tickets, but this should work fine too
+	 * @return int
+	 */
+	private function _get_ticket_count()
+	{
+		return $this->_ticket_count++;
+	}
 
-    /**
-     * Using the 3.1 event id, gets the 4.1 datetimes for it
-     * @param int $old_event_id
-     * @return array where values are datetime ids
-     */
-    private function _get_datetime_ids_for_old_event_id($old_event_id)
-    {
-        global $wpdb;
-        $new_cpt_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_id, $wpdb->posts);
-        $datetime_ids = $wpdb->get_col($wpdb->prepare("SELECT DTT_ID FROM {$wpdb->prefix}esp_datetime WHERE EVT_ID=%d", $new_cpt_id));
-        return $datetime_ids;
-    }
+	/**
+	 * Using the 3.1 event id, gets the 4.1 datetimes for it
+	 * @param int $old_event_id
+	 * @return array where values are datetime ids
+	 */
+	private function _get_datetime_ids_for_old_event_id($old_event_id)
+	{
+		global $wpdb;
+		$new_cpt_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_detail", $old_event_id, $wpdb->posts);
+		$datetime_ids = $wpdb->get_col($wpdb->prepare("SELECT DTT_ID FROM {$wpdb->prefix}esp_datetime WHERE EVT_ID=%d", $new_cpt_id));
+		return $datetime_ids;
+	}
 }
 // @todo: tell users that in 3.1 the limit was on registration PER event,in 4.1 it's limit PER TICKET... SO, if they sell 2 different types of tickets
 //

Spacing +50 added lines, -50 removed lines

@@ -108,7 +108,7 @@ 
         $this->_old_table = $wpdb->prefix."events_prices";
         $this->select_expression = 'p.*, e.event_status';
         $this->_extra_where_sql = ' AS p 
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON p.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON p.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_new_price_table = $wpdb->prefix."esp_price";
         $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
@@ -130,7 +130,7 @@ 
         // create the surcharge if there is any
         if (floatval($old_row['surcharge']) >= 0.01) {
             $surcharge_price_id = $this->_insert_new_surcharge_price($old_row);
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id,$surcharge_price_id));
+            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id, $surcharge_price_id));
         } else {
             $surcharge_price_id = 0;
             $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_price_table, array($new_price_id));
@@ -182,17 +182,17 @@ 
 
         );
         $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
+            '%d', // PRT_ID
+            '%f', // PRT_amount
+            '%s', // PRC_name
+            '%d', // PRC_is_default
+            '%d', // PRC_overrides
+            '%d', // PRC_order
+            '%d', // PRC_deleted
+            '%d', // PRC_parent
         );
         $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -264,17 +264,17 @@ 
 
         );
         $datatypes = array(
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
+            '%d', // PRT_ID
+            '%f', // PRT_amount
+            '%s', // PRC_name
+            '%d', // PRC_is_default
+            '%d', // PRC_overrides
+            '%d', // PRC_order
+            '%d', // PRC_deleted
+            '%d', // PRC_parent
         );
         $success = $wpdb->insert($this->_new_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price, $this->_new_price_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -296,7 +296,7 @@ 
         if ($old_price_row['surcharge_type'] == 'flat_rate') {
             $final_ticket_price = floatval($old_price_row['event_cost']) + floatval($old_price_row['surcharge']);
         } else {// percent surcharge
-            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge'])/100);
+            $final_ticket_price = floatval($old_price_row['event_cost']) * (1 + floatval($old_price_row['surcharge']) / 100);
         }
         $start_date = $event_row['registration_start']." ".$this->get_migration_script()->convertTimeFromAMPM($event_row['registration_startT']);
         $start_date_utc = $this->get_migration_script()->convert_date_string_to_utc($this, $old_price_row, $start_date, $event_row['timezone_string']);
@@ -311,38 +311,38 @@ 
             'TKT_min'=>0,
             'TKT_max'=>-1,
             'TKT_price'=>$final_ticket_price,
-            'TKT_sold'=> 0,// note: this will get calculated as we actually add registrations during the migration
+            'TKT_sold'=> 0, // note: this will get calculated as we actually add registrations during the migration
             'TKT_qty'=> -1,
             'TKT_uses'=> 1,
-            'TKT_taxable'=>false,// so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
+            'TKT_taxable'=>false, // so by default, old prices are NOT taxable. This way they don't suddenly have a sudden spike in prices
             'TKT_is_default'=>false,
             'TKT_order'=>$this->_get_ticket_count(),
-            'TKT_row'=>0,// doesn't matter because UI reset this on first save anyways
+            'TKT_row'=>0, // doesn't matter because UI reset this on first save anyways
             'TKT_deleted'=>false,
             'TKT_parent'=>0
 
         );
         $datatypes = array(
-            '%d',// TTM_ID
-            '%s',// TKT_name
-            '%s',// TKT_description
-            '%s',// TKT_start_date
-            '%s',// TKT_end_date
-            '%d',// TKT_min
-            '%d',// TKT_max
-            '%f',// TKT_price
-            '%d',// TKT_sold
-            '%d',// TKT_qty
-            '%d',// TKT_uses
-            '%d',// TKT_taxable
-            '%d',// TKT_is_default
-            '%d',// TKT_order
-            '%d',// TKT_row
-            '%d',// TKT_deleted
-            '%d',// TKT_parent
+            '%d', // TTM_ID
+            '%s', // TKT_name
+            '%s', // TKT_description
+            '%s', // TKT_start_date
+            '%s', // TKT_end_date
+            '%d', // TKT_min
+            '%d', // TKT_max
+            '%f', // TKT_price
+            '%d', // TKT_sold
+            '%d', // TKT_qty
+            '%d', // TKT_uses
+            '%d', // TKT_taxable
+            '%d', // TKT_is_default
+            '%d', // TKT_order
+            '%d', // TKT_row
+            '%d', // TKT_deleted
+            '%d', // TKT_parent
         );
         $success = $wpdb->insert($this->_new_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_price_row, $this->_new_ticket_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -365,12 +365,12 @@ 
             'PRC_ID'=>$new_price_id,
         );
         $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// PRC_ID
+            '%d', // TKT_ID
+            '%d', // PRC_ID
         );
         $success = $wpdb->insert($this->_new_ticket_price_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
+        if ( ! $success) {
+            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id, 'price id'=>$new_price_id), $this->_new_ticket_price_table, $cols_n_values, $datatypes));
             return 0;
         }
         $new_id = $wpdb->insert_id;
@@ -392,12 +392,12 @@ 
             'DTT_ID'=>$new_datetime_id,
         );
         $datatypes = array(
-            '%d',// TKT_ID
-            '%d',// DTT_ID
+            '%d', // TKT_ID
+            '%d', // DTT_ID
         );
         $success = $wpdb->insert($this->_new_datetime_ticket_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id,'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
+        if ( ! $success) {
+            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, array('ticket id'=>$new_ticket_id, 'datetime id'=>$new_datetime_id), $this->_new_datetime_ticket_table, $cols_n_values, $datatypes));
             return 0;
         }
         $new_id = $wpdb->insert_id;

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_question_group_question.dmsstage.php

Doc Comments +1 added lines, -1 removed lines

@@ -130,7 +130,7 @@
      * being address info, and 0 being neither)
      * @global type $wpdb
      * @param type $new_question_group_id
-     * @return boolean
+     * @return integer
      */
     private function _is_system_question_group($new_question_group_id)
     {

Indentation +105 added lines, -107 removed lines

@@ -12,8 +12,6 @@ 
   KEY `group_id` (`group_id`),
   KEY `question_id` (`question_id`)
 ) ENGINE=InnoDB AUTO_INCREMENT=19 DEFAULT CHARSET=utf8$$
-
-
  * 4.1 question group question model's tables and fields:
  $this->_tables = array(
             'Question_Group_Question'=>new EE_Primary_Table('esp_question_group_question','QGQ_ID')
@@ -29,113 +27,113 @@ 
  */
 class EE_DMS_4_1_0_question_group_question extends EE_Data_Migration_Script_Stage
 {
-    private $_old_table;
-    private $_new_table;
-    public function _migration_step($num_items = 50)
-    {
+	private $_old_table;
+	private $_new_table;
+	public function _migration_step($num_items = 50)
+	{
         
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
-        $items_actually_migrated = 0;
-        foreach ($rows as $question_group_question) {
-            $this->_insert_new_question_group_question($question_group_question);
-            $items_actually_migrated++;
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
-        return $count;
-    }
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_qst_group_rel";
-        $this->_new_table = $wpdb->prefix."esp_question_group_question";
-        $this->_pretty_name = __("Question Group to Question Relations", "event_espresso");
-        parent::__construct();
-    }
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM $this->_old_table LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
+		$items_actually_migrated = 0;
+		foreach ($rows as $question_group_question) {
+			$this->_insert_new_question_group_question($question_group_question);
+			$items_actually_migrated++;
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
+		return $count;
+	}
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_qst_group_rel";
+		$this->_new_table = $wpdb->prefix."esp_question_group_question";
+		$this->_pretty_name = __("Question Group to Question Relations", "event_espresso");
+		parent::__construct();
+	}
     
-    /**
-     * Attempts to insert a new question group inthe new format given an old one
-     * @global type $wpdb
-     * @param array $old_question_group_question
-     * @return int
-     */
-    private function _insert_new_question_group_question($old_question_group_question)
-    {
-        global $wpdb;
-        $new_question_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_question", $old_question_group_question['question_id'], $wpdb->prefix."esp_question");
-        $new_question_group_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_qst_group", $old_question_group_question['group_id'], $wpdb->prefix."esp_question_group");
-        if (! $new_question_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 question id for 3.1 question #%d.", "event_espresso"), $old_question_group_question['question_id']));
-            return 0;
-        }
-        if (! $new_question_group_id) {
-            $this->add_error(sprintf(__("Could not find 4.1 question group id for 3.1 question group #%d.", "event_espresso"), $old_question_group_question['group_id']));
-            return 0;
-        }
-        // if it's a system question, it needs to be in the right system group. otherwise no dice!
-        if (($this->_is_system_question_group($new_question_group_id) == $this->_is_system_question_for_question_group($new_question_id) )
-                ||
-                ! $this->_is_system_question_for_question_group($new_question_id)
-            ) {
-            $cols_n_values = array(
-                'QSG_ID'=>$new_question_group_id,
-                'QST_ID'=>$new_question_id
-            );
-            $datatypes = array(
-                '%d',// QSG_ID
-                '%d',// QST_ID
-            );
-            $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_question_group_question, $this->_new_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            return $wpdb->insert_id;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Attempts to insert a new question group inthe new format given an old one
+	 * @global type $wpdb
+	 * @param array $old_question_group_question
+	 * @return int
+	 */
+	private function _insert_new_question_group_question($old_question_group_question)
+	{
+		global $wpdb;
+		$new_question_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_question", $old_question_group_question['question_id'], $wpdb->prefix."esp_question");
+		$new_question_group_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_qst_group", $old_question_group_question['group_id'], $wpdb->prefix."esp_question_group");
+		if (! $new_question_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 question id for 3.1 question #%d.", "event_espresso"), $old_question_group_question['question_id']));
+			return 0;
+		}
+		if (! $new_question_group_id) {
+			$this->add_error(sprintf(__("Could not find 4.1 question group id for 3.1 question group #%d.", "event_espresso"), $old_question_group_question['group_id']));
+			return 0;
+		}
+		// if it's a system question, it needs to be in the right system group. otherwise no dice!
+		if (($this->_is_system_question_group($new_question_group_id) == $this->_is_system_question_for_question_group($new_question_id) )
+				||
+				! $this->_is_system_question_for_question_group($new_question_id)
+			) {
+			$cols_n_values = array(
+				'QSG_ID'=>$new_question_group_id,
+				'QST_ID'=>$new_question_id
+			);
+			$datatypes = array(
+				'%d',// QSG_ID
+				'%d',// QST_ID
+			);
+			$success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_question_group_question, $this->_new_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			return $wpdb->insert_id;
+		} else {
+			return false;
+		}
+	}
     
-    /**
-     * If this question is a system question, returns the QSG_system number that
-     * indicates the question group its permitted in.
-     * @global type $wpdb
-     * @param type $new_question_id
-     * @return int
-     */
-    private function _is_system_question_for_question_group($new_question_id)
-    {
-        global $wpdb;
-        $system_id = $wpdb->get_var($wpdb->prepare("SELECT QST_system FROM ".$wpdb->prefix."esp_question WHERE QST_ID=%d", $new_question_id));
-        if (in_array($system_id, array('fname','lname','email'))) {
-            return 1;
-        } elseif ($system_id!='' && $system_id) {
-            return 2;
-        } else {
-            return 0;
-        }
-    }
+	/**
+	 * If this question is a system question, returns the QSG_system number that
+	 * indicates the question group its permitted in.
+	 * @global type $wpdb
+	 * @param type $new_question_id
+	 * @return int
+	 */
+	private function _is_system_question_for_question_group($new_question_id)
+	{
+		global $wpdb;
+		$system_id = $wpdb->get_var($wpdb->prepare("SELECT QST_system FROM ".$wpdb->prefix."esp_question WHERE QST_ID=%d", $new_question_id));
+		if (in_array($system_id, array('fname','lname','email'))) {
+			return 1;
+		} elseif ($system_id!='' && $system_id) {
+			return 2;
+		} else {
+			return 0;
+		}
+	}
     
-    /**
-     * Returns the questino group's QSG_system value (1 meaning personal info, 2
-     * being address info, and 0 being neither)
-     * @global type $wpdb
-     * @param type $new_question_group_id
-     * @return boolean
-     */
-    private function _is_system_question_group($new_question_group_id)
-    {
-        global $wpdb;
-        $system_id = $wpdb->get_var($wpdb->prepare("SELECT QSG_system FROM ".$wpdb->prefix."esp_question_group WHERE QSG_ID=%d", $new_question_group_id));
-        return intval($system_id);
-    }
+	/**
+	 * Returns the questino group's QSG_system value (1 meaning personal info, 2
+	 * being address info, and 0 being neither)
+	 * @global type $wpdb
+	 * @param type $new_question_group_id
+	 * @return boolean
+	 */
+	private function _is_system_question_group($new_question_group_id)
+	{
+		global $wpdb;
+		$system_id = $wpdb->get_var($wpdb->prepare("SELECT QSG_system FROM ".$wpdb->prefix."esp_question_group WHERE QSG_ID=%d", $new_question_group_id));
+		return intval($system_id);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -73,16 +73,16 @@ 
         global $wpdb;
         $new_question_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_question", $old_question_group_question['question_id'], $wpdb->prefix."esp_question");
         $new_question_group_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix."events_qst_group", $old_question_group_question['group_id'], $wpdb->prefix."esp_question_group");
-        if (! $new_question_id) {
+        if ( ! $new_question_id) {
             $this->add_error(sprintf(__("Could not find 4.1 question id for 3.1 question #%d.", "event_espresso"), $old_question_group_question['question_id']));
             return 0;
         }
-        if (! $new_question_group_id) {
+        if ( ! $new_question_group_id) {
             $this->add_error(sprintf(__("Could not find 4.1 question group id for 3.1 question group #%d.", "event_espresso"), $old_question_group_question['group_id']));
             return 0;
         }
         // if it's a system question, it needs to be in the right system group. otherwise no dice!
-        if (($this->_is_system_question_group($new_question_group_id) == $this->_is_system_question_for_question_group($new_question_id) )
+        if (($this->_is_system_question_group($new_question_group_id) == $this->_is_system_question_for_question_group($new_question_id))
                 ||
                 ! $this->_is_system_question_for_question_group($new_question_id)
             ) {
@@ -91,11 +91,11 @@ 
                 'QST_ID'=>$new_question_id
             );
             $datatypes = array(
-                '%d',// QSG_ID
-                '%d',// QST_ID
+                '%d', // QSG_ID
+                '%d', // QST_ID
             );
             $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_question_group_question, $this->_new_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -116,9 +116,9 @@ 
     {
         global $wpdb;
         $system_id = $wpdb->get_var($wpdb->prepare("SELECT QST_system FROM ".$wpdb->prefix."esp_question WHERE QST_ID=%d", $new_question_id));
-        if (in_array($system_id, array('fname','lname','email'))) {
+        if (in_array($system_id, array('fname', 'lname', 'email'))) {
             return 1;
-        } elseif ($system_id!='' && $system_id) {
+        } elseif ($system_id != '' && $system_id) {
             return 2;
         } else {
             return 0;

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_venues.dmsstage.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 
     /**
      * Inserts into the venue_meta table
-     * @param type $cpt_id
+     * @param integer $cpt_id
      * @param type $old_venue
      * @return int
      */

Indentation +202 added lines, -202 removed lines

@@ -63,210 +63,210 @@
  */
 class EE_DMS_4_1_0_venues extends EE_Data_Migration_Script_Stage
 {
-    private $_old_table;
-    private $_new_table;
-    private $_new_meta_table;
-    public function _migration_step($num_items = 50)
-    {
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_old_table." LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
-        $items_actually_migrated = 0;
-        foreach ($rows as $old_venue) {
-            if (! $new_id = $this->_insert_into_posts($old_venue)) {
-                $items_actually_migrated++;
-                continue;
-            }
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_table, $new_id);
-            if (! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
-                $items_actually_migrated++;
-                continue;
-            }
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_meta_table, $new_meta_id);
-            // lastly, save the 'contact' as post meta, because it doesn't exist anywhere else but someone may still want it
-            $venue_meta = maybe_unserialize($old_venue['meta']);
-            if (isset($venue_meta['contact']) && $venue_meta['contact']) {
-                add_post_meta($new_id, 'contact', $venue_meta['contact']);
-            }
-            // is there an image on this venue?
-            $guid = isset($venue_meta['image']) && $venue_meta['image'] ? $venue_meta['image'] : null;
-            if ($guid) {
-                $this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
-            }
-            $items_actually_migrated++;
-            if ($guid) {
-                // if there was an image, we may have had to download it etc and it may have taken
-                // longer, then let's not bother migrating anymore on this step
-                break;
-            }
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
-        return $count;
-    }
-    public function __construct()
-    {
-        $this->_pretty_name = __("Venues", "event_espresso");
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_venue";
-        $this->_new_table = $wpdb->posts;
-        $this->_new_meta_table = $wpdb->prefix."esp_venue_meta";
-        parent::__construct();
-    }
+	private $_old_table;
+	private $_new_table;
+	private $_new_meta_table;
+	public function _migration_step($num_items = 50)
+	{
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_old_table." LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
+		$items_actually_migrated = 0;
+		foreach ($rows as $old_venue) {
+			if (! $new_id = $this->_insert_into_posts($old_venue)) {
+				$items_actually_migrated++;
+				continue;
+			}
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_table, $new_id);
+			if (! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
+				$items_actually_migrated++;
+				continue;
+			}
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_meta_table, $new_meta_id);
+			// lastly, save the 'contact' as post meta, because it doesn't exist anywhere else but someone may still want it
+			$venue_meta = maybe_unserialize($old_venue['meta']);
+			if (isset($venue_meta['contact']) && $venue_meta['contact']) {
+				add_post_meta($new_id, 'contact', $venue_meta['contact']);
+			}
+			// is there an image on this venue?
+			$guid = isset($venue_meta['image']) && $venue_meta['image'] ? $venue_meta['image'] : null;
+			if ($guid) {
+				$this->get_migration_script()->convert_image_url_to_attachment_and_attach_to_post($guid, $new_id, $this);
+			}
+			$items_actually_migrated++;
+			if ($guid) {
+				// if there was an image, we may have had to download it etc and it may have taken
+				// longer, then let's not bother migrating anymore on this step
+				break;
+			}
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
+		return $count;
+	}
+	public function __construct()
+	{
+		$this->_pretty_name = __("Venues", "event_espresso");
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_venue";
+		$this->_new_table = $wpdb->posts;
+		$this->_new_meta_table = $wpdb->prefix."esp_venue_meta";
+		parent::__construct();
+	}
 
-    /**
-     * Inserts the CPT
-     * @param array $old_venue keys are cols, values are col values
-     * @return int
-     */
-    private function _insert_into_posts($old_venue)
-    {
-        global $wpdb;
-        $meta = maybe_unserialize($old_venue['meta']);
-        $slug = $this->_find_unique_slug($old_venue['name'], $old_venue['identifier']);
-        $insertion_array = array(
-                    'post_title'=>stripslashes($old_venue['name']),// VNU_name
-                    'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '',// VNU_desc
-                    'post_name'=> $slug,// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
-                    'post_date_gmt'=>  current_time('mysql', true),
-                    'post_excerpt'=>'',// wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
-                    'post_modified_gmt'=>current_time('mysql', true),
-                    'post_author'=>$old_venue['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
-                    'post_type'=>'espresso_venues'// post_type
-                );
-        $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
-                    '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
-                    '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
-                );
-        $success = $wpdb->insert(
-            $this->_new_table,
-            $insertion_array,
-            $datatypes_array
-        );
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_table, $insertion_array, $datatypes_array));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+	/**
+	 * Inserts the CPT
+	 * @param array $old_venue keys are cols, values are col values
+	 * @return int
+	 */
+	private function _insert_into_posts($old_venue)
+	{
+		global $wpdb;
+		$meta = maybe_unserialize($old_venue['meta']);
+		$slug = $this->_find_unique_slug($old_venue['name'], $old_venue['identifier']);
+		$insertion_array = array(
+					'post_title'=>stripslashes($old_venue['name']),// VNU_name
+					'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '',// VNU_desc
+					'post_name'=> $slug,// VNU_identifier
+					'post_date'=>current_time('mysql'),// VNU_created
+					'post_date_gmt'=>  current_time('mysql', true),
+					'post_excerpt'=>'',// wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
+					'post_modified'=>current_time('mysql'),// VNU_modified
+					'post_modified_gmt'=>current_time('mysql', true),
+					'post_author'=>$old_venue['wp_user'],// VNU_wp_user
+					'post_parent'=>0,// parent
+					'menu_order'=>0,// VNU_order
+					'post_type'=>'espresso_venues'// post_type
+				);
+		$datatypes_array = array(
+					'%s',// VNU_name
+					'%s',// VNU_desc
+					'%s',// VNU_identifier
+					'%s',// VNU_created
+					'%s',
+					'%s',// VNU_short_desc
+					'%s',// VNU_modified
+					'%s',
+					'%d',// VNU_wp_user
+					'%d',// parent
+					'%d',// VNU_order
+					'%s',// post_type
+				);
+		$success = $wpdb->insert(
+			$this->_new_table,
+			$insertion_array,
+			$datatypes_array
+		);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_table, $insertion_array, $datatypes_array));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 
-    /**
-     * Finds a unique slug for this venue, given its name (we could have simply used
-     * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
-     * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
-     * @param string $post_name
-     * @return string
-     */
-    private function _find_unique_slug($post_name, $old_identifier = '')
-    {
-        $count = 0;
-        $original_name = $post_name ? sanitize_title($post_name) : $old_identifier;
-        $event_slug = $original_name;
-        while ($this->_other_post_exists_with_that_slug($event_slug) && $count<50) {
-            $event_slug = sanitize_title($original_name."-".++$count);
-        }
-        return $event_slug;
-    }
+	/**
+	 * Finds a unique slug for this venue, given its name (we could have simply used
+	 * the old unique_identifier column, but it added a long string of seemingly random characters onto the end
+	 * and really wasn't that pretty for a slug, so we decided we'd make our own slug again)
+	 * @param string $post_name
+	 * @return string
+	 */
+	private function _find_unique_slug($post_name, $old_identifier = '')
+	{
+		$count = 0;
+		$original_name = $post_name ? sanitize_title($post_name) : $old_identifier;
+		$event_slug = $original_name;
+		while ($this->_other_post_exists_with_that_slug($event_slug) && $count<50) {
+			$event_slug = sanitize_title($original_name."-".++$count);
+		}
+		return $event_slug;
+	}
 
-    /**
-     * returns whether or not there is a post that has this same slug (post_title)
-     * @global type $wpdb
-     * @param type $slug
-     * @return boolean
-     */
-    private function _other_post_exists_with_that_slug($slug)
-    {
-        global $wpdb;
-        $query = $wpdb->prepare("SELECT COUNT(ID) FROM ".$this->_new_table." WHERE post_name = %s", $slug);
-        $count = $wpdb->get_var($query);
-        return (boolean) intval($count);
-    }
+	/**
+	 * returns whether or not there is a post that has this same slug (post_title)
+	 * @global type $wpdb
+	 * @param type $slug
+	 * @return boolean
+	 */
+	private function _other_post_exists_with_that_slug($slug)
+	{
+		global $wpdb;
+		$query = $wpdb->prepare("SELECT COUNT(ID) FROM ".$this->_new_table." WHERE post_name = %s", $slug);
+		$count = $wpdb->get_var($query);
+		return (boolean) intval($count);
+	}
 
-    /**
-     * Inserts into the venue_meta table
-     * @param type $cpt_id
-     * @param type $old_venue
-     * @return int
-     */
-    private function _insert_into_meta_table($cpt_id, $old_venue)
-    {
-        global $wpdb;
-        // get a country with the same name, or insert one
-        try {
-            $country = $this->get_migration_script()->get_or_create_country(stripslashes($old_venue['country']));
-            $country_iso = $country['CNT_ISO'];
-        } catch (EE_Error $e) {
-            $this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
-            $country_iso = null;
-        }
-        // get a state with the same name, if possible
-        try {
-            $state = $this->get_migration_script()->get_or_create_state(stripslashes($old_venue['state']), isset($country['CNT_name']) ? $country['CNT_name'] : strip_tags($old_venue['country']));
-            $state_id = $state['STA_ID'];
-        } catch (EE_Error $e) {
-            $this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
-            $state_id = 0;
-        }
-        $meta = maybe_unserialize($old_venue['meta']);
-        // now insert into meta table
-        $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_venue['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_venue['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_venue['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>stripslashes($old_venue['zip']),// VNU_zip
-            'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '',// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '',// VNU_url
-            'VNU_virtual_phone'=>'',// VNU_virtual_phone
-            'VNU_virtual_url'=>'',// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
-            'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
-        );
-        $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
-        );
-        $success = $wpdb->insert($this->_new_meta_table, $insertion_array, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_meta_table, $insertion_array, $datatypes));
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+	/**
+	 * Inserts into the venue_meta table
+	 * @param type $cpt_id
+	 * @param type $old_venue
+	 * @return int
+	 */
+	private function _insert_into_meta_table($cpt_id, $old_venue)
+	{
+		global $wpdb;
+		// get a country with the same name, or insert one
+		try {
+			$country = $this->get_migration_script()->get_or_create_country(stripslashes($old_venue['country']));
+			$country_iso = $country['CNT_ISO'];
+		} catch (EE_Error $e) {
+			$this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
+			$country_iso = null;
+		}
+		// get a state with the same name, if possible
+		try {
+			$state = $this->get_migration_script()->get_or_create_state(stripslashes($old_venue['state']), isset($country['CNT_name']) ? $country['CNT_name'] : strip_tags($old_venue['country']));
+			$state_id = $state['STA_ID'];
+		} catch (EE_Error $e) {
+			$this->add_error(sprintf(__("%s for venue %s", "event_espresso"), $e->getMessage(), $this->_json_encode($old_venue)));
+			$state_id = 0;
+		}
+		$meta = maybe_unserialize($old_venue['meta']);
+		// now insert into meta table
+		$insertion_array = array(
+			'VNU_ID'=>$cpt_id,// VNU_ID_fk
+			'VNU_address'=>stripslashes($old_venue['address']),// VNU_address
+			'VNU_address2'=>stripslashes($old_venue['address2']),// VNU_address2
+			'VNU_city'=>stripslashes($old_venue['city']),// VNU_city
+			'STA_ID'=>$state_id,// STA_ID
+			'CNT_ISO'=>$country_iso,// CNT_ISO
+			'VNU_zip'=>stripslashes($old_venue['zip']),// VNU_zip
+			'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '',// VNU_phone
+			'VNU_capacity'=>-1,// VNU_capacity
+			'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '',// VNU_url
+			'VNU_virtual_phone'=>'',// VNU_virtual_phone
+			'VNU_virtual_url'=>'',// VNU_virtual_url
+			'VNU_google_map_link'=>'',// VNU_google_map_link
+			'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
+		);
+		$datatypes = array(
+			'%d',// VNU_ID_fk
+			'%s',// VNU_address
+			'%s',// VNU_address2
+			'%s',// VNU_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// VNU_zip
+			'%s',// VNU_phone
+			'%d',// VNU_capacity
+			'%s',// VNU_url
+			'%s',// VNU_virtual_phone
+			'%s',// VNU_virtual_url
+			'%s',// VNU_google_map_link
+			'%d',// VNU_enable_for_gmap
+		);
+		$success = $wpdb->insert($this->_new_meta_table, $insertion_array, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_meta_table, $insertion_array, $datatypes));
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -73,12 +73,12 @@ 
         $rows = $wpdb->get_results($wpdb->prepare("SELECT * FROM ".$this->_old_table." LIMIT %d,%d", $start_at_record, $num_items), ARRAY_A);
         $items_actually_migrated = 0;
         foreach ($rows as $old_venue) {
-            if (! $new_id = $this->_insert_into_posts($old_venue)) {
+            if ( ! $new_id = $this->_insert_into_posts($old_venue)) {
                 $items_actually_migrated++;
                 continue;
             }
             $this->get_migration_script()->set_mapping($this->_old_table, $old_venue['id'], $this->_new_table, $new_id);
-            if (! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
+            if ( ! $new_meta_id = $this->_insert_into_meta_table($new_id, $old_venue)) {
                 $items_actually_migrated++;
                 continue;
             }
@@ -132,39 +132,39 @@ 
         $meta = maybe_unserialize($old_venue['meta']);
         $slug = $this->_find_unique_slug($old_venue['name'], $old_venue['identifier']);
         $insertion_array = array(
-                    'post_title'=>stripslashes($old_venue['name']),// VNU_name
-                    'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '',// VNU_desc
-                    'post_name'=> $slug,// VNU_identifier
-                    'post_date'=>current_time('mysql'),// VNU_created
+                    'post_title'=>stripslashes($old_venue['name']), // VNU_name
+                    'post_content'=>isset($meta['description']) ? stripslashes(strip_tags($meta['description'])) : '', // VNU_desc
+                    'post_name'=> $slug, // VNU_identifier
+                    'post_date'=>current_time('mysql'), // VNU_created
                     'post_date_gmt'=>  current_time('mysql', true),
-                    'post_excerpt'=>'',// wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
-                    'post_modified'=>current_time('mysql'),// VNU_modified
+                    'post_excerpt'=>'', // wp_trim_words($meta['description'] ? $meta['description'] : '',50),//VNU_short_desc arbitraty only 50 characters
+                    'post_modified'=>current_time('mysql'), // VNU_modified
                     'post_modified_gmt'=>current_time('mysql', true),
-                    'post_author'=>$old_venue['wp_user'],// VNU_wp_user
-                    'post_parent'=>0,// parent
-                    'menu_order'=>0,// VNU_order
+                    'post_author'=>$old_venue['wp_user'], // VNU_wp_user
+                    'post_parent'=>0, // parent
+                    'menu_order'=>0, // VNU_order
                     'post_type'=>'espresso_venues'// post_type
                 );
         $datatypes_array = array(
-                    '%s',// VNU_name
-                    '%s',// VNU_desc
-                    '%s',// VNU_identifier
-                    '%s',// VNU_created
+                    '%s', // VNU_name
+                    '%s', // VNU_desc
+                    '%s', // VNU_identifier
+                    '%s', // VNU_created
                     '%s',
-                    '%s',// VNU_short_desc
-                    '%s',// VNU_modified
+                    '%s', // VNU_short_desc
+                    '%s', // VNU_modified
                     '%s',
-                    '%d',// VNU_wp_user
-                    '%d',// parent
-                    '%d',// VNU_order
-                    '%s',// post_type
+                    '%d', // VNU_wp_user
+                    '%d', // parent
+                    '%d', // VNU_order
+                    '%s', // post_type
                 );
         $success = $wpdb->insert(
             $this->_new_table,
             $insertion_array,
             $datatypes_array
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_table, $insertion_array, $datatypes_array));
             return 0;
         }
@@ -183,7 +183,7 @@ 
         $count = 0;
         $original_name = $post_name ? sanitize_title($post_name) : $old_identifier;
         $event_slug = $original_name;
-        while ($this->_other_post_exists_with_that_slug($event_slug) && $count<50) {
+        while ($this->_other_post_exists_with_that_slug($event_slug) && $count < 50) {
             $event_slug = sanitize_title($original_name."-".++$count);
         }
         return $event_slug;
@@ -231,39 +231,39 @@ 
         $meta = maybe_unserialize($old_venue['meta']);
         // now insert into meta table
         $insertion_array = array(
-            'VNU_ID'=>$cpt_id,// VNU_ID_fk
-            'VNU_address'=>stripslashes($old_venue['address']),// VNU_address
-            'VNU_address2'=>stripslashes($old_venue['address2']),// VNU_address2
-            'VNU_city'=>stripslashes($old_venue['city']),// VNU_city
-            'STA_ID'=>$state_id,// STA_ID
-            'CNT_ISO'=>$country_iso,// CNT_ISO
-            'VNU_zip'=>stripslashes($old_venue['zip']),// VNU_zip
-            'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '',// VNU_phone
-            'VNU_capacity'=>-1,// VNU_capacity
-            'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '',// VNU_url
-            'VNU_virtual_phone'=>'',// VNU_virtual_phone
-            'VNU_virtual_url'=>'',// VNU_virtual_url
-            'VNU_google_map_link'=>'',// VNU_google_map_link
+            'VNU_ID'=>$cpt_id, // VNU_ID_fk
+            'VNU_address'=>stripslashes($old_venue['address']), // VNU_address
+            'VNU_address2'=>stripslashes($old_venue['address2']), // VNU_address2
+            'VNU_city'=>stripslashes($old_venue['city']), // VNU_city
+            'STA_ID'=>$state_id, // STA_ID
+            'CNT_ISO'=>$country_iso, // CNT_ISO
+            'VNU_zip'=>stripslashes($old_venue['zip']), // VNU_zip
+            'VNU_phone'=>isset($meta['phone']) ? stripslashes($meta['phone']) : '', // VNU_phone
+            'VNU_capacity'=>-1, // VNU_capacity
+            'VNU_url'=>isset($meta['website']) ? stripslashes($meta['website']) : '', // VNU_url
+            'VNU_virtual_phone'=>'', // VNU_virtual_phone
+            'VNU_virtual_url'=>'', // VNU_virtual_url
+            'VNU_google_map_link'=>'', // VNU_google_map_link
             'VNU_enable_for_gmap'=>true // VNU_enable_for_gmap
         );
         $datatypes = array(
-            '%d',// VNU_ID_fk
-            '%s',// VNU_address
-            '%s',// VNU_address2
-            '%s',// VNU_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// VNU_zip
-            '%s',// VNU_phone
-            '%d',// VNU_capacity
-            '%s',// VNU_url
-            '%s',// VNU_virtual_phone
-            '%s',// VNU_virtual_url
-            '%s',// VNU_google_map_link
-            '%d',// VNU_enable_for_gmap
+            '%d', // VNU_ID_fk
+            '%s', // VNU_address
+            '%s', // VNU_address2
+            '%s', // VNU_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // VNU_zip
+            '%s', // VNU_phone
+            '%d', // VNU_capacity
+            '%s', // VNU_url
+            '%s', // VNU_virtual_phone
+            '%s', // VNU_virtual_url
+            '%s', // VNU_google_map_link
+            '%d', // VNU_enable_for_gmap
         );
         $success = $wpdb->insert($this->_new_meta_table, $insertion_array, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_venue, $this->_new_meta_table, $insertion_array, $datatypes));
             return 0;
         }

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

Doc Comments +3 added lines, -2 removed lines

@@ -128,6 +128,9 @@ 
         return $items_actually_migrated;
     }
 
+    /**
+     * @param integer $num_items_to_migrate
+     */
     private function _gather_relations_to_add($num_items_to_migrate)
     {
         $relations_to_add_this_step = array();
@@ -160,8 +163,6 @@ 
 
     /**
      * Adds teh relation between the payment method and the currencies it can be used for
-     * @param int $id
-     * @param string $gateway_slug
      */
     private function _add_currency_relations($pm_id, $currency_code)
     {

Indentation +164 added lines, -164 removed lines

@@ -12,174 +12,174 @@
  */
 class EE_DMS_4_6_0_payment_method_currencies extends EE_Data_Migration_Script_Stage
 {
-    protected $_currency_table_name;
-    protected $_currency_payment_method_table_name;
-    protected $_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_currencies = array(
-        'Aim' => array(
-            'AUD',
-            'USD',
-            'CAD',
-            'EUR',
-            'GBP',
-            'NZD',
-        ),
-        'Bank' => 'all',
-        'Check' => 'all',
-        'Invoice' => 'all',
-        'Mijireh' => 'all',
-        'Paypal_Pro' => array(
-            'USD',
-            'GBP',
-            'CAD',
-            'AUD',
-            'BRL',
-            'CHF',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MXN',
-            'MYR',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'SEK',
-            'SGD',
-            'THB',
-            'TRY',
-            'TWD',
-        ),
-        'Paypal_Standard' => array(
-            'USD',
-            'GBP',
-            'CAD',
-            'AUD',
-            'BRL',
-            'CHF',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MXN',
-            'MYR',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'SEK',
-            'SGD',
-            'THB',
-            'TRY',
-            'TWD'
-        )
-    );
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __('Payment Method Currencies', 'event_espresso');
-        $this->_payment_method_table_name = $wpdb->prefix.'esp_payment_method';
-        $this->_currency_payment_method_table_name = $wpdb->prefix.'esp_currency_payment_method';
-        $this->_currency_table_name = $wpdb->prefix.'esp_currency';
-        parent::__construct();
-    }
+	protected $_currency_table_name;
+	protected $_currency_payment_method_table_name;
+	protected $_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_currencies = array(
+		'Aim' => array(
+			'AUD',
+			'USD',
+			'CAD',
+			'EUR',
+			'GBP',
+			'NZD',
+		),
+		'Bank' => 'all',
+		'Check' => 'all',
+		'Invoice' => 'all',
+		'Mijireh' => 'all',
+		'Paypal_Pro' => array(
+			'USD',
+			'GBP',
+			'CAD',
+			'AUD',
+			'BRL',
+			'CHF',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MXN',
+			'MYR',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'SEK',
+			'SGD',
+			'THB',
+			'TRY',
+			'TWD',
+		),
+		'Paypal_Standard' => array(
+			'USD',
+			'GBP',
+			'CAD',
+			'AUD',
+			'BRL',
+			'CHF',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MXN',
+			'MYR',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'SEK',
+			'SGD',
+			'THB',
+			'TRY',
+			'TWD'
+		)
+	);
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __('Payment Method Currencies', 'event_espresso');
+		$this->_payment_method_table_name = $wpdb->prefix.'esp_payment_method';
+		$this->_currency_payment_method_table_name = $wpdb->prefix.'esp_currency_payment_method';
+		$this->_currency_table_name = $wpdb->prefix.'esp_currency';
+		parent::__construct();
+	}
 
-    protected function _count_records_to_migrate()
-    {
-        $count = 0;
-        foreach ($this->_gateway_currencies as $currencies) {
-            if ($currencies == 'all') {
-                $currencies = $this->_get_all_currencies();
-            }
-            $count += count($currencies);
-        }
-        return $count;
-    }
+	protected function _count_records_to_migrate()
+	{
+		$count = 0;
+		foreach ($this->_gateway_currencies as $currencies) {
+			if ($currencies == 'all') {
+				$currencies = $this->_get_all_currencies();
+			}
+			$count += count($currencies);
+		}
+		return $count;
+	}
 
 
 
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        $items_actually_migrated = 0;
-        $relations_to_add_this_step = $this->_gather_relations_to_add($num_items_to_migrate);
-        foreach ($relations_to_add_this_step as $pm_slug => $currencies) {
-            $id = $this->get_migration_script()->get_mapping_new_pk('EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name);
-            foreach ($currencies as $currency) {
-                if ($id) {
-                    $this->_add_currency_relations($id, $currency);
-                }
-                $items_actually_migrated++;
-            }
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		$items_actually_migrated = 0;
+		$relations_to_add_this_step = $this->_gather_relations_to_add($num_items_to_migrate);
+		foreach ($relations_to_add_this_step as $pm_slug => $currencies) {
+			$id = $this->get_migration_script()->get_mapping_new_pk('EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name);
+			foreach ($currencies as $currency) {
+				if ($id) {
+					$this->_add_currency_relations($id, $currency);
+				}
+				$items_actually_migrated++;
+			}
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 
-    private function _gather_relations_to_add($num_items_to_migrate)
-    {
-        $relations_to_add_this_step = array();
-        $migrate_up_to_count = $this->count_records_migrated() + $num_items_to_migrate;
-        $iterator = 0;
-        foreach ($this->_gateway_currencies as $pm_slug => $currencies) {
-            if ($currencies == 'all') {
-                $currencies = $this->_get_all_currencies();
-            }
-            foreach ($currencies as $currency_code) {
-                if ($this->count_records_migrated() <= $iterator &&
-                        $iterator < $migrate_up_to_count ) {
-                    $relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
-                }
-                $iterator++;
-            }
-        }
-        return $relations_to_add_this_step;
-    }
-    /**
-     * Gets all the currency codes in the database
-     * @return array
-     */
-    private function _get_all_currencies()
-    {
-        global $wpdb;
-        $currencies = $wpdb->get_col("SELECT CUR_code FROM {$this->_currency_table_name}");
-        return $currencies;
-    }
+	private function _gather_relations_to_add($num_items_to_migrate)
+	{
+		$relations_to_add_this_step = array();
+		$migrate_up_to_count = $this->count_records_migrated() + $num_items_to_migrate;
+		$iterator = 0;
+		foreach ($this->_gateway_currencies as $pm_slug => $currencies) {
+			if ($currencies == 'all') {
+				$currencies = $this->_get_all_currencies();
+			}
+			foreach ($currencies as $currency_code) {
+				if ($this->count_records_migrated() <= $iterator &&
+						$iterator < $migrate_up_to_count ) {
+					$relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
+				}
+				$iterator++;
+			}
+		}
+		return $relations_to_add_this_step;
+	}
+	/**
+	 * Gets all the currency codes in the database
+	 * @return array
+	 */
+	private function _get_all_currencies()
+	{
+		global $wpdb;
+		$currencies = $wpdb->get_col("SELECT CUR_code FROM {$this->_currency_table_name}");
+		return $currencies;
+	}
 
-    /**
-     * Adds teh relation between the payment method and the currencies it can be used for
-     * @param int $id
-     * @param string $gateway_slug
-     */
-    private function _add_currency_relations($pm_id, $currency_code)
-    {
-        global $wpdb;
-        $cur_pm_relation = array(
-                    'CUR_code'=>$currency_code,
-                    'PMD_ID'=>$pm_id,
-                );
-        $success = $wpdb->insert(
-            $this->_currency_payment_method_table_name,
-            $cur_pm_relation,
-            array(
-                    '%s',// CUR_code
-                    '%d',// PMD_ID
-                )
-        );
-        if (! $success) {
-            $this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
-        }
-    }
+	/**
+	 * Adds teh relation between the payment method and the currencies it can be used for
+	 * @param int $id
+	 * @param string $gateway_slug
+	 */
+	private function _add_currency_relations($pm_id, $currency_code)
+	{
+		global $wpdb;
+		$cur_pm_relation = array(
+					'CUR_code'=>$currency_code,
+					'PMD_ID'=>$pm_id,
+				);
+		$success = $wpdb->insert(
+			$this->_currency_payment_method_table_name,
+			$cur_pm_relation,
+			array(
+					'%s',// CUR_code
+					'%d',// PMD_ID
+				)
+		);
+		if (! $success) {
+			$this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -139,8 +139,8 @@ 
             }
             foreach ($currencies as $currency_code) {
                 if ($this->count_records_migrated() <= $iterator &&
-                        $iterator < $migrate_up_to_count ) {
-                    $relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
+                        $iterator < $migrate_up_to_count) {
+                    $relations_to_add_this_step[$pm_slug] [] = $currency_code;
                 }
                 $iterator++;
             }
@@ -174,11 +174,11 @@ 
             $this->_currency_payment_method_table_name,
             $cur_pm_relation,
             array(
-                    '%s',// CUR_code
-                    '%d',// PMD_ID
+                    '%s', // CUR_code
+                    '%d', // PMD_ID
                 )
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
         }
     }

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

Doc Comments -1 removed lines

@@ -58,7 +58,6 @@
             'IV'=>  __("Invoice", 'event_espresso'),
             'MO'=>  __("Money Order", 'event_espresso'),
      * @global type $wpdb
-     * @param int $id
      * @return string
      */
     protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)

Indentation +78 added lines, -78 removed lines

@@ -11,44 +11,44 @@ 
  */
 class EE_DMS_4_6_0_payments extends EE_Data_Migration_Script_Stage_Table
 {
-    protected $_payment_method_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_payment';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
-        $this->_pretty_name = __('Payment-Payment Method Relations', 'event_espresso');
-        parent::__construct();
-    }
-    protected function _migrate_old_row($payment_row)
-    {
-        global $wpdb;
-        // get the payment method's ID
-        $PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
-        if (! $PMD_ID) {
-            $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
-            $PMD_ID = 0;
-        }
-        $new_values = array(
-            'PMD_ID' => $PMD_ID,
-            'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
-        $wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
-        $new_value_datatypes = array( '%d', '%s' );
-        $where_datatypes = array( '%d' );
-        $success = $wpdb->update(
-            $this->_old_table,
-            $new_values,
-            $wheres,
-            $new_value_datatypes,
-            $where_datatypes
-        );
-        if (! $success) {
-            $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
-        }
-    }
-    /**
-     *
-     *  array(
+	protected $_payment_method_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix . 'esp_payment';
+		$this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+		$this->_pretty_name = __('Payment-Payment Method Relations', 'event_espresso');
+		parent::__construct();
+	}
+	protected function _migrate_old_row($payment_row)
+	{
+		global $wpdb;
+		// get the payment method's ID
+		$PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
+		if (! $PMD_ID) {
+			$this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
+			$PMD_ID = 0;
+		}
+		$new_values = array(
+			'PMD_ID' => $PMD_ID,
+			'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
+		$wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
+		$new_value_datatypes = array( '%d', '%s' );
+		$where_datatypes = array( '%d' );
+		$success = $wpdb->update(
+			$this->_old_table,
+			$new_values,
+			$wheres,
+			$new_value_datatypes,
+			$where_datatypes
+		);
+		if (! $success) {
+			$this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
+		}
+	}
+	/**
+	 *
+	 *  array(
             'PP' => __( 'PayPal', 'event_espresso' ),
             'CC' => __( 'Credit Card', 'event_espresso' ),
             'DB'=>  __("Debit Card", 'event_espresso'),
@@ -57,44 +57,44 @@ 
             'BK'=>  __("Bank", 'event_espresso'),
             'IV'=>  __("Invoice", 'event_espresso'),
             'MO'=>  __("Money Order", 'event_espresso'),
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)
-    {
-        global $wpdb;
-        // convert from old known PAY_method values to their corresponding
-        // PMD_type or default PMD_name
-        switch ($old_pay_method_column) {
-            case 'PP':
-                $pmd_type = 'Paypal_Standard';
-                break;
-            case 'CC':
-                $pmd_type = 'Credit_Card';
-                break;
-            case 'DB':
-                $pmd_type = 'Debit_Card';
-                break;
-            case 'CHQ':
-                $pmd_type = 'Check';
-                break;
-            case 'CSH':
-                $pmd_type = 'Cash';
-                break;
-            case 'BK':
-                $pmd_type = 'Bank';
-                break;
-            case 'IV':
-                $pmd_type = 'Invoice';
-                break;
-            case 'MO':
-                $pmd_type = 'Money_Order';
-                break;
-            default:
-                $pmd_type = $gateway_name;
-        }
-        $pmd_name = str_replace("_", " ", $pmd_type);
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
-    }
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_payment_method_id_by_gateway_name($gateway_name, $old_pay_method_column)
+	{
+		global $wpdb;
+		// convert from old known PAY_method values to their corresponding
+		// PMD_type or default PMD_name
+		switch ($old_pay_method_column) {
+			case 'PP':
+				$pmd_type = 'Paypal_Standard';
+				break;
+			case 'CC':
+				$pmd_type = 'Credit_Card';
+				break;
+			case 'DB':
+				$pmd_type = 'Debit_Card';
+				break;
+			case 'CHQ':
+				$pmd_type = 'Check';
+				break;
+			case 'CSH':
+				$pmd_type = 'Cash';
+				break;
+			case 'BK':
+				$pmd_type = 'Bank';
+				break;
+			case 'IV':
+				$pmd_type = 'Invoice';
+				break;
+			case 'MO':
+				$pmd_type = 'Money_Order';
+				break;
+			default:
+				$pmd_type = $gateway_name;
+		}
+		$pmd_name = str_replace("_", " ", $pmd_type);
+		return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -15,8 +15,8 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_payment';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+        $this->_old_table = $wpdb->prefix.'esp_payment';
+        $this->_payment_method_table = $wpdb->prefix.'esp_payment_method';
         $this->_pretty_name = __('Payment-Payment Method Relations', 'event_espresso');
         parent::__construct();
     }
@@ -25,16 +25,16 @@ 
         global $wpdb;
         // get the payment method's ID
         $PMD_ID = apply_filters('FHEE__EE_DMS_4_6_0_payments__migrate_old_row__PMD_ID', $this->_get_payment_method_id_by_gateway_name($payment_row['PAY_gateway'], $payment_row['PAY_method']));
-        if (! $PMD_ID) {
+        if ( ! $PMD_ID) {
             $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating payment row %2$s so just assigned it an unknown payment method', 'event_espresso'), $payment_row['PAY_gateway'], $this->_json_encode($payment_row)));
             $PMD_ID = 0;
         }
         $new_values = array(
             'PMD_ID' => $PMD_ID,
-            'PAY_source' => ( $payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART' ) );
-        $wheres = array( 'PAY_ID' => $payment_row['PAY_ID'] );
-        $new_value_datatypes = array( '%d', '%s' );
-        $where_datatypes = array( '%d' );
+            'PAY_source' => ($payment_row['PAY_via_admin'] ? 'ADMIN' : 'CART') );
+        $wheres = array('PAY_ID' => $payment_row['PAY_ID']);
+        $new_value_datatypes = array('%d', '%s');
+        $where_datatypes = array('%d');
         $success = $wpdb->update(
             $this->_old_table,
             $new_values,
@@ -42,7 +42,7 @@ 
             $new_value_datatypes,
             $where_datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_old_table, $this->_json_encode($wheres)));
         }
     }
@@ -95,6 +95,6 @@ 
                 $pmd_type = $gateway_name;
         }
         $pmd_name = str_replace("_", " ", $pmd_type);
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
+        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM ".$wpdb->prefix."esp_payment_method WHERE PMD_type = %s OR PMD_name = %s", $pmd_type, $pmd_name));
     }
 }

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

Doc Comments -1 removed lines

@@ -50,7 +50,6 @@
     /**
      *
      * @global type $wpdb
-     * @param int $id
      * @return string
      */
     protected function _get_payment_method_id_by_gateway_name($gateway_name)

Indentation +47 added lines, -47 removed lines

@@ -11,51 +11,51 @@
  */
 class EE_DMS_4_6_0_transactions extends EE_Data_Migration_Script_Stage_Table
 {
-    protected $_transaction_table;
-    protected $_payment_method_table;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_extra_meta';
-        $this->_transaction_table = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
-        $this->_pretty_name = __('Transaction Payment Method Relations', 'event_espresso');
-        $this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($extra_meta_row)
-    {
-        global $wpdb;
-        // get the payment method's ID
-        $PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
-        if (! $PMD_ID) {
-            $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
-            return;
-        }
-        $new_values = array( 'PMD_ID' => $PMD_ID );
-        $wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
-        $new_value_datatypes = array( '%d' );
-        $where_datatypes = array( '%d' );
-        $success = $wpdb->update(
-            $this->_transaction_table,
-            $new_values,
-            $wheres,
-            $new_value_datatypes,
-            $where_datatypes
-        );
-        if (! $success) {
-            $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
-        }
-    }
-    /**
-     *
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_payment_method_id_by_gateway_name($gateway_name)
-    {
-        global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
-    }
+	protected $_transaction_table;
+	protected $_payment_method_table;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix . 'esp_extra_meta';
+		$this->_transaction_table = $wpdb->prefix . 'esp_transaction';
+		$this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+		$this->_pretty_name = __('Transaction Payment Method Relations', 'event_espresso');
+		$this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($extra_meta_row)
+	{
+		global $wpdb;
+		// get the payment method's ID
+		$PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
+		if (! $PMD_ID) {
+			$this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
+			return;
+		}
+		$new_values = array( 'PMD_ID' => $PMD_ID );
+		$wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
+		$new_value_datatypes = array( '%d' );
+		$where_datatypes = array( '%d' );
+		$success = $wpdb->update(
+			$this->_transaction_table,
+			$new_values,
+			$wheres,
+			$new_value_datatypes,
+			$where_datatypes
+		);
+		if (! $success) {
+			$this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
+		}
+	}
+	/**
+	 *
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_payment_method_id_by_gateway_name($gateway_name)
+	{
+		global $wpdb;
+		return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -16,9 +16,9 @@ 
     public function __construct()
     {
         global $wpdb;
-        $this->_old_table = $wpdb->prefix . 'esp_extra_meta';
-        $this->_transaction_table = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_method_table = $wpdb->prefix . 'esp_payment_method';
+        $this->_old_table = $wpdb->prefix.'esp_extra_meta';
+        $this->_transaction_table = $wpdb->prefix.'esp_transaction';
+        $this->_payment_method_table = $wpdb->prefix.'esp_payment_method';
         $this->_pretty_name = __('Transaction Payment Method Relations', 'event_espresso');
         $this->_extra_where_sql = "WHERE EXM_key = 'gateway' AND EXM_type = 'Transaction'";
         parent::__construct();
@@ -28,14 +28,14 @@ 
         global $wpdb;
         // get the payment method's ID
         $PMD_ID = $this->_get_payment_method_id_by_gateway_name($extra_meta_row['EXM_value']);
-        if (! $PMD_ID) {
+        if ( ! $PMD_ID) {
             $this->add_error(sprintf(__('Could not find payment method with PMD_type = \'%1$s\' when migrating extra meta row %2$s', 'event_espresso'), $extra_meta_row['EXM_value'], $this->_json_encode($extra_meta_row)));
             return;
         }
-        $new_values = array( 'PMD_ID' => $PMD_ID );
-        $wheres = array( 'TXN_ID' => $extra_meta_row['OBJ_ID'] );
-        $new_value_datatypes = array( '%d' );
-        $where_datatypes = array( '%d' );
+        $new_values = array('PMD_ID' => $PMD_ID);
+        $wheres = array('TXN_ID' => $extra_meta_row['OBJ_ID']);
+        $new_value_datatypes = array('%d');
+        $where_datatypes = array('%d');
         $success = $wpdb->update(
             $this->_transaction_table,
             $new_values,
@@ -43,7 +43,7 @@ 
             $new_value_datatypes,
             $where_datatypes
         );
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(sprintf(__('Couldnt set %1$s row in table %2$s where %3$s', 'event_espresso'), $this->_json_encode($new_values), $this->_transaction_table, $this->_json_encode($wheres)));
         }
     }
@@ -56,6 +56,6 @@ 
     protected function _get_payment_method_id_by_gateway_name($gateway_name)
     {
         global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM " . $wpdb->prefix . "esp_payment_method WHERE PMD_type = %s", $gateway_name));
+        return $wpdb->get_var($wpdb->prepare("SELECT PMD_ID FROM ".$wpdb->prefix."esp_payment_method WHERE PMD_type = %s", $gateway_name));
     }
 }

core/data_migration_scripts/EE_Data_Migration_Class_Base.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,7 @@
      * @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
+     * @param string[]  $data_types       numerically indexed
      * @return string
      */
     protected function _create_error_message_for_db_insertion(

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)
+				)
+			);
+		}
+	}
 }

core/db_models/EEM_Message_Template_Group.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
      * @param        $messenger
      * @param string $orderby
      * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
+     * @return EE_Base_Class[] all (including trashed or inactive) message template group objects for the given messenger
      */
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
@@ -341,7 +341,7 @@ 
     /**
      * This sends things to the validator for the given messenger and message type.
      *
-     * @param  array $fields the incoming fields to check.
+     * @param  string $fields the incoming fields to check.
      *                       Note this array is in the formatted fields from the form fields setup.
      *                       So we need to reformat this into an array of expected field refs by the validator.
      *                       Note also that this is not only the fields for the Message Template Group

Spacing +23 added lines, -23 removed lines

@@ -44,7 +44,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation()
         );
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+            $this->_cap_restriction_generators[$context] = new EE_Restriction_Generator_Global('MTP_is_global');
         }
         $this->_caps_slug = 'messages';
 
@@ -71,7 +71,7 @@ 
         $limit = null,
         $count = false
     ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit);
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
 
@@ -89,7 +89,7 @@ 
     public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
     {
         return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+            array(array('MTP_messenger' => $messenger), 'order_by' => array($orderby => $order))
         );
     }
 
@@ -107,7 +107,7 @@ 
             && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
             && $_REQUEST['ee_messenger_filter_by'] != 'all'
         ) {
-            $_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
+            $_where['MTP_messenger'] = $_REQUEST['ee_messenger_filter_by'];
         }
 
         if (isset($_REQUEST['ee_message_type_filter_by'])
@@ -141,7 +141,7 @@ 
         $global = true,
         $user_check = false
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
@@ -155,7 +155,7 @@ 
             $_where['MTP_user_id'] = get_current_user_id();
         }
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -176,7 +176,7 @@ 
     {
         $_where = $this->_maybe_mtp_filters();
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         $r_templates = $count
             ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
@@ -196,9 +196,9 @@ 
      */
     public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
     {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+        $where = array_merge($query_params, array('Event.EVT_ID' => $EVT_ID));
         return $this->get_all(
-            array( $where )
+            array($where)
         );
     }
 
@@ -223,11 +223,11 @@ 
         $count = false,
         $global = true
     ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+        $_where = $global ? array('MTP_is_global' => true) : array('MTP_is_global' => false);
         $_where['MTP_is_active'] = true;
         $_where = $this->_maybe_mtp_filters($_where);
 
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
     }
@@ -265,7 +265,7 @@ 
             'MTP_is_active' => $active
         );
 
-        $query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby=>$order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -305,7 +305,7 @@ 
             $_where['MTP_is_active'] = $active;
         }
 
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+        $query_params = array($_where, 'order_by' => array($orderby => $order), 'limit' => $limit);
 
         return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
     }
@@ -363,19 +363,19 @@ 
             // first let's figure out if the value['content'] in the current index is an array.
             //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
             if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
+                $assembled_fields[$value['name']] = $value['content']['main'];
                 // loop through the content and get the other fields.
                 foreach ($value['content'] as $name => $val) {
                     if ($name == 'main') {
                         continue;
                     }
-                    $assembled_fields[ $name ] = $val;
+                    $assembled_fields[$name] = $val;
                 }
                 continue;
             }
 
             // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
+            $assembled_fields[$value['name']] = $value['content'];
         }
 
         // now we've got the assembled_fields.
@@ -385,9 +385,9 @@ 
         $mt_ref = ucwords(str_replace('_', ' ', $message_type));
         $mt_ref = str_replace(' ', '_', $mt_ref);
 
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+        $classname = 'EE_Messages_'.$m_ref.'_'.$mt_ref.'_Validator';
 
-        if (!class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             $msg[] = __('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 __(
@@ -425,12 +425,12 @@ 
         if (empty($messenger_names) && empty($message_type_names)) {
             return 0;
         }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+        if ( ! empty($messenger_names)) {
+            $query_args[0]['MTP_messenger'] = array('IN', (array) $messenger_names);
         }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+        if ( ! empty($message_type_names)) {
+            $query_args[0]['MTP_message_type'] = array('IN', (array) $message_type_names);
         }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
+        return $this->update(array('MTP_is_active' => false), $query_args);
     }
 }

Indentation +422 added lines, -422 removed lines

@@ -11,426 +11,426 @@
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the EEM_Message_Template_Group object
-    protected static $_instance = null;
-
-
-
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Message Template Group', 'event_espresso');
-        $this->plural_item = __('Message Template Groups', 'event_espresso');
-        $this->_tables = array(
-            'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
-        );
-        $this->_fields = array(
-            'Message_Template_Group' => array(
-                'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', __('Message Template Group ID', 'event_espresso')),
-                'MTP_name' => new EE_Plain_Text_Field('MTP_name', __('The name of the template group', 'event_espresso'), false, ''),
-                'MTP_description' => new EE_Simple_HTML_Field('MTP_description', __('A brief description about this template.', 'event_espresso'), false, ''),
-                'MTP_user_id'=> new EE_WP_User_Field('MTP_user_id', __('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
-                'MTP_messenger'=>new EE_Plain_Text_Field('MTP_messenger', __('Messenger Used for Template', 'event_espresso'), false, 'email'),
-                'MTP_message_type'=>new EE_Plain_Text_Field('MTP_message_type', __('Message Type', 'event_espresso'), false, 'registration'),
-                'MTP_is_global'=>new EE_Boolean_Field('MTP_is_global', __('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
-                'MTP_is_override'=>new EE_Boolean_Field('MTP_is_override', __('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
-                'MTP_deleted'=>new EE_Trashed_Flag_Field('MTP_deleted', __('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
-                'MTP_is_active'=>new EE_Boolean_Field('MTP_is_active', __('Flag indicating whether template group is active', 'event_espresso'), false, true)
-            )
-        );
-        $this->_model_relations = array(
-            'Message_Template' => new EE_Has_Many_Relation(),
-            'Message' => new EE_Has_Many_Relation(),
-            'Event' => new EE_HABTM_Relation('Event_Message_Template'),
-            'WP_User' => new EE_Belongs_To_Relation()
-        );
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * get_all_trashed_message_templates_by_event
-     *
-     * @access public
-     * @param int    $EVT_ID specific event id
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return array message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        $EVT_ID,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false
-    ) {
-        $query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * get_all_message_templates_by_messenger
-     *
-     * @access public
-     * @param        $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
-     */
-    public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
-    {
-        return $this->get_all_deleted_and_undeleted(
-            array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
-        );
-    }
-
-
-
-    /**
-     * This simply adds on any messenger/message type filters that may be present in the $_POST global
-     * @param  array  $_where any existing where conditions to append these to.
-     * @return array          original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters($_where = array())
-    {
-        // account for messenger or message type filters
-        if (isset($_REQUEST['ee_messenger_filter_by'])
-            && $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
-            && $_REQUEST['ee_messenger_filter_by'] != 'all'
-        ) {
-            $_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
-        }
-
-        if (isset($_REQUEST['ee_message_type_filter_by'])
-            && $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
-        }
-
-        return $_where;
-    }
-
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @param bool   $user_check
-     * @return array all active (non_trashed, active) message template objects
-     */
-    public function get_all_active_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true,
-        $user_check = false
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        if ($user_check
-            && ! $global
-            && ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_messages',
-                'get_all_active_message_templates'
-            )
-        ) {
-            $_where['MTP_user_id'] = get_current_user_id();
-        }
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     *    retrieve ALL message_template groups from db regardless of wht
-     *
-     * @access    public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
-    {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        $r_templates = $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-
-        return $r_templates;
-    }
-
-
-
-
-    /**
-     * This gets all the custom templates attached to a specific event
-     * @param  int      $EVT_ID         event id
-     * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return  EE_Message_Template_Group[]
-     */
-    public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
-    {
-        $where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
-        return $this->get_all(
-            array( $where )
-        );
-    }
-
-
-
-    /**
-     * get_all_trashed_grouped_message_templates
-     * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @return \EE_Message_Template_Group[] message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true
-    ) {
-        $_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
-        $_where['MTP_is_active'] = true;
-        $_where = $this->_maybe_mtp_filters($_where);
-
-        $query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
-
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-
-    /**
-     * this returns the message template group(s) for a given event, messenger, and message template
-     *
-     * @param  string             $messenger
-     * @param  string             $message_type
-     * @param                     $evt_id
-     * @param  string             $orderby pointless at this point but still included
-     * @param  string             $order
-     * @param  mixed (array|null) $limit   array($offset, $num)
-     * @param  bool               $count   true = just return count, false = objects
-     * @param  bool               $active  ignore "active" or not. (default only return active)
-     * @return \mixed[]) depending on $count.
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        $messenger,
-        $message_type,
-        $evt_id,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'Event.EVT_ID' => $evt_id,
-            'MTP_is_global' => true,
-            'MTP_is_active' => $active
-        );
-
-        $query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all GLOBAL message template groups for the given messenger and message type
-     *
-     * @param  string $messenger    slug for messenger
-     * @param  string $message_type slug for message type
-     * @param  string $orderby      what column to orderby
-     * @param  string $order        ASC or DESC
-     * @param  mixed (array|null) $limit array($offset, $num)
-     * @param  bool   $count        true = just return count, false = objects
-     * @param  bool   $active       ignore "active" or not. (default only return active) -
-     *                              'all' means return both inactive AND inactive.
-     * @return array               message template objects that are global (i.e. non-event)
-     */
-    public function get_global_message_template_by_m_and_mt(
-        $messenger,
-        $message_type,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = array(
-            'MTP_messenger' => $messenger,
-            'MTP_message_type' => $message_type,
-            'MTP_is_global' => true,
-        );
-
-        if ($active != 'all') {
-            $_where['MTP_is_active'] = $active;
-        }
-
-        $query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-
-
-    /**
-     * get all custom message template groups for the given messenger and message type
-     * @param  string $messenger    messenger
-     * @param  string $message_type messagetype
-     * @param  array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
-    {
-        return $this->get_all(
-            array_merge(
-                $query_params,
-                array(
-                    array(
-                        'MTP_is_global'    => false,
-                        'MTP_messenger'    => $messenger,
-                        'MTP_message_type' => $message_type
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param  array $fields the incoming fields to check.
-     *                       Note this array is in the formatted fields from the form fields setup.
-     *                       So we need to reformat this into an array of expected field refs by the validator.
-     *                       Note also that this is not only the fields for the Message Template Group
-     *                       but ALSO for Message Template.
-     * @param string $context      The context the fields were obtained from.
-     * @param string $messenger    The messenger we are validating
-     * @param string $message_type The message type we are validating.
-     * @return mixed If the fields all check out then we return true otherwise error messages are returned
-     *                       (indexed by field name);
-     * @throws \EE_Error
-     */
-    public function validate($fields, $context, $messenger, $message_type)
-    {
-
-        $assembled_fields = array();
-
-        // let's loop through all the fields and set them up in the right format
-        foreach ($fields as $index => $value) {
-            // first let's figure out if the value['content'] in the current index is an array.
-            //  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
-            if (is_array($value['content'])) {
-                $assembled_fields[ $value['name'] ] = $value['content']['main'];
-                // loop through the content and get the other fields.
-                foreach ($value['content'] as $name => $val) {
-                    if ($name == 'main') {
-                        continue;
-                    }
-                    $assembled_fields[ $name ] = $val;
-                }
-                continue;
-            }
-
-            // okay if we're here then this is just a straight field=>$value arrangement
-            $assembled_fields[ $value['name'] ] = $value['content'];
-        }
-
-        // now we've got the assembled_fields.
-        // We need to setup the string for the appropriate validator class and call that.
-        $m_ref = ucwords(str_replace('_', ' ', $messenger));
-        $m_ref = str_replace(' ', '_', $m_ref);
-        $mt_ref = ucwords(str_replace('_', ' ', $message_type));
-        $mt_ref = str_replace(' ', '_', $mt_ref);
-
-        $classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
-
-        if (!class_exists($classname)) {
-            $msg[] = __('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                __(
-                    'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
-                    'event_espresso'
-                ),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        $a = new ReflectionClass($classname);
-        $_VLD = $a->newInstance($assembled_fields, $context);
-        $result = $_VLD->validate();
-        return $result;
-    }
-
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @param array $messenger_names    The messenger slugs.
-     *                              If empty then all templates matching the message types are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names     The message type slugs.
-     *                              If empty then all templates matching the messengers are marked inactive.
-     *                              Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     */
-    public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
-    {
-        $query_args = array();
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
-        }
-        return $this->update(array( 'MTP_is_active' => false ), $query_args);
-    }
+	// private instance of the EEM_Message_Template_Group object
+	protected static $_instance = null;
+
+
+
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Message Template Group', 'event_espresso');
+		$this->plural_item = __('Message Template Groups', 'event_espresso');
+		$this->_tables = array(
+			'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID')
+		);
+		$this->_fields = array(
+			'Message_Template_Group' => array(
+				'GRP_ID' => new EE_Primary_Key_Int_Field('GRP_ID', __('Message Template Group ID', 'event_espresso')),
+				'MTP_name' => new EE_Plain_Text_Field('MTP_name', __('The name of the template group', 'event_espresso'), false, ''),
+				'MTP_description' => new EE_Simple_HTML_Field('MTP_description', __('A brief description about this template.', 'event_espresso'), false, ''),
+				'MTP_user_id'=> new EE_WP_User_Field('MTP_user_id', __('Template Creator ID', 'event_espresso'), false, get_current_user_id()),
+				'MTP_messenger'=>new EE_Plain_Text_Field('MTP_messenger', __('Messenger Used for Template', 'event_espresso'), false, 'email'),
+				'MTP_message_type'=>new EE_Plain_Text_Field('MTP_message_type', __('Message Type', 'event_espresso'), false, 'registration'),
+				'MTP_is_global'=>new EE_Boolean_Field('MTP_is_global', __('Flag indicating if Template Group is Global', 'event_espresso'), false, true),
+				'MTP_is_override'=>new EE_Boolean_Field('MTP_is_override', __('Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination', 'event_espresso'), false, false),
+				'MTP_deleted'=>new EE_Trashed_Flag_Field('MTP_deleted', __('Flag indicating whether this has been trashed', 'event_espresso'), false, false),
+				'MTP_is_active'=>new EE_Boolean_Field('MTP_is_active', __('Flag indicating whether template group is active', 'event_espresso'), false, true)
+			)
+		);
+		$this->_model_relations = array(
+			'Message_Template' => new EE_Has_Many_Relation(),
+			'Message' => new EE_Has_Many_Relation(),
+			'Event' => new EE_HABTM_Relation('Event_Message_Template'),
+			'WP_User' => new EE_Belongs_To_Relation()
+		);
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * get_all_trashed_message_templates_by_event
+	 *
+	 * @access public
+	 * @param int    $EVT_ID specific event id
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return array message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		$EVT_ID,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false
+	) {
+		$query_params = array( array('Event.EVT_ID' => $EVT_ID), 'order_by' => array($orderby => $order), 'limit' => $limit );
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * get_all_message_templates_by_messenger
+	 *
+	 * @access public
+	 * @param        $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return array all (including trashed or inactive) message template group objects for the given messenger
+	 */
+	public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
+	{
+		return $this->get_all_deleted_and_undeleted(
+			array( array( 'MTP_messenger' => $messenger ), 'order_by' => array( $orderby => $order ) )
+		);
+	}
+
+
+
+	/**
+	 * This simply adds on any messenger/message type filters that may be present in the $_POST global
+	 * @param  array  $_where any existing where conditions to append these to.
+	 * @return array          original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters($_where = array())
+	{
+		// account for messenger or message type filters
+		if (isset($_REQUEST['ee_messenger_filter_by'])
+			&& $_REQUEST['ee_messenger_filter_by'] != 'none_selected'
+			&& $_REQUEST['ee_messenger_filter_by'] != 'all'
+		) {
+			$_where['MTP_messenger'] =  $_REQUEST['ee_messenger_filter_by'] ;
+		}
+
+		if (isset($_REQUEST['ee_message_type_filter_by'])
+			&& $_REQUEST['ee_message_type_filter_by'] != 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $_REQUEST['ee_message_type_filter_by'];
+		}
+
+		return $_where;
+	}
+
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @param bool   $user_check
+	 * @return array all active (non_trashed, active) message template objects
+	 */
+	public function get_all_active_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true,
+		$user_check = false
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		if ($user_check
+			&& ! $global
+			&& ! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_messages',
+				'get_all_active_message_templates'
+			)
+		) {
+			$_where['MTP_user_id'] = get_current_user_id();
+		}
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 *    retrieve ALL message_template groups from db regardless of wht
+	 *
+	 * @access    public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
+	{
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		$r_templates = $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+
+		return $r_templates;
+	}
+
+
+
+
+	/**
+	 * This gets all the custom templates attached to a specific event
+	 * @param  int      $EVT_ID         event id
+	 * @param  array  $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return  EE_Message_Template_Group[]
+	 */
+	public function get_all_custom_templates_by_event($EVT_ID, $query_params = array())
+	{
+		$where = array_merge($query_params, array( 'Event.EVT_ID' => $EVT_ID ));
+		return $this->get_all(
+			array( $where )
+		);
+	}
+
+
+
+	/**
+	 * get_all_trashed_grouped_message_templates
+	 * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @return \EE_Message_Template_Group[] message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true
+	) {
+		$_where = $global ? array('MTP_is_global' => true ) : array('MTP_is_global' => false );
+		$_where['MTP_is_active'] = true;
+		$_where = $this->_maybe_mtp_filters($_where);
+
+		$query_params = array( $_where, 'order_by' => array($orderby => $order), 'limit' => $limit );
+
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+
+	/**
+	 * this returns the message template group(s) for a given event, messenger, and message template
+	 *
+	 * @param  string             $messenger
+	 * @param  string             $message_type
+	 * @param                     $evt_id
+	 * @param  string             $orderby pointless at this point but still included
+	 * @param  string             $order
+	 * @param  mixed (array|null) $limit   array($offset, $num)
+	 * @param  bool               $count   true = just return count, false = objects
+	 * @param  bool               $active  ignore "active" or not. (default only return active)
+	 * @return \mixed[]) depending on $count.
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		$messenger,
+		$message_type,
+		$evt_id,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'Event.EVT_ID' => $evt_id,
+			'MTP_is_global' => true,
+			'MTP_is_active' => $active
+		);
+
+		$query_params = array( $_where, 'order_by' => array($orderby=>$order), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all GLOBAL message template groups for the given messenger and message type
+	 *
+	 * @param  string $messenger    slug for messenger
+	 * @param  string $message_type slug for message type
+	 * @param  string $orderby      what column to orderby
+	 * @param  string $order        ASC or DESC
+	 * @param  mixed (array|null) $limit array($offset, $num)
+	 * @param  bool   $count        true = just return count, false = objects
+	 * @param  bool   $active       ignore "active" or not. (default only return active) -
+	 *                              'all' means return both inactive AND inactive.
+	 * @return array               message template objects that are global (i.e. non-event)
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		$messenger,
+		$message_type,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = array(
+			'MTP_messenger' => $messenger,
+			'MTP_message_type' => $message_type,
+			'MTP_is_global' => true,
+		);
+
+		if ($active != 'all') {
+			$_where['MTP_is_active'] = $active;
+		}
+
+		$query_params = array( $_where, 'order_by' => array( $orderby => $order ), 'limit' => $limit );
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+
+
+	/**
+	 * get all custom message template groups for the given messenger and message type
+	 * @param  string $messenger    messenger
+	 * @param  string $message_type messagetype
+	 * @param  array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = array())
+	{
+		return $this->get_all(
+			array_merge(
+				$query_params,
+				array(
+					array(
+						'MTP_is_global'    => false,
+						'MTP_messenger'    => $messenger,
+						'MTP_message_type' => $message_type
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param  array $fields the incoming fields to check.
+	 *                       Note this array is in the formatted fields from the form fields setup.
+	 *                       So we need to reformat this into an array of expected field refs by the validator.
+	 *                       Note also that this is not only the fields for the Message Template Group
+	 *                       but ALSO for Message Template.
+	 * @param string $context      The context the fields were obtained from.
+	 * @param string $messenger    The messenger we are validating
+	 * @param string $message_type The message type we are validating.
+	 * @return mixed If the fields all check out then we return true otherwise error messages are returned
+	 *                       (indexed by field name);
+	 * @throws \EE_Error
+	 */
+	public function validate($fields, $context, $messenger, $message_type)
+	{
+
+		$assembled_fields = array();
+
+		// let's loop through all the fields and set them up in the right format
+		foreach ($fields as $index => $value) {
+			// first let's figure out if the value['content'] in the current index is an array.
+			//  If it is then this is special fields that are used in parsing special shortcodes (i.e. 'attendee_list').
+			if (is_array($value['content'])) {
+				$assembled_fields[ $value['name'] ] = $value['content']['main'];
+				// loop through the content and get the other fields.
+				foreach ($value['content'] as $name => $val) {
+					if ($name == 'main') {
+						continue;
+					}
+					$assembled_fields[ $name ] = $val;
+				}
+				continue;
+			}
+
+			// okay if we're here then this is just a straight field=>$value arrangement
+			$assembled_fields[ $value['name'] ] = $value['content'];
+		}
+
+		// now we've got the assembled_fields.
+		// We need to setup the string for the appropriate validator class and call that.
+		$m_ref = ucwords(str_replace('_', ' ', $messenger));
+		$m_ref = str_replace(' ', '_', $m_ref);
+		$mt_ref = ucwords(str_replace('_', ' ', $message_type));
+		$mt_ref = str_replace(' ', '_', $mt_ref);
+
+		$classname = 'EE_Messages_' . $m_ref . '_' . $mt_ref . '_Validator';
+
+		if (!class_exists($classname)) {
+			$msg[] = __('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				__(
+					'The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class',
+					'event_espresso'
+				),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		$a = new ReflectionClass($classname);
+		$_VLD = $a->newInstance($assembled_fields, $context);
+		$result = $_VLD->validate();
+		return $result;
+	}
+
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @param array $messenger_names    The messenger slugs.
+	 *                              If empty then all templates matching the message types are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names     The message type slugs.
+	 *                              If empty then all templates matching the messengers are marked inactive.
+	 *                              Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 */
+	public function deactivate_message_template_groups_for($messenger_names = array(), $message_type_names = array())
+	{
+		$query_args = array();
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = array( 'IN', (array) $messenger_names );
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = array( 'IN', (array) $message_type_names );
+		}
+		return $this->update(array( 'MTP_is_active' => false ), $query_args);
+	}
 }