eventespresso / event-espresso-core

core/services/helpers/datetime/AbstractHelper.php

Indentation +245 added lines, -245 removed lines

@@ -12,136 +12,136 @@ 
 {
 
 
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @return string
-     * @throws EE_Error
-     */
-    public function getValidTimezoneString($timezone_string = '')
-    {
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
-        $timezone_string = ! empty($timezone_string)
-            ? $timezone_string
-            : $this->getTimezoneStringFromGmtOffset();
-        $this->validateTimezone($timezone_string);
-        return $timezone_string;
-    }
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getValidTimezoneString($timezone_string = '')
+	{
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
+		$timezone_string = ! empty($timezone_string)
+			? $timezone_string
+			: $this->getTimezoneStringFromGmtOffset();
+		$this->validateTimezone($timezone_string);
+		return $timezone_string;
+	}
 
 
 
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     * @throws EE_Error
-     */
-    public function validateTimezone($timezone_string, $throw_error = true)
-    {
-        // easiest way to test a timezone string is just see if it throws an error when you try to create a
-        // DateTimeZone object with it
-        try {
-            new DateTimeZone($timezone_string);
-        } catch (Exception $e) {
-            // sometimes we take exception to exceptions
-            if (! $throw_error) {
-                return false;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                        'event_espresso'
-                    ),
-                    $timezone_string,
-                    '<a href="http://www.php.net/manual/en/timezones.php">',
-                    '</a>'
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true)
+	{
+		// easiest way to test a timezone string is just see if it throws an error when you try to create a
+		// DateTimeZone object with it
+		try {
+			new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
+			// sometimes we take exception to exceptions
+			if (! $throw_error) {
+				return false;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+						'event_espresso'
+					),
+					$timezone_string,
+					'<a href="http://www.php.net/manual/en/timezones.php">',
+					'</a>'
+				)
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset()
-    {
-        $timezone_string = (string) get_option('timezone_string');
-        if ($timezone_string) {
-            try {
-                $timezone = new DateTimeZone($timezone_string);
-                return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
-            } catch (Exception $e) {
-            }
-        }
-        $offset = get_option('gmt_offset');
-        return (int) ($offset * HOUR_IN_SECONDS);
-    }
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset()
+	{
+		$timezone_string = (string) get_option('timezone_string');
+		if ($timezone_string) {
+			try {
+				$timezone = new DateTimeZone($timezone_string);
+				return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
+			} catch (Exception $e) {
+			}
+		}
+		$offset = get_option('gmt_offset');
+		return (int) ($offset * HOUR_IN_SECONDS);
+	}
 
 
-    /**
-     * Get Timezone offset for given timezone object
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null|int     $time
-     * @return int
-     * @throws DomainException
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
-    {
-        $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
-                    print_r($transition, true)
-                )
-            );
-        }
-        return $transition['offset'];
-    }
+	/**
+	 * Get Timezone offset for given timezone object
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int     $time
+	 * @return int
+	 * @throws DomainException
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
+	{
+		$transition = $this->getTimezoneTransitions($date_time_zone, $time);
+		if (! isset($transition['offset'])) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
+					print_r($transition, true)
+				)
+			);
+		}
+		return $transition['offset'];
+	}
 
 
-    /**
-     * Provide a timezone select input
-     *
-     * @param string $timezone_string
-     * @return string
-     * @throws EE_Error
-     */
-    public function timezoneSelectInput($timezone_string = '')
-    {
-        // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
-        // if passed a value, then use that, else get WP option
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
-        // check if the timezone is valid but don't throw any errors if it isn't
-        $timezone_string = $this->validateTimezone($timezone_string, false)
-            ? $timezone_string
-            : '';
-        $gmt_offset      = get_option('gmt_offset');
-        $check_zone_info = true;
-        if (empty($timezone_string)) {
-            // Create a UTC+- zone if no timezone string exists
-            $timezone_string = 'UTC';
-            $check_zone_info = false;
-            if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
-            } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
-            }
-        }
-        ?>
+	/**
+	 * Provide a timezone select input
+	 *
+	 * @param string $timezone_string
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function timezoneSelectInput($timezone_string = '')
+	{
+		// get WP date time format
+		$datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+		// if passed a value, then use that, else get WP option
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
+		// check if the timezone is valid but don't throw any errors if it isn't
+		$timezone_string = $this->validateTimezone($timezone_string, false)
+			? $timezone_string
+			: '';
+		$gmt_offset      = get_option('gmt_offset');
+		$check_zone_info = true;
+		if (empty($timezone_string)) {
+			// Create a UTC+- zone if no timezone string exists
+			$timezone_string = 'UTC';
+			$check_zone_info = false;
+			if ($gmt_offset > 0) {
+				$timezone_string = 'UTC+' . $gmt_offset;
+			} elseif ($gmt_offset < 0) {
+				$timezone_string = 'UTC' . $gmt_offset;
+			}
+		}
+		?>
         <p>
             <label for="timezone_string"><?php _e('timezone', 'event_espresso'); ?></label>
             <select id="timezone_string" name="timezone_string">
@@ -154,150 +154,150 @@ 
         <p>
         <span>
             <?php
-            printf(
-                __('%1$sUTC%2$s time is %3$s', 'event_espresso'),
-                '<abbr title="Coordinated Universal Time">',
-                '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
-            );
-            ?></span>
+			printf(
+				__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
+				'<abbr title="Coordinated Universal Time">',
+				'</abbr>',
+				'<code>' . date_i18n($datetime_format, false, true) . '</code>'
+			);
+			?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+		if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
         <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
     <?php
-        endif; ?>
+		endif; ?>
 
         <?php
-        if ($check_zone_info && $timezone_string) : ?>
+		if ($check_zone_info && $timezone_string) : ?>
         <br/>
         <span>
                 <?php
-                // Set TZ so localtime works.
-                date_default_timezone_set($timezone_string);
-                $now = localtime(time(), true);
-                if ($now['tm_isdst']) {
-                    _e('This timezone is currently in daylight saving time.', 'event_espresso');
-                } else {
-                    _e('This timezone is currently in standard time.', 'event_espresso');
-                }
-                ?>
+				// Set TZ so localtime works.
+				date_default_timezone_set($timezone_string);
+				$now = localtime(time(), true);
+				if ($now['tm_isdst']) {
+					_e('This timezone is currently in daylight saving time.', 'event_espresso');
+				} else {
+					_e('This timezone is currently in standard time.', 'event_espresso');
+				}
+				?>
             <br/>
             <?php
-            if (function_exists('timezone_transitions_get')) {
-                $found                   = false;
-                $date_time_zone_selected = new DateTimeZone($timezone_string);
-                $tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
-                $right_now               = time();
-                $tr['isdst']             = false;
-                foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
-                    if ($tr['ts'] > $right_now) {
-                        $found = true;
-                        break;
-                    }
-                }
-                if ($found) {
-                    $message = $tr['isdst']
-                        ? __(' Daylight saving time begins on: %s.', 'event_espresso')
-                        : __(' Standard time begins  on: %s.', 'event_espresso');
-                    // Add the difference between the current offset and the new offset to ts to get the correct
-                    // transition time from date_i18n().
-                    printf(
-                        $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
-                    );
-                } else {
-                    _e('This timezone does not observe daylight saving time.', 'event_espresso');
-                }
-            }
-            // Set back to UTC.
-            date_default_timezone_set('UTC');
-            ?>
+			if (function_exists('timezone_transitions_get')) {
+				$found                   = false;
+				$date_time_zone_selected = new DateTimeZone($timezone_string);
+				$tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
+				$right_now               = time();
+				$tr['isdst']             = false;
+				foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
+					if ($tr['ts'] > $right_now) {
+						$found = true;
+						break;
+					}
+				}
+				if ($found) {
+					$message = $tr['isdst']
+						? __(' Daylight saving time begins on: %s.', 'event_espresso')
+						: __(' Standard time begins  on: %s.', 'event_espresso');
+					// Add the difference between the current offset and the new offset to ts to get the correct
+					// transition time from date_i18n().
+					printf(
+						$message,
+						'<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+					);
+				} else {
+					_e('This timezone does not observe daylight saving time.', 'event_espresso');
+				}
+			}
+			// Set back to UTC.
+			date_default_timezone_set('UTC');
+			?>
         </span></p>
         <?php
-        endif;
-    }
+		endif;
+	}
 
 
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp  if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     * @throws EE_Error
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
-    {
-        $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
-        $timezone_string = $this->getValidTimezoneString($timezone_string);
-        $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
-        $offset          = timezone_offset_get($TimeZone, $DateTime);
-        return (int) $DateTime->format('U') + (int) $offset;
-    }
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp  if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 * @throws EE_Error
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
+	{
+		$unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
+		$timezone_string = $this->getValidTimezoneString($timezone_string);
+		$TimeZone        = new DateTimeZone($timezone_string);
+		$DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+		$offset          = timezone_offset_get($TimeZone, $DateTime);
+		return (int) $DateTime->format('U') + (int) $offset;
+	}
 
 
-    /**
-     * Get Timezone Transitions
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array|mixed
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
-    {
-        $time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
-        $time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        $transitions = $date_time_zone->getTransitions($time);
-        return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
-    }
+	/**
+	 * Get Timezone Transitions
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array|mixed
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
+	{
+		$time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
+		$time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		$transitions = $date_time_zone->getTransitions($time);
+		return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
+	}
 
 
 
-    /**
-     * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset = 0)
-    {
-        return $gmt_offset;
-    }
+	/**
+	 * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset = 0)
+	{
+		return $gmt_offset;
+	}
 
 
 
-    /**
-     * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
-     * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
-     * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
-     * offset.
-     * @param  float|string $gmt_offset
-     * @return float|string
-     */
-    protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
-    {
-        // if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
-        // set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
-        // that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
-        if ($gmt_offset === '') {
-            // autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
-            if (get_option('timezone_string')) {
-                return (string) get_option('timezone_string');
-            }
-        }
-        $gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
-        $gmt_offset = (float) $gmt_offset;
-        // if $gmt_offset is 0 or is still an empty string, then just return UTC
-        if ($gmt_offset === (float) 0) {
-            return 'UTC';
-        }
-        return $gmt_offset;
-    }
+	/**
+	 * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
+	 * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
+	 * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
+	 * offset.
+	 * @param  float|string $gmt_offset
+	 * @return float|string
+	 */
+	protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
+	{
+		// if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
+		// set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
+		// that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
+		if ($gmt_offset === '') {
+			// autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
+			if (get_option('timezone_string')) {
+				return (string) get_option('timezone_string');
+			}
+		}
+		$gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
+		$gmt_offset = (float) $gmt_offset;
+		// if $gmt_offset is 0 or is still an empty string, then just return UTC
+		if ($gmt_offset === (float) 0) {
+			return 'UTC';
+		}
+		return $gmt_offset;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -48,7 +48,7 @@ 
             new DateTimeZone($timezone_string);
         } catch (Exception $e) {
             // sometimes we take exception to exceptions
-            if (! $throw_error) {
+            if ( ! $throw_error) {
                 return false;
             }
             throw new EE_Error(
@@ -100,7 +100,7 @@ 
     public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
     {
         $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
+        if ( ! isset($transition['offset'])) {
             throw new DomainException(
                 sprintf(
                     esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
@@ -122,7 +122,7 @@ 
     public function timezoneSelectInput($timezone_string = '')
     {
         // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+        $datetime_format = get_option('date_format').' '.get_option('time_format');
         // if passed a value, then use that, else get WP option
         $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
         // check if the timezone is valid but don't throw any errors if it isn't
@@ -136,9 +136,9 @@ 
             $timezone_string = 'UTC';
             $check_zone_info = false;
             if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
+                $timezone_string = 'UTC+'.$gmt_offset;
             } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
+                $timezone_string = 'UTC'.$gmt_offset;
             }
         }
         ?>
@@ -158,12 +158,12 @@ 
                 __('%1$sUTC%2$s time is %3$s', 'event_espresso'),
                 '<abbr title="Coordinated Universal Time">',
                 '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
+                '<code>'.date_i18n($datetime_format, false, true).'</code>'
             );
             ?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
-        <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
+        if ( ! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+        <br/><span><?php printf(__('Local time is %1$s', 'event_espresso'), '<code>'.date_i18n($datetime_format).'</code>'); ?></span>
     <?php
         endif; ?>
 
@@ -203,7 +203,7 @@ 
                     // transition time from date_i18n().
                     printf(
                         $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+                        '<code >'.date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])).'</code >'
                     );
                 } else {
                     _e('This timezone does not observe daylight saving time.', 'event_espresso');
@@ -236,7 +236,7 @@ 
         $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
         $timezone_string = $this->getValidTimezoneString($timezone_string);
         $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+        $DateTime        = new DateTime('@'.$unix_timestamp, $TimeZone);
         $offset          = timezone_offset_get($TimeZone, $DateTime);
         return (int) $DateTime->format('U') + (int) $offset;
     }

core/EE_Log.core.php

Indentation +257 added lines, -257 removed lines

@@ -17,261 +17,261 @@
 class EE_Log
 {
 
-    /**
-     * @var string
-     */
-    private $_logs_folder = '';
-
-    /**
-     * @var string
-     */
-    private $_log_file = '';
-
-    /**
-     * @var string
-     */
-    private $_log = '';
-
-    /**
-     * @var string
-     */
-    private $_debug_file = '';
-
-    /**
-     * @var string
-     */
-    private $_debug_log = '';
-
-    /**
-     * Used for remote logging
-     *
-     * @var string
-     */
-    private $_remote_logging_url = '';
-
-    /**
-     * @var string
-     */
-    private $_remote_log = '';
-
-    /**
-     * @var EE_Log
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Log
-     */
-    public static function instance()
-    {
-        if (! self::$_instance instanceof EE_Log) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * @access private
-     * @return EE_Log
-     */
-    private function __construct()
-    {
-
-        if (! EE_Registry::instance()->CFG->admin->use_full_logging
-            && ! EE_Registry::instance()->CFG->admin->use_remote_logging) {
-            return;
-        }
-
-        $this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS;
-        $this->_log_file = EE_Registry::instance()->CFG->admin->log_file_name();
-        $this->_log = '';
-        $this->_debug_file = EE_Registry::instance()->CFG->admin->debug_file_name();
-        $this->_debug_log = '';
-        $this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url;
-        $this->_remote_log = '';
-
-        add_action('admin_init', array($this, 'verify_filesystem'), -10);
-        add_action('AHEE_log', array($this, 'log'), 10, 4);
-        if (EE_Registry::instance()->CFG->admin->use_full_logging) {
-            add_action('shutdown', array($this, 'write_log'), 9999);
-            // if WP_DEBUG
-            add_action('shutdown', array($this, 'write_debug'), 9999);
-        }
-        if (EE_Registry::instance()->CFG->admin->use_remote_logging) {
-            add_action('shutdown', array($this, 'send_log'), 9999);
-        }
-    }
-
-
-    /**
-     *    verify_filesystem
-     * tests that the required files and folders exist and are writable
-     *
-     */
-    public function verify_filesystem()
-    {
-        try {
-            EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_log_file);
-            EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_debug_file);
-            EEH_File::add_htaccess_deny_from_all($this->_logs_folder);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    __('Event Espresso logging could not be setup because: %s', 'event_espresso'),
-                    '     ' . $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-    }
-
-
-    /**
-     *    _format_message
-     *    makes yer log entries look all purdy
-     *
-     * @param string $file
-     * @param string $function
-     * @param string $message
-     * @param string $type
-     * @return string
-     */
-    private function _format_message($file = '', $function = '', $message = '', $type = '')
-    {
-        $msg = '----------------------------------------------------------------------------------------' . PHP_EOL;
-        $msg .= '[' . current_time('mysql') . '] ';
-        $msg .= ! empty($file) ? basename($file) : '';
-        $msg .= ! empty($file) && ! empty($function) ? ' -> ' : '';
-        $msg .= ! empty($function) ? $function . '()' : '';
-        $msg .= PHP_EOL;
-        $type = ! empty($type) ? $type : 'log message';
-        $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : '';
-        return $msg;
-    }
-
-
-    /**
-     *    log
-     * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the
-     * EE_Log::write_log() callback
-     *
-     * @param string $file
-     * @param string $function
-     * @param string $message
-     * @param string $type
-     */
-    public function log($file = '', $function = '', $message = '', $type = '')
-    {
-        $this->_log .= $this->_format_message($file, $function, $message, $type);
-    }
-
-
-    /**
-     * write_log
-     * appends the results of the 'AHEE_log' filter to the espresso log file
-     */
-    public function write_log()
-    {
-        try {
-            // get existing log file and append new log info
-            $this->_log = EEH_File::get_file_contents($this->_logs_folder . $this->_log_file) . $this->_log;
-            EEH_File::write_to_file($this->_logs_folder . $this->_log_file, $this->_log, 'Event Espresso Log');
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    __('Could not write to the Event Espresso log file because: %s', 'event_espresso'),
-                    '     ' . $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-    }
-
-
-    /**
-     * send_log
-     * sends the espresso log to a remote URL via a PHP cURL request
-     */
-    public function send_log()
-    {
-
-        if (empty($this->_remote_logging_url)) {
-            return;
-        }
-
-        $data = 'domain=' . $_SERVER['HTTP_HOST'];
-        $data .= '&ip=' . $_SERVER['SERVER_ADDR'];
-        $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE'];
-        $data .= '&time=' . time();
-        $data .= '&remote_log=' . $this->_log;
-        $data .= '&request_array=' . json_encode($_REQUEST);
-        $data .= '&action=save';
-
-        if (defined('EELOGGING_PASS')) {
-            $data .= '&pass=' . EELOGGING_PASS;
-        }
-        if (defined('EELOGGING_KEY')) {
-            $data .= '&key=' . EELOGGING_KEY;
-        }
-
-        $c = curl_init($this->_remote_logging_url);
-        curl_setopt($c, CURLOPT_POST, true);
-        curl_setopt($c, CURLOPT_POSTFIELDS, $data);
-        curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
-        curl_exec($c);
-        curl_close($c);
-    }
-
-
-    /**
-     * write_debug
-     * writes the contents of the current request's $_GET and $_POST arrays to a log file.
-     * previous entries are overwritten
-     */
-    public function write_debug()
-    {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            $this->_debug_log = '';
-            foreach ($_GET as $key => $value) {
-                $this->_debug_log .= '$_GET["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL;
-            }
-            foreach ($_POST as $key => $value) {
-                $this->_debug_log .= '$_POST["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL;
-            }
-            try {
-                EEH_File::write_to_file(
-                    $this->_logs_folder . $this->_debug_file,
-                    $this->_debug_log,
-                    'Event Espresso Debug Log'
-                );
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    sprintf(
-                        __('Could not write to the Event Espresso debug log file because: %s', 'event_espresso'),
-                        '     ' . $e->getMessage()
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return;
-            }
-        }
-    }
-
-
-    /**
-     * __clone
-     */
-    public function __clone()
-    {
-        trigger_error(__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR);
-    }
+	/**
+	 * @var string
+	 */
+	private $_logs_folder = '';
+
+	/**
+	 * @var string
+	 */
+	private $_log_file = '';
+
+	/**
+	 * @var string
+	 */
+	private $_log = '';
+
+	/**
+	 * @var string
+	 */
+	private $_debug_file = '';
+
+	/**
+	 * @var string
+	 */
+	private $_debug_log = '';
+
+	/**
+	 * Used for remote logging
+	 *
+	 * @var string
+	 */
+	private $_remote_logging_url = '';
+
+	/**
+	 * @var string
+	 */
+	private $_remote_log = '';
+
+	/**
+	 * @var EE_Log
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Log
+	 */
+	public static function instance()
+	{
+		if (! self::$_instance instanceof EE_Log) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * @access private
+	 * @return EE_Log
+	 */
+	private function __construct()
+	{
+
+		if (! EE_Registry::instance()->CFG->admin->use_full_logging
+			&& ! EE_Registry::instance()->CFG->admin->use_remote_logging) {
+			return;
+		}
+
+		$this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS;
+		$this->_log_file = EE_Registry::instance()->CFG->admin->log_file_name();
+		$this->_log = '';
+		$this->_debug_file = EE_Registry::instance()->CFG->admin->debug_file_name();
+		$this->_debug_log = '';
+		$this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url;
+		$this->_remote_log = '';
+
+		add_action('admin_init', array($this, 'verify_filesystem'), -10);
+		add_action('AHEE_log', array($this, 'log'), 10, 4);
+		if (EE_Registry::instance()->CFG->admin->use_full_logging) {
+			add_action('shutdown', array($this, 'write_log'), 9999);
+			// if WP_DEBUG
+			add_action('shutdown', array($this, 'write_debug'), 9999);
+		}
+		if (EE_Registry::instance()->CFG->admin->use_remote_logging) {
+			add_action('shutdown', array($this, 'send_log'), 9999);
+		}
+	}
+
+
+	/**
+	 *    verify_filesystem
+	 * tests that the required files and folders exist and are writable
+	 *
+	 */
+	public function verify_filesystem()
+	{
+		try {
+			EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_log_file);
+			EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_debug_file);
+			EEH_File::add_htaccess_deny_from_all($this->_logs_folder);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					__('Event Espresso logging could not be setup because: %s', 'event_espresso'),
+					'     ' . $e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+	}
+
+
+	/**
+	 *    _format_message
+	 *    makes yer log entries look all purdy
+	 *
+	 * @param string $file
+	 * @param string $function
+	 * @param string $message
+	 * @param string $type
+	 * @return string
+	 */
+	private function _format_message($file = '', $function = '', $message = '', $type = '')
+	{
+		$msg = '----------------------------------------------------------------------------------------' . PHP_EOL;
+		$msg .= '[' . current_time('mysql') . '] ';
+		$msg .= ! empty($file) ? basename($file) : '';
+		$msg .= ! empty($file) && ! empty($function) ? ' -> ' : '';
+		$msg .= ! empty($function) ? $function . '()' : '';
+		$msg .= PHP_EOL;
+		$type = ! empty($type) ? $type : 'log message';
+		$msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : '';
+		return $msg;
+	}
+
+
+	/**
+	 *    log
+	 * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the
+	 * EE_Log::write_log() callback
+	 *
+	 * @param string $file
+	 * @param string $function
+	 * @param string $message
+	 * @param string $type
+	 */
+	public function log($file = '', $function = '', $message = '', $type = '')
+	{
+		$this->_log .= $this->_format_message($file, $function, $message, $type);
+	}
+
+
+	/**
+	 * write_log
+	 * appends the results of the 'AHEE_log' filter to the espresso log file
+	 */
+	public function write_log()
+	{
+		try {
+			// get existing log file and append new log info
+			$this->_log = EEH_File::get_file_contents($this->_logs_folder . $this->_log_file) . $this->_log;
+			EEH_File::write_to_file($this->_logs_folder . $this->_log_file, $this->_log, 'Event Espresso Log');
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					__('Could not write to the Event Espresso log file because: %s', 'event_espresso'),
+					'     ' . $e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+	}
+
+
+	/**
+	 * send_log
+	 * sends the espresso log to a remote URL via a PHP cURL request
+	 */
+	public function send_log()
+	{
+
+		if (empty($this->_remote_logging_url)) {
+			return;
+		}
+
+		$data = 'domain=' . $_SERVER['HTTP_HOST'];
+		$data .= '&ip=' . $_SERVER['SERVER_ADDR'];
+		$data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE'];
+		$data .= '&time=' . time();
+		$data .= '&remote_log=' . $this->_log;
+		$data .= '&request_array=' . json_encode($_REQUEST);
+		$data .= '&action=save';
+
+		if (defined('EELOGGING_PASS')) {
+			$data .= '&pass=' . EELOGGING_PASS;
+		}
+		if (defined('EELOGGING_KEY')) {
+			$data .= '&key=' . EELOGGING_KEY;
+		}
+
+		$c = curl_init($this->_remote_logging_url);
+		curl_setopt($c, CURLOPT_POST, true);
+		curl_setopt($c, CURLOPT_POSTFIELDS, $data);
+		curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
+		curl_exec($c);
+		curl_close($c);
+	}
+
+
+	/**
+	 * write_debug
+	 * writes the contents of the current request's $_GET and $_POST arrays to a log file.
+	 * previous entries are overwritten
+	 */
+	public function write_debug()
+	{
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			$this->_debug_log = '';
+			foreach ($_GET as $key => $value) {
+				$this->_debug_log .= '$_GET["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL;
+			}
+			foreach ($_POST as $key => $value) {
+				$this->_debug_log .= '$_POST["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL;
+			}
+			try {
+				EEH_File::write_to_file(
+					$this->_logs_folder . $this->_debug_file,
+					$this->_debug_log,
+					'Event Espresso Debug Log'
+				);
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					sprintf(
+						__('Could not write to the Event Espresso debug log file because: %s', 'event_espresso'),
+						'     ' . $e->getMessage()
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return;
+			}
+		}
+	}
+
+
+	/**
+	 * __clone
+	 */
+	public function __clone()
+	{
+		trigger_error(__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR);
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -65,7 +65,7 @@ 
      */
     public static function instance()
     {
-        if (! self::$_instance instanceof EE_Log) {
+        if ( ! self::$_instance instanceof EE_Log) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -78,12 +78,12 @@ 
     private function __construct()
     {
 
-        if (! EE_Registry::instance()->CFG->admin->use_full_logging
+        if ( ! EE_Registry::instance()->CFG->admin->use_full_logging
             && ! EE_Registry::instance()->CFG->admin->use_remote_logging) {
             return;
         }
 
-        $this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS;
+        $this->_logs_folder = EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS;
         $this->_log_file = EE_Registry::instance()->CFG->admin->log_file_name();
         $this->_log = '';
         $this->_debug_file = EE_Registry::instance()->CFG->admin->debug_file_name();
@@ -112,14 +112,14 @@ 
     public function verify_filesystem()
     {
         try {
-            EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_log_file);
-            EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder . $this->_debug_file);
+            EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder.$this->_log_file);
+            EEH_File::ensure_file_exists_and_is_writable($this->_logs_folder.$this->_debug_file);
             EEH_File::add_htaccess_deny_from_all($this->_logs_folder);
         } catch (EE_Error $e) {
             EE_Error::add_error(
                 sprintf(
                     __('Event Espresso logging could not be setup because: %s', 'event_espresso'),
-                    '     ' . $e->getMessage()
+                    '     '.$e->getMessage()
                 ),
                 __FILE__,
                 __FUNCTION__,
@@ -142,14 +142,14 @@ 
      */
     private function _format_message($file = '', $function = '', $message = '', $type = '')
     {
-        $msg = '----------------------------------------------------------------------------------------' . PHP_EOL;
-        $msg .= '[' . current_time('mysql') . '] ';
+        $msg = '----------------------------------------------------------------------------------------'.PHP_EOL;
+        $msg .= '['.current_time('mysql').'] ';
         $msg .= ! empty($file) ? basename($file) : '';
         $msg .= ! empty($file) && ! empty($function) ? ' -> ' : '';
-        $msg .= ! empty($function) ? $function . '()' : '';
+        $msg .= ! empty($function) ? $function.'()' : '';
         $msg .= PHP_EOL;
         $type = ! empty($type) ? $type : 'log message';
-        $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : '';
+        $msg .= ! empty($message) ? "\t".'['.$type.'] '.$message.PHP_EOL : '';
         return $msg;
     }
 
@@ -178,13 +178,13 @@ 
     {
         try {
             // get existing log file and append new log info
-            $this->_log = EEH_File::get_file_contents($this->_logs_folder . $this->_log_file) . $this->_log;
-            EEH_File::write_to_file($this->_logs_folder . $this->_log_file, $this->_log, 'Event Espresso Log');
+            $this->_log = EEH_File::get_file_contents($this->_logs_folder.$this->_log_file).$this->_log;
+            EEH_File::write_to_file($this->_logs_folder.$this->_log_file, $this->_log, 'Event Espresso Log');
         } catch (EE_Error $e) {
             EE_Error::add_error(
                 sprintf(
                     __('Could not write to the Event Espresso log file because: %s', 'event_espresso'),
-                    '     ' . $e->getMessage()
+                    '     '.$e->getMessage()
                 ),
                 __FILE__,
                 __FUNCTION__,
@@ -206,19 +206,19 @@ 
             return;
         }
 
-        $data = 'domain=' . $_SERVER['HTTP_HOST'];
-        $data .= '&ip=' . $_SERVER['SERVER_ADDR'];
-        $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE'];
-        $data .= '&time=' . time();
-        $data .= '&remote_log=' . $this->_log;
-        $data .= '&request_array=' . json_encode($_REQUEST);
+        $data = 'domain='.$_SERVER['HTTP_HOST'];
+        $data .= '&ip='.$_SERVER['SERVER_ADDR'];
+        $data .= '&server_type='.$_SERVER['SERVER_SOFTWARE'];
+        $data .= '&time='.time();
+        $data .= '&remote_log='.$this->_log;
+        $data .= '&request_array='.json_encode($_REQUEST);
         $data .= '&action=save';
 
         if (defined('EELOGGING_PASS')) {
-            $data .= '&pass=' . EELOGGING_PASS;
+            $data .= '&pass='.EELOGGING_PASS;
         }
         if (defined('EELOGGING_KEY')) {
-            $data .= '&key=' . EELOGGING_KEY;
+            $data .= '&key='.EELOGGING_KEY;
         }
 
         $c = curl_init($this->_remote_logging_url);
@@ -240,14 +240,14 @@ 
         if (defined('WP_DEBUG') && WP_DEBUG) {
             $this->_debug_log = '';
             foreach ($_GET as $key => $value) {
-                $this->_debug_log .= '$_GET["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL;
+                $this->_debug_log .= '$_GET["'.$key.'"] = "'.serialize($value).'"'.PHP_EOL;
             }
             foreach ($_POST as $key => $value) {
-                $this->_debug_log .= '$_POST["' . $key . '"] = "' . serialize($value) . '"' . PHP_EOL;
+                $this->_debug_log .= '$_POST["'.$key.'"] = "'.serialize($value).'"'.PHP_EOL;
             }
             try {
                 EEH_File::write_to_file(
-                    $this->_logs_folder . $this->_debug_file,
+                    $this->_logs_folder.$this->_debug_file,
                     $this->_debug_log,
                     'Event Espresso Debug Log'
                 );
@@ -255,7 +255,7 @@ 
                 EE_Error::add_error(
                     sprintf(
                         __('Could not write to the Event Espresso debug log file because: %s', 'event_espresso'),
-                        '     ' . $e->getMessage()
+                        '     '.$e->getMessage()
                     ),
                     __FILE__,
                     __FUNCTION__,

core/data_migration_scripts/EE_Data_Migration_Script_Base.core.php

Indentation +876 added lines, -876 removed lines

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

Spacing +25 added lines, -25 removed lines

@@ -130,7 +130,7 @@ 
     public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
     {
         $this->_migration_stages = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__construct__migration_stages',
+            'FHEE__'.get_class($this).'__construct__migration_stages',
             $this->_migration_stages
         );
         foreach ($this->_migration_stages as $migration_stage) {
@@ -165,10 +165,10 @@ 
     public function set_mapping($old_table, $old_pk, $new_table, $new_pk)
     {
         // make sure it has the needed keys
-        if (! isset($this->_mappings[ $old_table ]) || ! isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+        if ( ! isset($this->_mappings[$old_table]) || ! isset($this->_mappings[$old_table][$new_table])) {
+            $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table);
         }
-        $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] = $new_pk;
+        $this->_mappings[$old_table][$new_table][$old_pk] = $new_pk;
     }
 
 
@@ -183,13 +183,13 @@ 
      */
     public function get_mapping_new_pk($old_table, $old_pk, $new_table)
     {
-        if (! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])) {
+        if ( ! isset($this->_mappings[$old_table]) ||
+            ! isset($this->_mappings[$old_table][$new_table])) {
             // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+            $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table);
         }
-        return isset($this->_mappings[ $old_table ][ $new_table ][ $old_pk ])
-            ? $this->_mappings[ $old_table ][ $new_table ][ $old_pk ] : null;
+        return isset($this->_mappings[$old_table][$new_table][$old_pk])
+            ? $this->_mappings[$old_table][$new_table][$old_pk] : null;
     }
 
 
@@ -204,15 +204,15 @@ 
      */
     public function get_mapping_old_pk($old_table, $new_table, $new_pk)
     {
-        if (! isset($this->_mappings[ $old_table ]) ||
-            ! isset($this->_mappings[ $old_table ][ $new_table ])) {
+        if ( ! isset($this->_mappings[$old_table]) ||
+            ! isset($this->_mappings[$old_table][$new_table])) {
             // try fetching the option
-            $this->_mappings[ $old_table ][ $new_table ] = $this->_get_mapping_option($old_table, $new_table);
+            $this->_mappings[$old_table][$new_table] = $this->_get_mapping_option($old_table, $new_table);
         }
-        if (isset($this->_mappings[ $old_table ][ $new_table ])) {
-            $new_pk_to_old_pk = array_flip($this->_mappings[ $old_table ][ $new_table ]);
-            if (isset($new_pk_to_old_pk[ $new_pk ])) {
-                return $new_pk_to_old_pk[ $new_pk ];
+        if (isset($this->_mappings[$old_table][$new_table])) {
+            $new_pk_to_old_pk = array_flip($this->_mappings[$old_table][$new_table]);
+            if (isset($new_pk_to_old_pk[$new_pk])) {
+                return $new_pk_to_old_pk[$new_pk];
             }
         }
         return null;
@@ -262,7 +262,7 @@ 
         $new_table_name_sans_wp = str_replace($wpdb->prefix, "", $new_table_name);
         $migrates_to = EE_Data_Migration_Manager::instance()->script_migrates_to_version(get_class($this));
         return substr(
-            EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix . $migrates_to ['slug'] . '_' . $migrates_to['version'] . '_' . $old_table_name_sans_wp . '_' . $new_table_name_sans_wp,
+            EE_Data_Migration_Manager::data_migration_script_mapping_option_prefix.$migrates_to ['slug'].'_'.$migrates_to['version'].'_'.$old_table_name_sans_wp.'_'.$new_table_name_sans_wp,
             0,
             64
         );
@@ -334,12 +334,12 @@ 
                         $num_records_to_migrate_limit - $num_records_actually_migrated
                     );
                     $num_records_actually_migrated += $records_migrated_during_stage;
-                    $records_migrated_per_stage[ $stage->pretty_name() ] = $records_migrated_during_stage;
+                    $records_migrated_per_stage[$stage->pretty_name()] = $records_migrated_during_stage;
                 } catch (Exception $e) {
                     // yes if we catch an exception here, we consider that migration stage borked.
                     $stage->set_status(EE_Data_Migration_Manager::status_fatal_error);
                     $this->set_status(EE_Data_Migration_Manager::status_fatal_error);
-                    $stage->add_error($e->getMessage() . ". Stack-trace:" . $e->getTraceAsString());
+                    $stage->add_error($e->getMessage().". Stack-trace:".$e->getTraceAsString());
                     throw $e;
                 }
                 // check that the migration stage didn't mark itself as having a fatal error
@@ -411,8 +411,8 @@ 
     private function _maybe_do_schema_changes($before = true)
     {
         // so this property will be either _schema_changes_after_migration_ran or _schema_changes_before_migration_ran
-        $property_name = '_schema_changes_' . ($before ? 'before' : 'after') . '_migration_ran';
-        if (! $this->{$property_name}) {
+        $property_name = '_schema_changes_'.($before ? 'before' : 'after').'_migration_ran';
+        if ( ! $this->{$property_name}) {
             try {
                 ob_start();
                 if ($before) {
@@ -646,7 +646,7 @@ 
         try {
             EEH_Activation::create_table($table_name, $table_definition_sql, $engine_string, $drop_pre_existing_tables);
         } catch (EE_Error $e) {
-            $message = $e->getMessage() . '<br>Stack Trace:' . $e->getTraceAsString();
+            $message = $e->getMessage().'<br>Stack Trace:'.$e->getTraceAsString();
             $this->add_error($message);
             $this->_feedback_message .= $message;
         }
@@ -692,7 +692,7 @@ 
     public function get_errors()
     {
         $all_errors = $this->_errors;
-        if (! is_array($all_errors)) {
+        if ( ! is_array($all_errors)) {
             $all_errors = array();
         }
         foreach ($this->stages() as $stage) {
@@ -726,7 +726,7 @@ 
      */
     protected function stages()
     {
-        $stages = apply_filters('FHEE__' . get_class($this) . '__stages', $this->_migration_stages);
+        $stages = apply_filters('FHEE__'.get_class($this).'__stages', $this->_migration_stages);
         ksort($stages);
         return $stages;
     }
@@ -755,7 +755,7 @@ 
         $properties = parent::properties_as_array();
         $properties['_migration_stages'] = array();
         foreach ($this->_migration_stages as $migration_stage_priority => $migration_stage_class) {
-            $properties['_migration_stages'][ $migration_stage_priority ] = $migration_stage_class->properties_as_array(
+            $properties['_migration_stages'][$migration_stage_priority] = $migration_stage_class->properties_as_array(
             );
         }
         unset($properties['_mappings']);

core/data_migration_scripts/EE_DMS_Core_4_2_0.dms.php

Spacing +6 added lines, -6 removed lines

@@ -12,13 +12,13 @@ 
 // unfortunately, this needs to be done upon INCLUSION of this file,
 // instead of construction, because it only gets constructed on first page load
 // (all other times it gets resurrected from a wordpress option)
-$stages = glob(EE_CORE . 'data_migration_scripts/4_2_0_stages/*');
+$stages = glob(EE_CORE.'data_migration_scripts/4_2_0_stages/*');
 $class_to_filepath = array();
-if (! empty($stages)) {
+if ( ! empty($stages)) {
     foreach ($stages as $filepath) {
         $matches = array();
         preg_match('~4_2_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-        $class_to_filepath[ $matches[1] ] = $filepath;
+        $class_to_filepath[$matches[1]] = $filepath;
     }
 }
 // give addons a chance to autoload their stages too
@@ -57,11 +57,11 @@ 
         if (version_compare($version_string, '4.2.0', '<=') && version_compare($version_string, '4.1.0', '>=')) {
 //          echo "$version_string can be migrated fro";
             return true;
-        } elseif (! $version_string) {
+        } elseif ( ! $version_string) {
 //          echo "no version string provided: $version_string";
             // no version string provided... this must be pre 4.1
             // because since 4.1 we're
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
+            return false; // changed mind. dont want people thinking they should migrate yet because they cant
         } else {
 //          echo "$version_string doesnt apply";
             return false;
@@ -73,7 +73,7 @@ 
     public function schema_changes_before_migration()
     {
         // relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+        require_once(EE_HELPERS.'EEH_Activation.helper.php');
         $table_name = 'esp_answer';
         $sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT UNSIGNED NOT NULL,

Indentation +148 added lines, -148 removed lines

@@ -15,11 +15,11 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_2_0_stages/*');
 $class_to_filepath = array();
 if (! empty($stages)) {
-    foreach ($stages as $filepath) {
-        $matches = array();
-        preg_match('~4_2_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-        $class_to_filepath[ $matches[1] ] = $filepath;
-    }
+	foreach ($stages as $filepath) {
+		$matches = array();
+		preg_match('~4_2_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+		$class_to_filepath[ $matches[1] ] = $filepath;
+	}
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_2_0__autoloaded_stages', $class_to_filepath);
@@ -32,57 +32,57 @@ 
 
 
 
-    /**
-     * EE_DMS_Core_4_2_0 constructor.
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.2.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_2_0_question_group_questions(),
-            new EE_DMS_4_2_0_datetime_fields(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 * EE_DMS_Core_4_2_0 constructor.
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.2.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_2_0_question_group_questions(),
+			new EE_DMS_4_2_0_datetime_fields(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
 
 
 
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.2.0', '<=') && version_compare($version_string, '4.1.0', '>=')) {
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.2.0', '<=') && version_compare($version_string, '4.1.0', '>=')) {
 //          echo "$version_string can be migrated fro";
-            return true;
-        } elseif (! $version_string) {
+			return true;
+		} elseif (! $version_string) {
 //          echo "no version string provided: $version_string";
-            // no version string provided... this must be pre 4.1
-            // because since 4.1 we're
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
+			// no version string provided... this must be pre 4.1
+			// because since 4.1 we're
+			return false;// changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //          echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+			return false;
+		}
+	}
 
 
 
-    public function schema_changes_before_migration()
-    {
-        // relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+	public function schema_changes_before_migration()
+	{
+		// relies on 4.1's EEH_Activation::create_table
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					ANS_value TEXT NOT NULL,
 					PRIMARY KEY  (ANS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID INT(10) UNSIGNED NOT	NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "ATTM_ID INT(10) UNSIGNED NOT	NULL AUTO_INCREMENT,
 						ATT_ID BIGINT(20) UNSIGNED NOT NULL,
 						ATT_fname VARCHAR(45) NOT NULL,
 						ATT_lname VARCHAR(45) NOT	NULL,
@@ -98,9 +98,9 @@ 
 								KEY ATT_fname (ATT_fname),
 								KEY ATT_lname (ATT_lname),
 								KEY ATT_email (ATT_email(191))";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  CNT_ISO3 VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  RGN_ID TINYINT(3) UNSIGNED DEFAULT NULL,
 					  CNT_name VARCHAR(45) COLLATE utf8_bin NOT NULL,
@@ -116,9 +116,9 @@ 
 					  CNT_is_EU TINYINT(1) DEFAULT '0',
 					  CNT_active TINYINT(1) DEFAULT '0',
 					  PRIMARY KEY  (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 				  EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 				  DTT_name VARCHAR(255) NOT NULL DEFAULT '',
 				  DTT_description TEXT NOT NULL,
@@ -133,9 +133,9 @@ 
 						PRIMARY KEY  (DTT_ID),
 						KEY EVT_ID (EVT_ID),
 						KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "
 			EVTM_ID INT NOT NULL AUTO_INCREMENT,
 			EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 			EVT_display_desc TINYINT(1) UNSIGNED NOT NULL DEFAULT 1,
@@ -150,31 +150,31 @@ 
 			EVT_external_URL VARCHAR(200) NULL,
 			EVT_donations TINYINT(1) NULL,
 			PRIMARY KEY  (EVTM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 					QSG_ID INT UNSIGNED NOT NULL,
 					EQG_primary TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EQG_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID INT(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 				VNU_ID BIGINT(20) UNSIGNED NOT NULL,
 				EVV_primary TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID INT(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID INT(11) DEFAULT NULL,
 				EXM_type VARCHAR(45) DEFAULT NULL,
 				EXM_key VARCHAR(45) DEFAULT NULL,
 				EXM_value TEXT,
 				PRIMARY KEY  (EXM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
 				LIN_code VARCHAR(245) NOT NULL DEFAULT '',
 				TXN_ID INT(11) DEFAULT NULL,
 				LIN_name VARCHAR(245) NOT NULL DEFAULT '',
@@ -190,18 +190,18 @@ 
 				OBJ_ID INT(11) DEFAULT NULL,
 				OBJ_type VARCHAR(45)DEFAULT NULL,
 				PRIMARY KEY  (LIN_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					GRP_ID INT(10) UNSIGNED NOT NULL,
 					MTP_context VARCHAR(50) NOT NULL,
 					MTP_template_field VARCHAR(30) NOT NULL,
 					MTP_content TEXT NOT NULL,
 					PRIMARY KEY  (MTP_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					EVT_ID BIGINT(20) UNSIGNED DEFAULT NULL,
 					MTP_user_id INT(10) NOT NULL DEFAULT '1',
 					MTP_messenger VARCHAR(30) NOT NULL,
@@ -213,9 +213,9 @@ 
 					PRIMARY KEY  (GRP_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY MTP_user_id (MTP_user_id)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					TXN_ID INT(10) UNSIGNED DEFAULT NULL,
 					STS_ID VARCHAR(3) COLLATE utf8_bin DEFAULT NULL,
 					PAY_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -231,9 +231,9 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY TXN_ID (TXN_ID),
 					KEY PAY_timestamp (PAY_timestamp)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TTM_ID INT(10) UNSIGNED NOT NULL,
 					  TKT_name VARCHAR(245) NOT NULL DEFAULT '',
 					  TKT_description TEXT NOT NULL,
@@ -252,28 +252,28 @@ 
 					  TKT_parent INT(10) UNSIGNED DEFAULT '0',
 					  TKT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 					  PRIMARY KEY  (TKT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TKT_ID INT(10) UNSIGNED NOT NULL,
 					  PRC_ID INT(10) UNSIGNED NOT NULL,
 					  PRIMARY KEY  (TKP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  DTT_ID INT(10) UNSIGNED NOT NULL,
 					  TKT_ID INT(10) UNSIGNED NOT NULL,
 					  PRIMARY KEY  (DTK_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TTM_name VARCHAR(45) NOT NULL,
 					  TTM_description TEXT,
 					  TTM_file VARCHAR(45),
 					  PRIMARY KEY  (TTM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price";
-        $sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price";
+		$sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  PRT_ID TINYINT(3) UNSIGNED NOT NULL,
 					  PRC_amount DECIMAL(10,3) NOT NULL DEFAULT '0.00',
 					  PRC_name VARCHAR(245) NOT NULL,
@@ -284,9 +284,9 @@ 
 					  PRC_order TINYINT(3) UNSIGNED NOT NULL DEFAULT '0',
 					  PRC_parent INT(10) UNSIGNED DEFAULT 0,
 					  PRIMARY KEY  (PRC_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID TINYINT(3) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID TINYINT(3) UNSIGNED NOT NULL AUTO_INCREMENT,
 				  PRT_name VARCHAR(45) NOT NULL,
 				  PBT_ID TINYINT(3) UNSIGNED NOT NULL DEFAULT '1',
 				  PRT_is_percent TINYINT(1) NOT NULL DEFAULT '0',
@@ -294,9 +294,9 @@ 
 				  PRT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 				  UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				  PRIMARY KEY  (PRT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QST_display_text TEXT NOT NULL,
 					QST_admin_label VARCHAR(255) NOT NULL,
 					QST_system VARCHAR(25) DEFAULT NULL,
@@ -308,10 +308,10 @@ 
 					QST_wp_user BIGINT UNSIGNED NULL,
 					QST_deleted TINYINT UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QST_ID)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_name VARCHAR(255) NOT NULL,
 					QSG_identifier VARCHAR(100) NOT NULL,
 					QSG_desc TEXT NULL,
@@ -322,24 +322,24 @@ 
 					QSG_deleted TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QSG_ID),
 					UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier ASC)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					QGQ_order INT UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QGQ_ID) ";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSO_value VARCHAR(255) NOT NULL,
 					QSO_desc TEXT NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					QSO_deleted TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QSO_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 					  ATT_ID BIGINT(20) UNSIGNED NOT NULL,
 					  TXN_ID INT(10) UNSIGNED NOT NULL,
@@ -362,25 +362,25 @@ 
 					  KEY STS_ID (STS_ID),
 					  KEY REG_url_link (REG_url_link),
 					  KEY REG_code (REG_code)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT(10) UNSIGNED NOT NULL,
 					DTT_ID INT(10) UNSIGNED NOT NULL,
 					CHK_in TINYINT(1) UNSIGNED NOT NULL DEFAULT 1,
 					CHK_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					PRIMARY KEY  (CHK_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  STA_abbrev VARCHAR(6) COLLATE utf8_bin NOT NULL,
 					  STA_name VARCHAR(100) COLLATE utf8_bin NOT NULL,
 					  STA_active TINYINT(1) DEFAULT '1',
 					  PRIMARY KEY  (STA_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  STS_code VARCHAR(45) COLLATE utf8_bin NOT NULL,
 					  STS_type set('event','registration','transaction','payment','email') COLLATE utf8_bin NOT NULL,
 					  STS_can_edit TINYINT(1) NOT NULL DEFAULT 0,
@@ -388,9 +388,9 @@ 
 					  STS_open TINYINT(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TXN_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					  TXN_total DECIMAL(10,3) DEFAULT '0.00',
 					  TXN_paid DECIMAL(10,3) NOT NULL DEFAULT '0.00',
@@ -400,9 +400,9 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID INT(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 			VNU_address VARCHAR(255) DEFAULT NULL,
 			VNU_address2 VARCHAR(255) DEFAULT NULL,
@@ -420,36 +420,36 @@ 
 			PRIMARY KEY  (VNUM_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $script_with_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        // setting up the DEFAULT stats and countries is also essential for the data migrations to run
-        // (because many need to convert old string states to foreign keys into the states table)
-        $script_with_defaults->insert_default_states();
-        $script_with_defaults->insert_default_countries();
-        // setting up DEFAULT prices, price types, and tickets is also essential for the price migrations
-        $script_with_defaults->insert_default_price_types();
-        $script_with_defaults->insert_default_prices();
-        $script_with_defaults->insert_default_tickets();
-        // setting up the config wp option pretty well counts as a 'schema change', or at least should happen ehre
-        EE_Config::instance()->update_espresso_config(false, true);
-        return true;
-    }
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$script_with_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		// setting up the DEFAULT stats and countries is also essential for the data migrations to run
+		// (because many need to convert old string states to foreign keys into the states table)
+		$script_with_defaults->insert_default_states();
+		$script_with_defaults->insert_default_countries();
+		// setting up DEFAULT prices, price types, and tickets is also essential for the price migrations
+		$script_with_defaults->insert_default_price_types();
+		$script_with_defaults->insert_default_prices();
+		$script_with_defaults->insert_default_tickets();
+		// setting up the config wp option pretty well counts as a 'schema change', or at least should happen ehre
+		EE_Config::instance()->update_espresso_config(false, true);
+		return true;
+	}
 
 
 
-    /**
-     * We COULD clean up the esp_question.QST_order field here. We'll leave it for now
-     *
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
+	/**
+	 * We COULD clean up the esp_question.QST_order field here. We'll leave it for now
+	 *
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 }

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

Indentation +35 added lines, -35 removed lines

@@ -9,39 +9,39 @@
 */
 class EE_DMS_4_5_0_update_wp_user_for_question_groups extends EE_Data_Migration_Script_Stage_Table
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Question Groups", "event_espresso");
-        $this->_old_table = $wpdb->prefix."esp_question_group";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // foreach ticket row we add the id for the current logged in user.
-        global $wpdb;
-        $user_id = EEH_Activation::get_default_creator_id();
-        $updated = $wpdb->update(
-            $this->_old_table,
-            array('QSG_wp_user'=>$user_id),
-            array('QSG_ID'=>$old_row['QSG_ID']),
-            array('%d',// QSG_wp_user
-                    ),
-            array('%d',// QSG_ID
-                    )
-        );
-        if (false === $updated) {
-            $this->add_error(
-                sprintf(
-                    __(
-                        "Error in updating table %s setting QSG_wp_user = %d where QSG_ID = %d",
-                        'event_espresso'
-                    ),
-                    $this->_old_table,
-                    $user_id,
-                    $old_row['QSG_ID']
-                )
-            );
-        }
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Question Groups", "event_espresso");
+		$this->_old_table = $wpdb->prefix."esp_question_group";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// foreach ticket row we add the id for the current logged in user.
+		global $wpdb;
+		$user_id = EEH_Activation::get_default_creator_id();
+		$updated = $wpdb->update(
+			$this->_old_table,
+			array('QSG_wp_user'=>$user_id),
+			array('QSG_ID'=>$old_row['QSG_ID']),
+			array('%d',// QSG_wp_user
+					),
+			array('%d',// QSG_ID
+					)
+		);
+		if (false === $updated) {
+			$this->add_error(
+				sprintf(
+					__(
+						"Error in updating table %s setting QSG_wp_user = %d where QSG_ID = %d",
+						'event_espresso'
+					),
+					$this->_old_table,
+					$user_id,
+					$old_row['QSG_ID']
+				)
+			);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -25,9 +25,9 @@
             $this->_old_table,
             array('QSG_wp_user'=>$user_id),
             array('QSG_ID'=>$old_row['QSG_ID']),
-            array('%d',// QSG_wp_user
+            array('%d', // QSG_wp_user
                     ),
-            array('%d',// QSG_ID
+            array('%d', // QSG_ID
                     )
         );
         if (false === $updated) {

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

Indentation +35 added lines, -35 removed lines

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

Spacing +2 added lines, -2 removed lines

@@ -25,9 +25,9 @@
             $this->_old_table,
             array('PRC_wp_user'=>$user_id),
             array('PRC_ID'=>$old_row['PRC_ID']),
-            array('%d',// PRC_wp_user
+            array('%d', // PRC_wp_user
                     ),
-            array('%d',// PRC_ID
+            array('%d', // PRC_ID
                     )
         );
         if (false === $updated) {

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

Indentation +35 added lines, -35 removed lines

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

Spacing +2 added lines, -2 removed lines

@@ -25,9 +25,9 @@
             $this->_old_table,
             array('TKT_wp_user'=>$user_id),
             array('TKT_ID'=>$old_row['TKT_ID']),
-            array('%d',// TKT_wp_user
+            array('%d', // TKT_wp_user
                     ),
-            array('%d',// TKT_ID
+            array('%d', // TKT_ID
                     )
         );
         if (false === $updated) {

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

Indentation +32 added lines, -32 removed lines

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

Spacing +2 added lines, -2 removed lines

@@ -25,9 +25,9 @@
             $this->_old_table,
             array('PRT_wp_user'=>$user_id),
             array('PRT_ID'=>$old_row['PRT_ID']),
-            array('%d',// PRT_wp_user
+            array('%d', // PRT_wp_user
                     ),
-            array('%d',// PRT_ID
+            array('%d', // PRT_ID
                     )
         );
         if (false === $updated) {

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

Indentation +83 added lines, -83 removed lines

@@ -15,94 +15,94 @@
 class EE_DMS_4_5_0_invoice_settings extends EE_Data_Migration_Script_Stage
 {
 
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = __('Update Invoice Gateway Settings', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = __('Update Invoice Gateway Settings', 'event_espresso');
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _count_records_to_migrate
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @access protected
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * _count_records_to_migrate
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @access protected
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
 
 
-    /**
-     *    _migration_step
-     *
-     * @access protected
-     * @param int $num_items
-     * @throws EE_Error
-     * @return int number of items ACTUALLY migrated
-     * @throws InvalidDataTypeException
-     */
-    protected function _migration_step($num_items = 1)
-    {
-        // if this isn't set then something is really wrong
-        if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
-            throw new EE_Error(__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
-        }
-        $invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
-        if (! $invoice_settings) {
-            $this->add_error(__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
-        } else {
-            $invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
-            $invoice_settings['template_invoice_payee_name'] = $invoice_settings['payable_to'];
-            $invoice_settings['template_invoice_address'] = $invoice_settings['payment_address'];
-            $invoice_settings['template_invoice_email'] = '';
-            $invoice_settings['template_invoice_tax_number'] = '';
-            unset($invoice_settings['pdf_instructions']);
-            unset($invoice_settings['payable_to']);
-            unset($invoice_settings['payment_address']);
-            EE_Config::instance()->gateway->payment_settings['Invoice'] = $invoice_settings;
-            EE_Config::instance()->update_espresso_config(false, false);
+	/**
+	 *    _migration_step
+	 *
+	 * @access protected
+	 * @param int $num_items
+	 * @throws EE_Error
+	 * @return int number of items ACTUALLY migrated
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _migration_step($num_items = 1)
+	{
+		// if this isn't set then something is really wrong
+		if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
+			throw new EE_Error(__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
+		}
+		$invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
+		if (! $invoice_settings) {
+			$this->add_error(__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
+		} else {
+			$invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
+			$invoice_settings['template_invoice_payee_name'] = $invoice_settings['payable_to'];
+			$invoice_settings['template_invoice_address'] = $invoice_settings['payment_address'];
+			$invoice_settings['template_invoice_email'] = '';
+			$invoice_settings['template_invoice_tax_number'] = '';
+			unset($invoice_settings['pdf_instructions']);
+			unset($invoice_settings['payable_to']);
+			unset($invoice_settings['payment_address']);
+			EE_Config::instance()->gateway->payment_settings['Invoice'] = $invoice_settings;
+			EE_Config::instance()->update_espresso_config(false, false);
 
-            // @todo: check 'invoice_css' too because we can't easily affect that so we might need to set a persistent notice
-            // (why is it tough to change? because we want to update the receipt and invoice message template, but
-            // message templates are only initialized AFTER migrations and those two are new in 4.5. So if we wanted to
-            // update them from a DMS, we'd need to have the DMS create the message templates which is quite a lot of code;
-            // also we don't want to build a dependency on the messages code because it is likely to change soon
-            if (! in_array($invoice_settings['invoice_css'], array( '', 'simple.css' ))) {
-                new PersistentAdminNotice(
-                    'invoice_css_not_updated',
-                    sprintf(
-                        esc_html__(
-                            'You had previously set your Invoice Payment Method\'s stylesheet to be %1$s, but that setting has moved. PDF and HTML Invoices and Receipts are now Messages, which means you can easily modify them from your Wordpress Dashboard instead of using filters or uploading template files. Please visit Messages -> Receipt and Messages -> Invoice to change their stylesheets.',
-                            'event_espresso'
-                        ),
-                        $invoice_settings['invoice_css']
-                    )
-                );
-            }
-            $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-            $overridden_receipt_body= EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
-            if ($overridden_invoice_body || $overridden_receipt_body) {
-                new PersistentAdminNotice(
-                    'invoice_overriding_templates',
-                    esc_html__(
-                        'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents. We recommend deleting your old Invoice/Receipt templates and modifying the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
-                        'event_espresso'
-                    ),
-                    true
-                );
-            }
-        }
-        // regardless of whether it worked or not, we ought to continue the migration
-        $this->set_completed();
-        return 1;
-    }
+			// @todo: check 'invoice_css' too because we can't easily affect that so we might need to set a persistent notice
+			// (why is it tough to change? because we want to update the receipt and invoice message template, but
+			// message templates are only initialized AFTER migrations and those two are new in 4.5. So if we wanted to
+			// update them from a DMS, we'd need to have the DMS create the message templates which is quite a lot of code;
+			// also we don't want to build a dependency on the messages code because it is likely to change soon
+			if (! in_array($invoice_settings['invoice_css'], array( '', 'simple.css' ))) {
+				new PersistentAdminNotice(
+					'invoice_css_not_updated',
+					sprintf(
+						esc_html__(
+							'You had previously set your Invoice Payment Method\'s stylesheet to be %1$s, but that setting has moved. PDF and HTML Invoices and Receipts are now Messages, which means you can easily modify them from your Wordpress Dashboard instead of using filters or uploading template files. Please visit Messages -> Receipt and Messages -> Invoice to change their stylesheets.',
+							'event_espresso'
+						),
+						$invoice_settings['invoice_css']
+					)
+				);
+			}
+			$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+			$overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
+			$overridden_receipt_body= EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+			if ($overridden_invoice_body || $overridden_receipt_body) {
+				new PersistentAdminNotice(
+					'invoice_overriding_templates',
+					esc_html__(
+						'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents. We recommend deleting your old Invoice/Receipt templates and modifying the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
+						'event_espresso'
+					),
+					true
+				);
+			}
+		}
+		// regardless of whether it worked or not, we ought to continue the migration
+		$this->set_completed();
+		return 1;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -52,11 +52,11 @@ 
     protected function _migration_step($num_items = 1)
     {
         // if this isn't set then something is really wrong
-        if (! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
+        if ( ! EE_Config::instance()->gateway instanceof EE_Gateway_Config) {
             throw new EE_Error(__('It appears the Event Espresso Core Configuration is not setup correctly.', 'event_espresso'));
         }
         $invoice_settings = isset(EE_Config::instance()->gateway->payment_settings['Invoice']) ? EE_Config::instance()->gateway->payment_settings['Invoice'] : null;
-        if (! $invoice_settings) {
+        if ( ! $invoice_settings) {
             $this->add_error(__('Could not migrate EE4.4 invoice settings to EE4.5 because they didnt exist', 'event_espresso'));
         } else {
             $invoice_settings['template_payment_instructions'] = $invoice_settings['pdf_instructions'];
@@ -75,7 +75,7 @@ 
             // message templates are only initialized AFTER migrations and those two are new in 4.5. So if we wanted to
             // update them from a DMS, we'd need to have the DMS create the message templates which is quite a lot of code;
             // also we don't want to build a dependency on the messages code because it is likely to change soon
-            if (! in_array($invoice_settings['invoice_css'], array( '', 'simple.css' ))) {
+            if ( ! in_array($invoice_settings['invoice_css'], array('', 'simple.css'))) {
                 new PersistentAdminNotice(
                     'invoice_css_not_updated',
                     sprintf(
@@ -88,8 +88,8 @@ 
                 );
             }
             $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path . 'invoice_body.template.php', null, false, false, true);
-            $overridden_receipt_body= EEH_Template::locate_template($templates_relative_path . 'receipt_body.template.php', null, false, false, true);
+            $overridden_invoice_body = EEH_Template::locate_template($templates_relative_path.'invoice_body.template.php', null, false, false, true);
+            $overridden_receipt_body = EEH_Template::locate_template($templates_relative_path.'receipt_body.template.php', null, false, false, true);
             if ($overridden_invoice_body || $overridden_receipt_body) {
                 new PersistentAdminNotice(
                     'invoice_overriding_templates',