eventespresso / event-espresso-core

core/libraries/form_sections/strategies/layout/EE_Two_Column_Layout.strategy.php

Indentation +68 added lines, -68 removed lines

@@ -5,81 +5,81 @@
 class EE_Two_Column_Layout extends EE_Form_Section_Layout_Base
 {
 
-    /**
-     * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
-     *
-     * @param array $additional_args
-     * @return string
-     */
-    public function layout_form_begin($additional_args = array())
-    {
-        return $this->display_form_wide_errors()
-        . EEH_HTML::table(
-            '',
-            $this->_form_section->html_id(),
-            $this->_form_section->html_class(),
-            $this->_form_section->html_style()
-        ) . EEH_HTML::tbody();
-    }
+	/**
+	 * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
+	 *
+	 * @param array $additional_args
+	 * @return string
+	 */
+	public function layout_form_begin($additional_args = array())
+	{
+		return $this->display_form_wide_errors()
+		. EEH_HTML::table(
+			'',
+			$this->_form_section->html_id(),
+			$this->_form_section->html_class(),
+			$this->_form_section->html_style()
+		) . EEH_HTML::tbody();
+	}
 
 
 
-    /**
-     * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
-     *
-     * @param array $additional_args
-     * @return string
-     */
-    public function layout_form_end($additional_args = array())
-    {
-        return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id());
-    }
+	/**
+	 * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
+	 *
+	 * @param array $additional_args
+	 * @return string
+	 */
+	public function layout_form_end($additional_args = array())
+	{
+		return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id());
+	}
 
 
 
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function layout_input($input)
-    {
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= $input->get_html_for_input();
-        } else {
-            $html_for_input = $input->get_html_for_input();
-            $html_for_input .= $input->get_html_for_errors() != ''
-                ? EEH_HTML::nl() . $input->get_html_for_errors()
-                : '';
-            $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
-            $html .= EEH_HTML::tr(
-                EEH_HTML::th($input->get_html_for_label()) .
-                EEH_HTML::td($html_for_input)
-            );
-        }
-        return $html;
-    }
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function layout_input($input)
+	{
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= $input->get_html_for_input();
+		} else {
+			$html_for_input = $input->get_html_for_input();
+			$html_for_input .= $input->get_html_for_errors() != ''
+				? EEH_HTML::nl() . $input->get_html_for_errors()
+				: '';
+			$html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
+			$html .= EEH_HTML::tr(
+				EEH_HTML::th($input->get_html_for_label()) .
+				EEH_HTML::td($html_for_input)
+			);
+		}
+		return $html;
+	}
 
 
 
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        $html = '';
-        if ($form_section instanceof EE_Form_Section_HTML) {
-            $html .= $form_section->get_html();
-        } else {
-            $html .= EEH_HTML::tr(
-                EEH_HTML::td($form_section->get_html(), '', '', '', 'colspan="2"')
-            );
-        }
-        return $html;
-    }
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		$html = '';
+		if ($form_section instanceof EE_Form_Section_HTML) {
+			$html .= $form_section->get_html();
+		} else {
+			$html .= EEH_HTML::tr(
+				EEH_HTML::td($form_section->get_html(), '', '', '', 'colspan="2"')
+			);
+		}
+		return $html;
+	}
 }

core/helpers/EEH_DTT_Helper.helper.php

Doc Comments +4 added lines, -4 removed lines

@@ -327,7 +327,7 @@ 
     /**
      * Get Timezone Transitions
      * @param \DateTimeZone $date_time_zone
-     * @param null          $time
+     * @param integer|null          $time
      * @param bool          $first_only
      * @return array|mixed
      */
@@ -343,7 +343,7 @@ 
     /**
      * Get Timezone Offset for given timezone object.
      * @param \DateTimeZone $date_time_zone
-     * @param null          $time
+     * @param integer|null          $time
      * @return mixed
      * @throws \DomainException
      */
@@ -1075,7 +1075,7 @@ 
      * this method will add that "1" into your date regardless of the format.
      *
      * @param string $month
-     * @return string
+     * @return integer
      */
     public static function first_of_month_timestamp($month = '')
     {
@@ -1227,7 +1227,7 @@ 
     /**
      * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
      *
-     * @param int|WP_User $user_id
+     * @param integer $user_id
      * @return string
      */
     public static function get_user_locale($user_id = 0)

Indentation +1177 added lines, -1177 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -26,364 +26,364 @@ 
 {
 
 
-    /**
-     * return the timezone set for the WP install
-     *
-     * @return string valid timezone string for PHP DateTimeZone() class
-     */
-    public static function get_timezone()
-    {
-        return EEH_DTT_Helper::get_valid_timezone_string();
-    }
-
-
-    /**
-     * get_valid_timezone_string
-     *    ensures that a valid timezone string is returned
-     *
-     * @access protected
-     * @param string $timezone_string
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function get_valid_timezone_string($timezone_string = '')
-    {
-        // if passed a value, then use that, else get WP option
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : get_option('timezone_string');
-        // value from above exists, use that, else get timezone string from gmt_offset
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : EEH_DTT_Helper::get_timezone_string_from_gmt_offset();
-        EEH_DTT_Helper::validate_timezone($timezone_string);
-        return $timezone_string;
-    }
-
-
-    /**
-     * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @static
-     * @access public
-     * @param  string $timezone_string Timezone string to check
-     * @param bool    $throw_error
-     * @return bool
-     * @throws \EE_Error
-     */
-    public static function validate_timezone($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(
-                    __('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;
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @access protected
-     * @param string $gmt_offset
-     * @return string
-     */
-    public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
-    {
-        $timezone_string = 'UTC';
-        //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 get_option('timezone_string');
-            }
-        }
-        $gmt_offset = $gmt_offset !== '' ? $gmt_offset : get_option('gmt_offset');
-        $gmt_offset = (float) $gmt_offset;
-
-        //if $gmt_offset is 0, then just return UTC
-        if ($gmt_offset === (float) 0) {
-            return $timezone_string;
-        }
-
-
-        if ($gmt_offset !== '') {
-            // convert GMT offset to seconds
-            $gmt_offset = $gmt_offset * HOUR_IN_SECONDS;
-            // although we don't know the TZ abbreviation, we know the UTC offset
-            $timezone_string = timezone_name_from_abbr(null, $gmt_offset);
-            //only use this timezone_string IF it's current offset matches the given offset
-            try {
-                $offset = self::get_timezone_offset(new DateTimeZone($timezone_string));
-                if ($offset !== $gmt_offset) {
-                    $timezone_string = false;
-                }
-            } catch (Exception $e) {
-                $timezone_string = false;
-            }
-        }
-        // better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()...
-        $timezone_string = $timezone_string !== false
-            ? $timezone_string
-            : EEH_DTT_Helper::get_timezone_string_from_abbreviations_list($gmt_offset);
-        return $timezone_string;
-    }
-
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case teh 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 static function get_site_timezone_gmt_offset()
-    {
-        $timezone_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);
-    }
-
-
-    /**
-     * Depending on PHP version, there might not bevalid current timezone strings to match these gmt_offsets in its
-     * timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     *
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @access public
-     * @param int $gmt_offset
-     * @return int
-     */
-    public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
-    {
-        //make sure $gmt_offset is int
-        $gmt_offset = (int)$gmt_offset;
-        switch ($gmt_offset) {
-            //-12
-            case -43200:
-                $gmt_offset = -39600;
-                break;
-            //-11.5
-            case -41400:
-                $gmt_offset = -39600;
-                break;
-            //-10.5
-            case -37800:
-                $gmt_offset = -39600;
-                break;
-            //-8.5
-            case -30600:
-                $gmt_offset = -28800;
-                break;
-            //-7.5
-            case -27000:
-                $gmt_offset = -25200;
-                break;
-            //-6.5
-            case -23400:
-                $gmt_offset = -21600;
-                break;
-            //-5.5
-            case -19800:
-                $gmt_offset = -18000;
-                break;
-            //-4.5
-            case -16200:
-                $gmt_offset = -14400;
-                break;
-            //-3.5
-            case -12600:
-                $gmt_offset = -10800;
-                break;
-            //-2.5
-            case -9000:
-                $gmt_offset = -7200;
-                break;
-            //-1.5
-            case -5400:
-                $gmt_offset = -3600;
-                break;
-            //-0.5
-            case -1800:
-                $gmt_offset = 0;
-                break;
-            //.5
-            case 1800:
-                $gmt_offset = 3600;
-                break;
-            //1.5
-            case 5400:
-                $gmt_offset = 7200;
-                break;
-            //2.5
-            case 9000:
-                $gmt_offset = 10800;
-                break;
-            //3.5
-            case 12600:
-                $gmt_offset = 14400;
-                break;
-
-            //7.5
-            case 27000:
-                $gmt_offset = 28800;
-                break;
-            //8.5
-            case 30600:
-                $gmt_offset = 31500;
-                break;
-            //10.5
-            case 37800:
-                $gmt_offset = 39600;
-                break;
-            //11.5
-            case 41400:
-                $gmt_offset = 43200;
-                break;
-            //12.75
-            case 45900:
-                $gmt_offset = 46800;
-                break;
-            //13.75
-            case 49500:
-                $gmt_offset = 50400;
-                break;
-        }
-        return $gmt_offset;
-    }
-
-
-    /**
-     * get_timezone_string_from_abbreviations_list
-     *
-     * @access public
-     * @param int  $gmt_offset
-     * @param bool $coerce   If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
-    {
-        $abbreviations = timezone_abbreviations_list();
-        foreach ($abbreviations as $abbreviation) {
-            foreach ($abbreviation as $city) {
-                if ($city['offset'] === $gmt_offset && $city['dst'] === false) {
-                    try {
-                        $offset = self::get_timezone_offset(new DateTimeZone($city['timezone_id']));
-                        if ($offset !== $gmt_offset) {
-                            continue;
-                        } else {
-                            return $city['timezone_id'];
-                        }
-                    } catch (Exception $e) {
-                        continue;
-                    }
-                }
-            }
-        }
-        //if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
-        if ($coerce == true) {
-            $timezone_string = self::get_timezone_string_from_abbreviations_list(
-                self::adjust_invalid_gmt_offsets($gmt_offset),
-                false
-            );
-            if ($timezone_string) {
-                return $timezone_string;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                __('The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                    'event_espresso'),
-                $gmt_offset,
-                '<a href="http://www.php.net/manual/en/timezones.php">',
-                '</a>'
-            )
-        );
-    }
-
-
-
-    /**
-     * Get Timezone Transitions
-     * @param \DateTimeZone $date_time_zone
-     * @param null          $time
-     * @param bool          $first_only
-     * @return array|mixed
-     */
-    public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
-    {
-        $time = is_int($time) || $time === null ? $time : 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 Offset for given timezone object.
-     * @param \DateTimeZone $date_time_zone
-     * @param null          $time
-     * @return mixed
-     * @throws \DomainException
-     */
-    public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
-    {
-        $transitions = self::get_timezone_transitions($date_time_zone, $time);
-        if (! isset($transitions['offset'])) {
-            throw new DomainException();
-        }
-        return $transitions['offset'];
-    }
-
-
-    /**
-     * @access public
-     * @param string $timezone_string
-     */
-    public static function timezone_select_input($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 : get_option('timezone_string');
-        // check if the timezone is valid but don't throw any errors if it isn't
-        $timezone_string = EEH_DTT_Helper::validate_timezone($timezone_string, false);
-        $gmt_offset      = get_option('gmt_offset');
-
-        $check_zone_info = true;
-        if (empty($timezone_string)) {
-            // Create a UTC+- zone if no timezone string exists
-            $check_zone_info = false;
-            if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
-            } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
-            } else {
-                $timezone_string = 'UTC';
-            }
-        }
-        ?>
+	/**
+	 * return the timezone set for the WP install
+	 *
+	 * @return string valid timezone string for PHP DateTimeZone() class
+	 */
+	public static function get_timezone()
+	{
+		return EEH_DTT_Helper::get_valid_timezone_string();
+	}
+
+
+	/**
+	 * get_valid_timezone_string
+	 *    ensures that a valid timezone string is returned
+	 *
+	 * @access protected
+	 * @param string $timezone_string
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function get_valid_timezone_string($timezone_string = '')
+	{
+		// if passed a value, then use that, else get WP option
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : get_option('timezone_string');
+		// value from above exists, use that, else get timezone string from gmt_offset
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : EEH_DTT_Helper::get_timezone_string_from_gmt_offset();
+		EEH_DTT_Helper::validate_timezone($timezone_string);
+		return $timezone_string;
+	}
+
+
+	/**
+	 * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @static
+	 * @access public
+	 * @param  string $timezone_string Timezone string to check
+	 * @param bool    $throw_error
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public static function validate_timezone($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(
+					__('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;
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @access protected
+	 * @param string $gmt_offset
+	 * @return string
+	 */
+	public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
+	{
+		$timezone_string = 'UTC';
+		//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 get_option('timezone_string');
+			}
+		}
+		$gmt_offset = $gmt_offset !== '' ? $gmt_offset : get_option('gmt_offset');
+		$gmt_offset = (float) $gmt_offset;
+
+		//if $gmt_offset is 0, then just return UTC
+		if ($gmt_offset === (float) 0) {
+			return $timezone_string;
+		}
+
+
+		if ($gmt_offset !== '') {
+			// convert GMT offset to seconds
+			$gmt_offset = $gmt_offset * HOUR_IN_SECONDS;
+			// although we don't know the TZ abbreviation, we know the UTC offset
+			$timezone_string = timezone_name_from_abbr(null, $gmt_offset);
+			//only use this timezone_string IF it's current offset matches the given offset
+			try {
+				$offset = self::get_timezone_offset(new DateTimeZone($timezone_string));
+				if ($offset !== $gmt_offset) {
+					$timezone_string = false;
+				}
+			} catch (Exception $e) {
+				$timezone_string = false;
+			}
+		}
+		// better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()...
+		$timezone_string = $timezone_string !== false
+			? $timezone_string
+			: EEH_DTT_Helper::get_timezone_string_from_abbreviations_list($gmt_offset);
+		return $timezone_string;
+	}
+
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case teh 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 static function get_site_timezone_gmt_offset()
+	{
+		$timezone_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);
+	}
+
+
+	/**
+	 * Depending on PHP version, there might not bevalid current timezone strings to match these gmt_offsets in its
+	 * timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 *
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @access public
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
+	{
+		//make sure $gmt_offset is int
+		$gmt_offset = (int)$gmt_offset;
+		switch ($gmt_offset) {
+			//-12
+			case -43200:
+				$gmt_offset = -39600;
+				break;
+			//-11.5
+			case -41400:
+				$gmt_offset = -39600;
+				break;
+			//-10.5
+			case -37800:
+				$gmt_offset = -39600;
+				break;
+			//-8.5
+			case -30600:
+				$gmt_offset = -28800;
+				break;
+			//-7.5
+			case -27000:
+				$gmt_offset = -25200;
+				break;
+			//-6.5
+			case -23400:
+				$gmt_offset = -21600;
+				break;
+			//-5.5
+			case -19800:
+				$gmt_offset = -18000;
+				break;
+			//-4.5
+			case -16200:
+				$gmt_offset = -14400;
+				break;
+			//-3.5
+			case -12600:
+				$gmt_offset = -10800;
+				break;
+			//-2.5
+			case -9000:
+				$gmt_offset = -7200;
+				break;
+			//-1.5
+			case -5400:
+				$gmt_offset = -3600;
+				break;
+			//-0.5
+			case -1800:
+				$gmt_offset = 0;
+				break;
+			//.5
+			case 1800:
+				$gmt_offset = 3600;
+				break;
+			//1.5
+			case 5400:
+				$gmt_offset = 7200;
+				break;
+			//2.5
+			case 9000:
+				$gmt_offset = 10800;
+				break;
+			//3.5
+			case 12600:
+				$gmt_offset = 14400;
+				break;
+
+			//7.5
+			case 27000:
+				$gmt_offset = 28800;
+				break;
+			//8.5
+			case 30600:
+				$gmt_offset = 31500;
+				break;
+			//10.5
+			case 37800:
+				$gmt_offset = 39600;
+				break;
+			//11.5
+			case 41400:
+				$gmt_offset = 43200;
+				break;
+			//12.75
+			case 45900:
+				$gmt_offset = 46800;
+				break;
+			//13.75
+			case 49500:
+				$gmt_offset = 50400;
+				break;
+		}
+		return $gmt_offset;
+	}
+
+
+	/**
+	 * get_timezone_string_from_abbreviations_list
+	 *
+	 * @access public
+	 * @param int  $gmt_offset
+	 * @param bool $coerce   If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
+	{
+		$abbreviations = timezone_abbreviations_list();
+		foreach ($abbreviations as $abbreviation) {
+			foreach ($abbreviation as $city) {
+				if ($city['offset'] === $gmt_offset && $city['dst'] === false) {
+					try {
+						$offset = self::get_timezone_offset(new DateTimeZone($city['timezone_id']));
+						if ($offset !== $gmt_offset) {
+							continue;
+						} else {
+							return $city['timezone_id'];
+						}
+					} catch (Exception $e) {
+						continue;
+					}
+				}
+			}
+		}
+		//if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
+		if ($coerce == true) {
+			$timezone_string = self::get_timezone_string_from_abbreviations_list(
+				self::adjust_invalid_gmt_offsets($gmt_offset),
+				false
+			);
+			if ($timezone_string) {
+				return $timezone_string;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				__('The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+					'event_espresso'),
+				$gmt_offset,
+				'<a href="http://www.php.net/manual/en/timezones.php">',
+				'</a>'
+			)
+		);
+	}
+
+
+
+	/**
+	 * Get Timezone Transitions
+	 * @param \DateTimeZone $date_time_zone
+	 * @param null          $time
+	 * @param bool          $first_only
+	 * @return array|mixed
+	 */
+	public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
+	{
+		$time = is_int($time) || $time === null ? $time : 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 Offset for given timezone object.
+	 * @param \DateTimeZone $date_time_zone
+	 * @param null          $time
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
+	{
+		$transitions = self::get_timezone_transitions($date_time_zone, $time);
+		if (! isset($transitions['offset'])) {
+			throw new DomainException();
+		}
+		return $transitions['offset'];
+	}
+
+
+	/**
+	 * @access public
+	 * @param string $timezone_string
+	 */
+	public static function timezone_select_input($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 : get_option('timezone_string');
+		// check if the timezone is valid but don't throw any errors if it isn't
+		$timezone_string = EEH_DTT_Helper::validate_timezone($timezone_string, false);
+		$gmt_offset      = get_option('gmt_offset');
+
+		$check_zone_info = true;
+		if (empty($timezone_string)) {
+			// Create a UTC+- zone if no timezone string exists
+			$check_zone_info = false;
+			if ($gmt_offset > 0) {
+				$timezone_string = 'UTC+' . $gmt_offset;
+			} elseif ($gmt_offset < 0) {
+				$timezone_string = 'UTC' . $gmt_offset;
+			} else {
+				$timezone_string = 'UTC';
+			}
+		}
+		?>
 
         <p>
             <label for="timezone_string"><?php _e('timezone'); ?></label>
@@ -396,13 +396,13 @@ 
 
         <p>
         <span><?php
-            printf(
-                __('%1$sUTC%2$s time is %3$s'),
-                '<abbr title="Coordinated Universal Time">',
-                '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
-            );
-            ?></span>
+			printf(
+				__('%1$sUTC%2$s time is %3$s'),
+				'<abbr title="Coordinated Universal Time">',
+				'</abbr>',
+				'<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'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
     <?php endif; ?>
@@ -411,693 +411,693 @@ 
         <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.');
-                    } else {
-                        _e('This timezone is currently in standard time.');
-                    }
-                    ?>
+					// 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.');
+					} else {
+						_e('This timezone is currently in standard time.');
+					}
+					?>
             <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.') :
-                        __(' Standard time begins  on: %s.');
-                    // 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.');
-                }
-            }
-            // 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.') :
+						__(' Standard time begins  on: %s.');
+					// 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.');
+				}
+			}
+			// Set back to UTC.
+			date_default_timezone_set('UTC');
+			?>
 				</span></p>
         <?php
-    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 with the offset applied for the given timezone.
-     */
-    public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
-    {
-        $unix_timestamp  = $unix_timestamp === 0 ? time() : (int)$unix_timestamp;
-        $timezone_string = self::get_valid_timezone_string($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;
-    }
-
-
-    /**
-     *    _set_date_time_field
-     *    modifies EE_Base_Class EE_Datetime_Field objects
-     *
-     * @param  EE_Base_Class $obj                 EE_Base_Class object
-     * @param    DateTime    $DateTime            PHP DateTime object
-     * @param  string        $datetime_field_name the datetime fieldname to be manipulated
-     * @return    EE_Base_Class
-     */
-    protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name)
-    {
-        // grab current datetime format
-        $current_format = $obj->get_format();
-        // set new full timestamp format
-        $obj->set_date_format(EE_Datetime_Field::mysql_date_format);
-        $obj->set_time_format(EE_Datetime_Field::mysql_time_format);
-        // set the new date value using a full timestamp format so that no data is lost
-        $obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format));
-        // reset datetime formats
-        $obj->set_date_format($current_format[0]);
-        $obj->set_time_format($current_format[1]);
-        return $obj;
-    }
-
-
-    /**
-     *    date_time_add
-     *    helper for doing simple datetime calculations on a given datetime from EE_Base_Class
-     *    and modifying it IN the EE_Base_Class so you don't have to do anything else.
-     *
-     * @param  EE_Base_Class $obj                 EE_Base_Class object
-     * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
-     * @param  string        $period              what you are adding. The options are (years, months, days, hours,
-     *                                            minutes, seconds) defaults to years
-     * @param  integer       $value               what you want to increment the time by
-     * @return EE_Base_Class           return the EE_Base_Class object so right away you can do something with it
-     *                                 (chaining)
-     */
-    public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
-    {
-        //get the raw UTC date.
-        $DateTime = $obj->get_DateTime_object($datetime_field_name);
-        $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value);
-        return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
-    }
-
-
-    /**
-     *    date_time_subtract
-     *    same as date_time_add except subtracting value instead of adding.
-     *
-     * @param \EE_Base_Class $obj
-     * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
-     * @param string         $period
-     * @param int            $value
-     * @return \EE_Base_Class
-     */
-    public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
-    {
-        //get the raw UTC date
-        $DateTime = $obj->get_DateTime_object($datetime_field_name);
-        $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-');
-        return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
-    }
-
-
-    /**
-     * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters
-     *
-     * @param  DateTime $DateTime DateTime object
-     * @param  string   $period   a value to indicate what interval is being used in the calculation. The options are
-     *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
-     * @param  integer  $value    What you want to increment the date by
-     * @param  string   $operand  What operand you wish to use for the calculation
-     * @return \DateTime return whatever type came in.
-     * @throws \EE_Error
-     */
-    protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
-    {
-        if (! $DateTime instanceof DateTime) {
-            throw new EE_Error(
-                sprintf(
-                    __('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
-                    print_r($DateTime, true)
-                )
-            );
-        }
-        switch ($period) {
-            case 'years' :
-                $value = 'P' . $value . 'Y';
-                break;
-            case 'months' :
-                $value = 'P' . $value . 'M';
-                break;
-            case 'weeks' :
-                $value = 'P' . $value . 'W';
-                break;
-            case 'days' :
-                $value = 'P' . $value . 'D';
-                break;
-            case 'hours' :
-                $value = 'PT' . $value . 'H';
-                break;
-            case 'minutes' :
-                $value = 'PT' . $value . 'M';
-                break;
-            case 'seconds' :
-                $value = 'PT' . $value . 'S';
-                break;
-        }
-        switch ($operand) {
-            case '+':
-                $DateTime->add(new DateInterval($value));
-                break;
-            case '-':
-                $DateTime->sub(new DateInterval($value));
-                break;
-        }
-        return $DateTime;
-    }
-
-
-    /**
-     * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters
-     *
-     * @param  int     $timestamp Unix timestamp
-     * @param  string  $period    a value to indicate what interval is being used in the calculation. The options are
-     *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
-     * @param  integer $value     What you want to increment the date by
-     * @param  string  $operand   What operand you wish to use for the calculation
-     * @return \DateTime return whatever type came in.
-     * @throws \EE_Error
-     */
-    protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
-    {
-        if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
-            throw new EE_Error(
-                sprintf(
-                    __('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
-                    print_r($timestamp, true)
-                )
-            );
-        }
-        switch ($period) {
-            case 'years' :
-                $value = YEAR_IN_SECONDS * $value;
-                break;
-            case 'months' :
-                $value = YEAR_IN_SECONDS / 12 * $value;
-                break;
-            case 'weeks' :
-                $value = WEEK_IN_SECONDS * $value;
-                break;
-            case 'days' :
-                $value = DAY_IN_SECONDS * $value;
-                break;
-            case 'hours' :
-                $value = HOUR_IN_SECONDS * $value;
-                break;
-            case 'minutes' :
-                $value = MINUTE_IN_SECONDS * $value;
-                break;
-        }
-        switch ($operand) {
-            case '+':
-                $timestamp += $value;
-                break;
-            case '-':
-                $timestamp -= $value;
-                break;
-        }
-        return $timestamp;
-    }
-
-
-    /**
-     * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming
-     * parameters and returns the new timestamp or DateTime.
-     *
-     * @param  int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp
-     * @param  string         $period                a value to indicate what interval is being used in the
-     *                                               calculation. The options are 'years', 'months', 'days', 'hours',
-     *                                               'minutes', 'seconds'. Defaults to years.
-     * @param  integer        $value                 What you want to increment the date by
-     * @param  string         $operand               What operand you wish to use for the calculation
-     * @return mixed string|DateTime          return whatever type came in.
-     */
-    public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+')
-    {
-        if ($DateTime_or_timestamp instanceof DateTime) {
-            return EEH_DTT_Helper::_modify_datetime_object($DateTime_or_timestamp, $period, $value, $operand);
-        } else if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
-            return EEH_DTT_Helper::_modify_timestamp($DateTime_or_timestamp, $period, $value, $operand);
-        } else {
-            //error
-            return $DateTime_or_timestamp;
-        }
-    }
-
-
-    /**
-     * The purpose of this helper method is to receive an incoming format string in php date/time format
-     * and spit out the js and moment.js equivalent formats.
-     * Note, if no format string is given, then it is assumed the user wants what is set for WP.
-     * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date-
-     * time picker.
-     *
-     * @see http://stackoverflow.com/posts/16725290/ for the code inspiration.
-     * @param null $date_format_string
-     * @param null $time_format_string
-     * @return array
-     *                array(
-     *                'js' => array (
-     *                'date' => //date format
-     *                'time' => //time format
-     *                ),
-     *                'moment' => //date and time format.
-     *                )
-     */
-    public static function convert_php_to_js_and_moment_date_formats(
-        $date_format_string = null,
-        $time_format_string = null
-    ) {
-        if ($date_format_string === null) {
-            $date_format_string = get_option('date_format');
-        }
-
-        if ($time_format_string === null) {
-            $time_format_string = get_option('time_format');
-        }
-
-        $date_format = self::_php_to_js_moment_converter($date_format_string);
-        $time_format = self::_php_to_js_moment_converter($time_format_string);
-
-        return array(
-            'js'     => array(
-                'date' => $date_format['js'],
-                'time' => $time_format['js'],
-            ),
-            'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
-        );
-    }
-
-
-    /**
-     * This converts incoming format string into js and moment variations.
-     *
-     * @param string $format_string incoming php format string
-     * @return array js and moment formats.
-     */
-    protected static function _php_to_js_moment_converter($format_string)
-    {
-        /**
-         * This is a map of symbols for formats.
-         * The index is the php symbol, the equivalent values are in the array.
-         *
-         * @var array
-         */
-        $symbols_map      = array(
-            // Day
-            //01
-            'd' => array(
-                'js'     => 'dd',
-                'moment' => 'DD',
-            ),
-            //Mon
-            'D' => array(
-                'js'     => 'D',
-                'moment' => 'ddd',
-            ),
-            //1,2,...31
-            'j' => array(
-                'js'     => 'd',
-                'moment' => 'D',
-            ),
-            //Monday
-            'l' => array(
-                'js'     => 'DD',
-                'moment' => 'dddd',
-            ),
-            //ISO numeric representation of the day of the week (1-6)
-            'N' => array(
-                'js'     => '',
-                'moment' => 'E',
-            ),
-            //st,nd.rd
-            'S' => array(
-                'js'     => '',
-                'moment' => 'o',
-            ),
-            //numeric representation of day of week (0-6)
-            'w' => array(
-                'js'     => '',
-                'moment' => 'd',
-            ),
-            //day of year starting from 0 (0-365)
-            'z' => array(
-                'js'     => 'o',
-                'moment' => 'DDD' //note moment does not start with 0 so will need to modify by subtracting 1
-            ),
-            // Week
-            //ISO-8601 week number of year (weeks starting on monday)
-            'W' => array(
-                'js'     => '',
-                'moment' => 'w',
-            ),
-            // Month
-            // January...December
-            'F' => array(
-                'js'     => 'MM',
-                'moment' => 'MMMM',
-            ),
-            //01...12
-            'm' => array(
-                'js'     => 'mm',
-                'moment' => 'MM',
-            ),
-            //Jan...Dec
-            'M' => array(
-                'js'     => 'M',
-                'moment' => 'MMM',
-            ),
-            //1-12
-            'n' => array(
-                'js'     => 'm',
-                'moment' => 'M',
-            ),
-            //number of days in given month
-            't' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-            // Year
-            //whether leap year or not 1/0
-            'L' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-            //ISO-8601 year number
-            'o' => array(
-                'js'     => '',
-                'moment' => 'GGGG',
-            ),
-            //1999...2003
-            'Y' => array(
-                'js'     => 'yy',
-                'moment' => 'YYYY',
-            ),
-            //99...03
-            'y' => array(
-                'js'     => 'y',
-                'moment' => 'YY',
-            ),
-            // Time
-            // am/pm
-            'a' => array(
-                'js'     => 'tt',
-                'moment' => 'a',
-            ),
-            // AM/PM
-            'A' => array(
-                'js'     => 'TT',
-                'moment' => 'A',
-            ),
-            // Swatch Internet Time?!?
-            'B' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-            //1...12
-            'g' => array(
-                'js'     => 'h',
-                'moment' => 'h',
-            ),
-            //0...23
-            'G' => array(
-                'js'     => 'H',
-                'moment' => 'H',
-            ),
-            //01...12
-            'h' => array(
-                'js'     => 'hh',
-                'moment' => 'hh',
-            ),
-            //00...23
-            'H' => array(
-                'js'     => 'HH',
-                'moment' => 'HH',
-            ),
-            //00..59
-            'i' => array(
-                'js'     => 'mm',
-                'moment' => 'mm',
-            ),
-            //seconds... 00...59
-            's' => array(
-                'js'     => 'ss',
-                'moment' => 'ss',
-            ),
-            //microseconds
-            'u' => array(
-                'js'     => '',
-                'moment' => '',
-            ),
-        );
-        $jquery_ui_format = "";
-        $moment_format    = "";
-        $escaping         = false;
-        for ($i = 0; $i < strlen($format_string); $i++) {
-            $char = $format_string[$i];
-            if ($char === '\\') { // PHP date format escaping character
-                $i++;
-                if ($escaping) {
-                    $jquery_ui_format .= $format_string[$i];
-                    $moment_format .= $format_string[$i];
-                } else {
-                    $jquery_ui_format .= '\'' . $format_string[$i];
-                    $moment_format .= $format_string[$i];
-                }
-                $escaping = true;
-            } else {
-                if ($escaping) {
-                    $jquery_ui_format .= "'";
-                    $moment_format .= "'";
-                    $escaping = false;
-                }
-                if (isset($symbols_map[$char])) {
-                    $jquery_ui_format .= $symbols_map[$char]['js'];
-                    $moment_format .= $symbols_map[$char]['moment'];
-                } else {
-                    $jquery_ui_format .= $char;
-                    $moment_format .= $char;
-                }
-            }
-        }
-        return array('js' => $jquery_ui_format, 'moment' => $moment_format);
-    }
-
-
-    /**
-     * This takes an incoming format string and validates it to ensure it will work fine with PHP.
-     *
-     * @param string $format_string   Incoming format string for php date().
-     * @return mixed bool|array  If all is okay then TRUE is returned.  Otherwise an array of validation
-     *                                errors is returned.  So for client code calling, check for is_array() to
-     *                                indicate failed validations.
-     */
-    public static function validate_format_string($format_string)
-    {
-        $error_msg = array();
-        //time format checks
-        switch (true) {
-            case   strpos($format_string, 'h') !== false  :
-            case   strpos($format_string, 'g') !== false :
-                /**
-                 * if the time string has a lowercase 'h' which == 12 hour time format and there
-                 * is not any ante meridiem format ('a' or 'A').  Then throw an error because its
-                 * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am.
-                 */
-                if (strpos(strtoupper($format_string), 'A') === false) {
-                    $error_msg[] = __('There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".',
-                        'event_espresso');
-                }
-                break;
-
-        }
-
-        return empty($error_msg) ? true : $error_msg;
-    }
-
-
-    /**
-     *     If the the first date starts at midnight on one day, and the next date ends at midnight on the
-     *     very next day then this method will return true.
-     *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true.
-     *    If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false.
-     *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true.
-     *
-     * @param mixed $date_1
-     * @param mixed $date_2
-     * @return bool
-     */
-    public static function dates_represent_one_24_hour_date($date_1, $date_2)
-    {
-
-        if (
-            (! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) ||
-            ($date_1->format(EE_Datetime_Field::mysql_time_format) != '00:00:00' || $date_2->format(EE_Datetime_Field::mysql_time_format) != '00:00:00')
-        ) {
-            return false;
-        }
-        return $date_2->format('U') - $date_1->format('U') == 86400 ? true : false;
-    }
-
-
-    /**
-     * This returns the appropriate query interval string that can be used in sql queries involving mysql Date
-     * Functions.
-     *
-     * @param string $timezone_string    A timezone string in a valid format to instantiate a DateTimeZone object.
-     * @param string $field_for_interval The Database field that is the interval is applied to in the query.
-     * @return string
-     */
-    public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval)
-    {
-        try {
-            /** need to account for timezone offset on the selects */
-            $DateTimeZone = new DateTimeZone($timezone_string);
-        } catch (Exception $e) {
-            $DateTimeZone = null;
-        }
-
-        /**
-         * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds.
-         * Hence we do the calc for DateTimeZone::getOffset.
-         */
-        $offset         = $DateTimeZone instanceof DateTimeZone ? ($DateTimeZone->getOffset(new DateTime('now'))) / HOUR_IN_SECONDS : get_option('gmt_offset');
-        $query_interval = $offset < 0
-            ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
-            : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
-        return $query_interval;
-    }
-
-    /**
-     * Retrieves the site's default timezone and returns it formatted so it's ready for display
-     * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string'
-     * and 'gmt_offset' WordPress options directly; or use the filter
-     * FHEE__EEH_DTT_Helper__get_timezone_string_for_display
-     * (although note that we remove any HTML that may be added)
-     *
-     * @return string
-     */
-    public static function get_timezone_string_for_display()
-    {
-        $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
-        if (! empty($pretty_timezone)) {
-            return esc_html($pretty_timezone);
-        }
-        $timezone_string = get_option('timezone_string');
-        if ($timezone_string) {
-            static $mo_loaded = false;
-            // Load translations for continents and cities just like wp_timezone_choice does
-            if (! $mo_loaded) {
-                $locale = get_locale();
-                $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
-                load_textdomain('continents-cities', $mofile);
-                $mo_loaded = true;
-            }
-            //well that was easy.
-            $parts = explode('/', $timezone_string);
-            //remove the continent
-            unset($parts[0]);
-            $t_parts = array();
-            foreach ($parts as $part) {
-                $t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities');
-            }
-            return implode(' - ', $t_parts);
-        }
-        //they haven't set the timezone string, so let's return a string like "UTC+1"
-        $gmt_offset = get_option('gmt_offset');
-        if (intval($gmt_offset) >= 0) {
-            $prefix = '+';
-        } else {
-            $prefix = '';
-        }
-        $parts = explode('.', (string)$gmt_offset);
-        if (count($parts) === 1) {
-            $parts[1] = '00';
-        } else {
-            //convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
-            //to minutes, eg 30 or 15, respectively
-            $hour_fraction = (float)('0.' . $parts[1]);
-            $parts[1]      = (string)$hour_fraction * 60;
-        }
-        return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
-    }
-
-
-
-    /**
-     * So PHP does this awesome thing where if you are trying to get a timestamp
-     * for a month using a string like "February" or "February 2017",
-     * and you don't specify a day as part of your string,
-     * then PHP will use whatever the current day of the month is.
-     * IF the current day of the month happens to be the 30th or 31st,
-     * then PHP gets really confused by a date like February 30,
-     * so instead of saying
-     *      "Hey February only has 28 days (this year)...
-     *      ...you must have meant the last day of the month!"
-     * PHP does the next most logical thing, and bumps the date up to March 2nd,
-     * because someone requesting February 30th obviously meant March 1st!
-     * The way around this is to always set the day to the first,
-     * so that the month will stay on the month you wanted.
-     * this method will add that "1" into your date regardless of the format.
-     *
-     * @param string $month
-     * @return string
-     */
-    public static function first_of_month_timestamp($month = '')
-    {
-        $month = (string)$month;
-        $year = '';
-        // check if the incoming string has a year in it or not
-       if (preg_match('/\b\d{4}\b/', $month, $matches)) {
-           $year = $matches[0];
-           // ten remove that from the month string as well as any spaces
-           $month = trim(str_replace($year, '', $month));
-           // add a space before the year
-           $year = " {$year}";
-        }
-        // return timestamp for something like "February 1 2017"
-        return strtotime("{$month} 1{$year}");
-    }
+	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 with the offset applied for the given timezone.
+	 */
+	public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
+	{
+		$unix_timestamp  = $unix_timestamp === 0 ? time() : (int)$unix_timestamp;
+		$timezone_string = self::get_valid_timezone_string($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;
+	}
+
+
+	/**
+	 *    _set_date_time_field
+	 *    modifies EE_Base_Class EE_Datetime_Field objects
+	 *
+	 * @param  EE_Base_Class $obj                 EE_Base_Class object
+	 * @param    DateTime    $DateTime            PHP DateTime object
+	 * @param  string        $datetime_field_name the datetime fieldname to be manipulated
+	 * @return    EE_Base_Class
+	 */
+	protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name)
+	{
+		// grab current datetime format
+		$current_format = $obj->get_format();
+		// set new full timestamp format
+		$obj->set_date_format(EE_Datetime_Field::mysql_date_format);
+		$obj->set_time_format(EE_Datetime_Field::mysql_time_format);
+		// set the new date value using a full timestamp format so that no data is lost
+		$obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format));
+		// reset datetime formats
+		$obj->set_date_format($current_format[0]);
+		$obj->set_time_format($current_format[1]);
+		return $obj;
+	}
+
 
 	/**
-     * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone.  So it may be midnight
-	* for this sites timezone, but the timestamp could be some other time GMT.
-    */
-    public static function tomorrow()
+	 *    date_time_add
+	 *    helper for doing simple datetime calculations on a given datetime from EE_Base_Class
+	 *    and modifying it IN the EE_Base_Class so you don't have to do anything else.
+	 *
+	 * @param  EE_Base_Class $obj                 EE_Base_Class object
+	 * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
+	 * @param  string        $period              what you are adding. The options are (years, months, days, hours,
+	 *                                            minutes, seconds) defaults to years
+	 * @param  integer       $value               what you want to increment the time by
+	 * @return EE_Base_Class           return the EE_Base_Class object so right away you can do something with it
+	 *                                 (chaining)
+	 */
+	public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
+	{
+		//get the raw UTC date.
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value);
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
+	}
+
+
+	/**
+	 *    date_time_subtract
+	 *    same as date_time_add except subtracting value instead of adding.
+	 *
+	 * @param \EE_Base_Class $obj
+	 * @param  string        $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated
+	 * @param string         $period
+	 * @param int            $value
+	 * @return \EE_Base_Class
+	 */
+	public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1)
+	{
+		//get the raw UTC date
+		$DateTime = $obj->get_DateTime_object($datetime_field_name);
+		$DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-');
+		return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name);
+	}
+
+
+	/**
+	 * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters
+	 *
+	 * @param  DateTime $DateTime DateTime object
+	 * @param  string   $period   a value to indicate what interval is being used in the calculation. The options are
+	 *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
+	 * @param  integer  $value    What you want to increment the date by
+	 * @param  string   $operand  What operand you wish to use for the calculation
+	 * @return \DateTime return whatever type came in.
+	 * @throws \EE_Error
+	 */
+	protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
+	{
+		if (! $DateTime instanceof DateTime) {
+			throw new EE_Error(
+				sprintf(
+					__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
+					print_r($DateTime, true)
+				)
+			);
+		}
+		switch ($period) {
+			case 'years' :
+				$value = 'P' . $value . 'Y';
+				break;
+			case 'months' :
+				$value = 'P' . $value . 'M';
+				break;
+			case 'weeks' :
+				$value = 'P' . $value . 'W';
+				break;
+			case 'days' :
+				$value = 'P' . $value . 'D';
+				break;
+			case 'hours' :
+				$value = 'PT' . $value . 'H';
+				break;
+			case 'minutes' :
+				$value = 'PT' . $value . 'M';
+				break;
+			case 'seconds' :
+				$value = 'PT' . $value . 'S';
+				break;
+		}
+		switch ($operand) {
+			case '+':
+				$DateTime->add(new DateInterval($value));
+				break;
+			case '-':
+				$DateTime->sub(new DateInterval($value));
+				break;
+		}
+		return $DateTime;
+	}
+
+
+	/**
+	 * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters
+	 *
+	 * @param  int     $timestamp Unix timestamp
+	 * @param  string  $period    a value to indicate what interval is being used in the calculation. The options are
+	 *                            'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years.
+	 * @param  integer $value     What you want to increment the date by
+	 * @param  string  $operand   What operand you wish to use for the calculation
+	 * @return \DateTime return whatever type came in.
+	 * @throws \EE_Error
+	 */
+	protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
+	{
+		if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
+			throw new EE_Error(
+				sprintf(
+					__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
+					print_r($timestamp, true)
+				)
+			);
+		}
+		switch ($period) {
+			case 'years' :
+				$value = YEAR_IN_SECONDS * $value;
+				break;
+			case 'months' :
+				$value = YEAR_IN_SECONDS / 12 * $value;
+				break;
+			case 'weeks' :
+				$value = WEEK_IN_SECONDS * $value;
+				break;
+			case 'days' :
+				$value = DAY_IN_SECONDS * $value;
+				break;
+			case 'hours' :
+				$value = HOUR_IN_SECONDS * $value;
+				break;
+			case 'minutes' :
+				$value = MINUTE_IN_SECONDS * $value;
+				break;
+		}
+		switch ($operand) {
+			case '+':
+				$timestamp += $value;
+				break;
+			case '-':
+				$timestamp -= $value;
+				break;
+		}
+		return $timestamp;
+	}
+
+
+	/**
+	 * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming
+	 * parameters and returns the new timestamp or DateTime.
+	 *
+	 * @param  int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp
+	 * @param  string         $period                a value to indicate what interval is being used in the
+	 *                                               calculation. The options are 'years', 'months', 'days', 'hours',
+	 *                                               'minutes', 'seconds'. Defaults to years.
+	 * @param  integer        $value                 What you want to increment the date by
+	 * @param  string         $operand               What operand you wish to use for the calculation
+	 * @return mixed string|DateTime          return whatever type came in.
+	 */
+	public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+')
+	{
+		if ($DateTime_or_timestamp instanceof DateTime) {
+			return EEH_DTT_Helper::_modify_datetime_object($DateTime_or_timestamp, $period, $value, $operand);
+		} else if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
+			return EEH_DTT_Helper::_modify_timestamp($DateTime_or_timestamp, $period, $value, $operand);
+		} else {
+			//error
+			return $DateTime_or_timestamp;
+		}
+	}
+
+
+	/**
+	 * The purpose of this helper method is to receive an incoming format string in php date/time format
+	 * and spit out the js and moment.js equivalent formats.
+	 * Note, if no format string is given, then it is assumed the user wants what is set for WP.
+	 * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date-
+	 * time picker.
+	 *
+	 * @see http://stackoverflow.com/posts/16725290/ for the code inspiration.
+	 * @param null $date_format_string
+	 * @param null $time_format_string
+	 * @return array
+	 *                array(
+	 *                'js' => array (
+	 *                'date' => //date format
+	 *                'time' => //time format
+	 *                ),
+	 *                'moment' => //date and time format.
+	 *                )
+	 */
+	public static function convert_php_to_js_and_moment_date_formats(
+		$date_format_string = null,
+		$time_format_string = null
+	) {
+		if ($date_format_string === null) {
+			$date_format_string = get_option('date_format');
+		}
+
+		if ($time_format_string === null) {
+			$time_format_string = get_option('time_format');
+		}
+
+		$date_format = self::_php_to_js_moment_converter($date_format_string);
+		$time_format = self::_php_to_js_moment_converter($time_format_string);
+
+		return array(
+			'js'     => array(
+				'date' => $date_format['js'],
+				'time' => $time_format['js'],
+			),
+			'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
+		);
+	}
+
+
+	/**
+	 * This converts incoming format string into js and moment variations.
+	 *
+	 * @param string $format_string incoming php format string
+	 * @return array js and moment formats.
+	 */
+	protected static function _php_to_js_moment_converter($format_string)
+	{
+		/**
+		 * This is a map of symbols for formats.
+		 * The index is the php symbol, the equivalent values are in the array.
+		 *
+		 * @var array
+		 */
+		$symbols_map      = array(
+			// Day
+			//01
+			'd' => array(
+				'js'     => 'dd',
+				'moment' => 'DD',
+			),
+			//Mon
+			'D' => array(
+				'js'     => 'D',
+				'moment' => 'ddd',
+			),
+			//1,2,...31
+			'j' => array(
+				'js'     => 'd',
+				'moment' => 'D',
+			),
+			//Monday
+			'l' => array(
+				'js'     => 'DD',
+				'moment' => 'dddd',
+			),
+			//ISO numeric representation of the day of the week (1-6)
+			'N' => array(
+				'js'     => '',
+				'moment' => 'E',
+			),
+			//st,nd.rd
+			'S' => array(
+				'js'     => '',
+				'moment' => 'o',
+			),
+			//numeric representation of day of week (0-6)
+			'w' => array(
+				'js'     => '',
+				'moment' => 'd',
+			),
+			//day of year starting from 0 (0-365)
+			'z' => array(
+				'js'     => 'o',
+				'moment' => 'DDD' //note moment does not start with 0 so will need to modify by subtracting 1
+			),
+			// Week
+			//ISO-8601 week number of year (weeks starting on monday)
+			'W' => array(
+				'js'     => '',
+				'moment' => 'w',
+			),
+			// Month
+			// January...December
+			'F' => array(
+				'js'     => 'MM',
+				'moment' => 'MMMM',
+			),
+			//01...12
+			'm' => array(
+				'js'     => 'mm',
+				'moment' => 'MM',
+			),
+			//Jan...Dec
+			'M' => array(
+				'js'     => 'M',
+				'moment' => 'MMM',
+			),
+			//1-12
+			'n' => array(
+				'js'     => 'm',
+				'moment' => 'M',
+			),
+			//number of days in given month
+			't' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+			// Year
+			//whether leap year or not 1/0
+			'L' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+			//ISO-8601 year number
+			'o' => array(
+				'js'     => '',
+				'moment' => 'GGGG',
+			),
+			//1999...2003
+			'Y' => array(
+				'js'     => 'yy',
+				'moment' => 'YYYY',
+			),
+			//99...03
+			'y' => array(
+				'js'     => 'y',
+				'moment' => 'YY',
+			),
+			// Time
+			// am/pm
+			'a' => array(
+				'js'     => 'tt',
+				'moment' => 'a',
+			),
+			// AM/PM
+			'A' => array(
+				'js'     => 'TT',
+				'moment' => 'A',
+			),
+			// Swatch Internet Time?!?
+			'B' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+			//1...12
+			'g' => array(
+				'js'     => 'h',
+				'moment' => 'h',
+			),
+			//0...23
+			'G' => array(
+				'js'     => 'H',
+				'moment' => 'H',
+			),
+			//01...12
+			'h' => array(
+				'js'     => 'hh',
+				'moment' => 'hh',
+			),
+			//00...23
+			'H' => array(
+				'js'     => 'HH',
+				'moment' => 'HH',
+			),
+			//00..59
+			'i' => array(
+				'js'     => 'mm',
+				'moment' => 'mm',
+			),
+			//seconds... 00...59
+			's' => array(
+				'js'     => 'ss',
+				'moment' => 'ss',
+			),
+			//microseconds
+			'u' => array(
+				'js'     => '',
+				'moment' => '',
+			),
+		);
+		$jquery_ui_format = "";
+		$moment_format    = "";
+		$escaping         = false;
+		for ($i = 0; $i < strlen($format_string); $i++) {
+			$char = $format_string[$i];
+			if ($char === '\\') { // PHP date format escaping character
+				$i++;
+				if ($escaping) {
+					$jquery_ui_format .= $format_string[$i];
+					$moment_format .= $format_string[$i];
+				} else {
+					$jquery_ui_format .= '\'' . $format_string[$i];
+					$moment_format .= $format_string[$i];
+				}
+				$escaping = true;
+			} else {
+				if ($escaping) {
+					$jquery_ui_format .= "'";
+					$moment_format .= "'";
+					$escaping = false;
+				}
+				if (isset($symbols_map[$char])) {
+					$jquery_ui_format .= $symbols_map[$char]['js'];
+					$moment_format .= $symbols_map[$char]['moment'];
+				} else {
+					$jquery_ui_format .= $char;
+					$moment_format .= $char;
+				}
+			}
+		}
+		return array('js' => $jquery_ui_format, 'moment' => $moment_format);
+	}
+
+
+	/**
+	 * This takes an incoming format string and validates it to ensure it will work fine with PHP.
+	 *
+	 * @param string $format_string   Incoming format string for php date().
+	 * @return mixed bool|array  If all is okay then TRUE is returned.  Otherwise an array of validation
+	 *                                errors is returned.  So for client code calling, check for is_array() to
+	 *                                indicate failed validations.
+	 */
+	public static function validate_format_string($format_string)
+	{
+		$error_msg = array();
+		//time format checks
+		switch (true) {
+			case   strpos($format_string, 'h') !== false  :
+			case   strpos($format_string, 'g') !== false :
+				/**
+				 * if the time string has a lowercase 'h' which == 12 hour time format and there
+				 * is not any ante meridiem format ('a' or 'A').  Then throw an error because its
+				 * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am.
+				 */
+				if (strpos(strtoupper($format_string), 'A') === false) {
+					$error_msg[] = __('There is a  time format for 12 hour time but no  "a" or "A" to indicate am/pm.  Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".',
+						'event_espresso');
+				}
+				break;
+
+		}
+
+		return empty($error_msg) ? true : $error_msg;
+	}
+
+
+	/**
+	 *     If the the first date starts at midnight on one day, and the next date ends at midnight on the
+	 *     very next day then this method will return true.
+	 *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true.
+	 *    If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false.
+	 *    If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true.
+	 *
+	 * @param mixed $date_1
+	 * @param mixed $date_2
+	 * @return bool
+	 */
+	public static function dates_represent_one_24_hour_date($date_1, $date_2)
+	{
+
+		if (
+			(! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) ||
+			($date_1->format(EE_Datetime_Field::mysql_time_format) != '00:00:00' || $date_2->format(EE_Datetime_Field::mysql_time_format) != '00:00:00')
+		) {
+			return false;
+		}
+		return $date_2->format('U') - $date_1->format('U') == 86400 ? true : false;
+	}
+
+
+	/**
+	 * This returns the appropriate query interval string that can be used in sql queries involving mysql Date
+	 * Functions.
+	 *
+	 * @param string $timezone_string    A timezone string in a valid format to instantiate a DateTimeZone object.
+	 * @param string $field_for_interval The Database field that is the interval is applied to in the query.
+	 * @return string
+	 */
+	public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval)
+	{
+		try {
+			/** need to account for timezone offset on the selects */
+			$DateTimeZone = new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
+			$DateTimeZone = null;
+		}
+
+		/**
+		 * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds.
+		 * Hence we do the calc for DateTimeZone::getOffset.
+		 */
+		$offset         = $DateTimeZone instanceof DateTimeZone ? ($DateTimeZone->getOffset(new DateTime('now'))) / HOUR_IN_SECONDS : get_option('gmt_offset');
+		$query_interval = $offset < 0
+			? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
+			: 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
+		return $query_interval;
+	}
+
+	/**
+	 * Retrieves the site's default timezone and returns it formatted so it's ready for display
+	 * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string'
+	 * and 'gmt_offset' WordPress options directly; or use the filter
+	 * FHEE__EEH_DTT_Helper__get_timezone_string_for_display
+	 * (although note that we remove any HTML that may be added)
+	 *
+	 * @return string
+	 */
+	public static function get_timezone_string_for_display()
+	{
+		$pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
+		if (! empty($pretty_timezone)) {
+			return esc_html($pretty_timezone);
+		}
+		$timezone_string = get_option('timezone_string');
+		if ($timezone_string) {
+			static $mo_loaded = false;
+			// Load translations for continents and cities just like wp_timezone_choice does
+			if (! $mo_loaded) {
+				$locale = get_locale();
+				$mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
+				load_textdomain('continents-cities', $mofile);
+				$mo_loaded = true;
+			}
+			//well that was easy.
+			$parts = explode('/', $timezone_string);
+			//remove the continent
+			unset($parts[0]);
+			$t_parts = array();
+			foreach ($parts as $part) {
+				$t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities');
+			}
+			return implode(' - ', $t_parts);
+		}
+		//they haven't set the timezone string, so let's return a string like "UTC+1"
+		$gmt_offset = get_option('gmt_offset');
+		if (intval($gmt_offset) >= 0) {
+			$prefix = '+';
+		} else {
+			$prefix = '';
+		}
+		$parts = explode('.', (string)$gmt_offset);
+		if (count($parts) === 1) {
+			$parts[1] = '00';
+		} else {
+			//convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
+			//to minutes, eg 30 or 15, respectively
+			$hour_fraction = (float)('0.' . $parts[1]);
+			$parts[1]      = (string)$hour_fraction * 60;
+		}
+		return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
+	}
+
+
+
+	/**
+	 * So PHP does this awesome thing where if you are trying to get a timestamp
+	 * for a month using a string like "February" or "February 2017",
+	 * and you don't specify a day as part of your string,
+	 * then PHP will use whatever the current day of the month is.
+	 * IF the current day of the month happens to be the 30th or 31st,
+	 * then PHP gets really confused by a date like February 30,
+	 * so instead of saying
+	 *      "Hey February only has 28 days (this year)...
+	 *      ...you must have meant the last day of the month!"
+	 * PHP does the next most logical thing, and bumps the date up to March 2nd,
+	 * because someone requesting February 30th obviously meant March 1st!
+	 * The way around this is to always set the day to the first,
+	 * so that the month will stay on the month you wanted.
+	 * this method will add that "1" into your date regardless of the format.
+	 *
+	 * @param string $month
+	 * @return string
+	 */
+	public static function first_of_month_timestamp($month = '')
+	{
+		$month = (string)$month;
+		$year = '';
+		// check if the incoming string has a year in it or not
+	   if (preg_match('/\b\d{4}\b/', $month, $matches)) {
+		   $year = $matches[0];
+		   // ten remove that from the month string as well as any spaces
+		   $month = trim(str_replace($year, '', $month));
+		   // add a space before the year
+		   $year = " {$year}";
+		}
+		// return timestamp for something like "February 1 2017"
+		return strtotime("{$month} 1{$year}");
+	}
+
+	/**
+	 * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone.  So it may be midnight
+	 * for this sites timezone, but the timestamp could be some other time GMT.
+	 */
+	public static function tomorrow()
 	{
 		//The multiplication of -1 ensures that we switch positive offsets to negative and negative offsets to positive
 		//before adding to the timestamp.  Why? Because we want tomorrow to be for midnight the next day in THIS timezone
@@ -1107,135 +1107,135 @@ 
 	}
 
 
-    /**
-     * **
-     * Gives a nicely-formatted list of timezone strings.
-     * Copied from the core wp function by the same name so we could customize to remove UTC offsets.
-     *
-     * @since     4.9.40.rc.008
-     * @staticvar bool $mo_loaded
-     * @staticvar string $locale_loaded
-     * @param string $selected_zone Selected timezone.
-     * @param string $locale        Optional. Locale to load the timezones in. Default current site locale.
-     * @return string
-     */
-    public static function wp_timezone_choice($selected_zone, $locale = null)
-    {
-        static $mo_loaded = false, $locale_loaded = null;
-
-        $continents = array(
-            'Africa',
-            'America',
-            'Antarctica',
-            'Arctic',
-            'Asia',
-            'Atlantic',
-            'Australia',
-            'Europe',
-            'Indian',
-            'Pacific',
-        );
-
-        // Load translations for continents and cities.
-        if (! $mo_loaded || $locale !== $locale_loaded) {
-            $locale_loaded = $locale ? $locale : get_locale();
-            $mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
-            unload_textdomain('continents-cities');
-            load_textdomain('continents-cities', $mofile);
-            $mo_loaded = true;
-        }
-
-        $zonen = array();
-        foreach (timezone_identifiers_list() as $zone) {
-            $zone = explode('/', $zone);
-            if (! in_array($zone[0], $continents)) {
-                continue;
-            }
-
-            // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
-            $exists    = array(
-                0 => (isset($zone[0]) && $zone[0]),
-                1 => (isset($zone[1]) && $zone[1]),
-                2 => (isset($zone[2]) && $zone[2]),
-            );
-            $exists[3] = ($exists[0] && 'Etc' !== $zone[0]);
-            $exists[4] = ($exists[1] && $exists[3]);
-            $exists[5] = ($exists[2] && $exists[3]);
-
-            $zonen[] = array(
-                'continent'   => ($exists[0] ? $zone[0] : ''),
-                'city'        => ($exists[1] ? $zone[1] : ''),
-                'subcity'     => ($exists[2] ? $zone[2] : ''),
-                't_continent' => ($exists[3] ? translate(str_replace('_', ' ', $zone[0]), 'continents-cities') : ''),
-                't_city'      => ($exists[4] ? translate(str_replace('_', ' ', $zone[1]), 'continents-cities') : ''),
-                't_subcity'   => ($exists[5] ? translate(str_replace('_', ' ', $zone[2]), 'continents-cities') : ''),
-            );
-        }
-        usort($zonen, '_wp_timezone_choice_usort_callback');
-
-        $structure = array();
-
-        if (empty($selected_zone)) {
-            $structure[] = '<option selected="selected" value="">' . __('Select a city') . '</option>';
-        }
-
-        foreach ($zonen as $key => $zone) {
-            // Build value in an array to join later
-            $value = array($zone['continent']);
-
-            if (empty($zone['city'])) {
-                // It's at the continent level (generally won't happen)
-                $display = $zone['t_continent'];
-            } else {
-                // It's inside a continent group
-
-                // Continent optgroup
-                if (! isset($zonen[$key - 1]) || $zonen[$key - 1]['continent'] !== $zone['continent']) {
-                    $label       = $zone['t_continent'];
-                    $structure[] = '<optgroup label="' . esc_attr($label) . '">';
-                }
-
-                // Add the city to the value
-                $value[] = $zone['city'];
-
-                $display = $zone['t_city'];
-                if (! empty($zone['subcity'])) {
-                    // Add the subcity to the value
-                    $value[] = $zone['subcity'];
-                    $display .= ' - ' . $zone['t_subcity'];
-                }
-            }
-
-            // Build the value
-            $value    = join('/', $value);
-            $selected = '';
-            if ($value === $selected_zone) {
-                $selected = 'selected="selected" ';
-            }
-            $structure[] = '<option ' . $selected . 'value="' . esc_attr($value) . '">' . esc_html($display) . "</option>";
-
-            // Close continent optgroup
-            if (! empty($zone['city']) && (! isset($zonen[$key + 1]) || (isset($zonen[$key + 1]) && $zonen[$key + 1]['continent'] !== $zone['continent']))) {
-                $structure[] = '</optgroup>';
-            }
-        }
-
-        return join("\n", $structure);
-    }
-
-
-    /**
-     * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
-     *
-     * @param int|WP_User $user_id
-     * @return string
-     */
-    public static function get_user_locale($user_id = 0)
-    {
-        if (function_exists('get_user_locale')) {
-            return get_user_locale($user_id);
-        }
-        return get_locale();
-    }
+	/**
+	 * **
+	 * Gives a nicely-formatted list of timezone strings.
+	 * Copied from the core wp function by the same name so we could customize to remove UTC offsets.
+	 *
+	 * @since     4.9.40.rc.008
+	 * @staticvar bool $mo_loaded
+	 * @staticvar string $locale_loaded
+	 * @param string $selected_zone Selected timezone.
+	 * @param string $locale        Optional. Locale to load the timezones in. Default current site locale.
+	 * @return string
+	 */
+	public static function wp_timezone_choice($selected_zone, $locale = null)
+	{
+		static $mo_loaded = false, $locale_loaded = null;
+
+		$continents = array(
+			'Africa',
+			'America',
+			'Antarctica',
+			'Arctic',
+			'Asia',
+			'Atlantic',
+			'Australia',
+			'Europe',
+			'Indian',
+			'Pacific',
+		);
+
+		// Load translations for continents and cities.
+		if (! $mo_loaded || $locale !== $locale_loaded) {
+			$locale_loaded = $locale ? $locale : get_locale();
+			$mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
+			unload_textdomain('continents-cities');
+			load_textdomain('continents-cities', $mofile);
+			$mo_loaded = true;
+		}
+
+		$zonen = array();
+		foreach (timezone_identifiers_list() as $zone) {
+			$zone = explode('/', $zone);
+			if (! in_array($zone[0], $continents)) {
+				continue;
+			}
+
+			// This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
+			$exists    = array(
+				0 => (isset($zone[0]) && $zone[0]),
+				1 => (isset($zone[1]) && $zone[1]),
+				2 => (isset($zone[2]) && $zone[2]),
+			);
+			$exists[3] = ($exists[0] && 'Etc' !== $zone[0]);
+			$exists[4] = ($exists[1] && $exists[3]);
+			$exists[5] = ($exists[2] && $exists[3]);
+
+			$zonen[] = array(
+				'continent'   => ($exists[0] ? $zone[0] : ''),
+				'city'        => ($exists[1] ? $zone[1] : ''),
+				'subcity'     => ($exists[2] ? $zone[2] : ''),
+				't_continent' => ($exists[3] ? translate(str_replace('_', ' ', $zone[0]), 'continents-cities') : ''),
+				't_city'      => ($exists[4] ? translate(str_replace('_', ' ', $zone[1]), 'continents-cities') : ''),
+				't_subcity'   => ($exists[5] ? translate(str_replace('_', ' ', $zone[2]), 'continents-cities') : ''),
+			);
+		}
+		usort($zonen, '_wp_timezone_choice_usort_callback');
+
+		$structure = array();
+
+		if (empty($selected_zone)) {
+			$structure[] = '<option selected="selected" value="">' . __('Select a city') . '</option>';
+		}
+
+		foreach ($zonen as $key => $zone) {
+			// Build value in an array to join later
+			$value = array($zone['continent']);
+
+			if (empty($zone['city'])) {
+				// It's at the continent level (generally won't happen)
+				$display = $zone['t_continent'];
+			} else {
+				// It's inside a continent group
+
+				// Continent optgroup
+				if (! isset($zonen[$key - 1]) || $zonen[$key - 1]['continent'] !== $zone['continent']) {
+					$label       = $zone['t_continent'];
+					$structure[] = '<optgroup label="' . esc_attr($label) . '">';
+				}
+
+				// Add the city to the value
+				$value[] = $zone['city'];
+
+				$display = $zone['t_city'];
+				if (! empty($zone['subcity'])) {
+					// Add the subcity to the value
+					$value[] = $zone['subcity'];
+					$display .= ' - ' . $zone['t_subcity'];
+				}
+			}
+
+			// Build the value
+			$value    = join('/', $value);
+			$selected = '';
+			if ($value === $selected_zone) {
+				$selected = 'selected="selected" ';
+			}
+			$structure[] = '<option ' . $selected . 'value="' . esc_attr($value) . '">' . esc_html($display) . "</option>";
+
+			// Close continent optgroup
+			if (! empty($zone['city']) && (! isset($zonen[$key + 1]) || (isset($zonen[$key + 1]) && $zonen[$key + 1]['continent'] !== $zone['continent']))) {
+				$structure[] = '</optgroup>';
+			}
+		}
+
+		return join("\n", $structure);
+	}
+
+
+	/**
+	 * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0
+	 *
+	 * @param int|WP_User $user_id
+	 * @return string
+	 */
+	public static function get_user_locale($user_id = 0)
+	{
+		if (function_exists('get_user_locale')) {
+			return get_user_locale($user_id);
+		}
+		return get_locale();
+	}
 
 }// end class EEH_DTT_Helper

Spacing +51 added lines, -52 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -74,7 +74,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(
@@ -159,7 +159,7 @@ 
             }
         }
         $offset = get_option('gmt_offset');
-        return (int)($offset * HOUR_IN_SECONDS);
+        return (int) ($offset * HOUR_IN_SECONDS);
     }
 
 
@@ -177,7 +177,7 @@ 
     public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
     {
         //make sure $gmt_offset is int
-        $gmt_offset = (int)$gmt_offset;
+        $gmt_offset = (int) $gmt_offset;
         switch ($gmt_offset) {
             //-12
             case -43200:
@@ -350,7 +350,7 @@ 
     public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
     {
         $transitions = self::get_timezone_transitions($date_time_zone, $time);
-        if (! isset($transitions['offset'])) {
+        if ( ! isset($transitions['offset'])) {
             throw new DomainException();
         }
         return $transitions['offset'];
@@ -364,7 +364,7 @@ 
     public static function timezone_select_input($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 : get_option('timezone_string');
         // check if the timezone is valid but don't throw any errors if it isn't
@@ -376,9 +376,9 @@ 
             // Create a UTC+- zone if no timezone string exists
             $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;
             } else {
                 $timezone_string = 'UTC';
             }
@@ -400,11 +400,11 @@ 
                 __('%1$sUTC%2$s time is %3$s'),
                 '<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'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
+        <?php if ( ! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+        <br/><span><?php printf(__('Local time is %1$s'), '<code>'.date_i18n($datetime_format).'</code>'); ?></span>
     <?php endif; ?>
 
         <?php if ($check_zone_info && $timezone_string) : ?>
@@ -437,11 +437,10 @@ 
 
                 if ($found) {
                     $message = $tr['isdst'] ?
-                        __(' Daylight saving time begins on: %s.') :
-                        __(' Standard time begins  on: %s.');
+                        __(' Daylight saving time begins on: %s.') : __(' Standard time begins  on: %s.');
                     // 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 >');
+                        '<code >'.date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])).'</code >');
                 } else {
                     _e('This timezone does not observe daylight saving time.');
                 }
@@ -469,13 +468,13 @@ 
      */
     public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
     {
-        $unix_timestamp  = $unix_timestamp === 0 ? time() : (int)$unix_timestamp;
+        $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
         $timezone_string = self::get_valid_timezone_string($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;
+        return (int) $DateTime->format('U') + (int) $offset;
     }
 
 
@@ -558,7 +557,7 @@ 
      */
     protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+')
     {
-        if (! $DateTime instanceof DateTime) {
+        if ( ! $DateTime instanceof DateTime) {
             throw new EE_Error(
                 sprintf(
                     __('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'),
@@ -568,25 +567,25 @@ 
         }
         switch ($period) {
             case 'years' :
-                $value = 'P' . $value . 'Y';
+                $value = 'P'.$value.'Y';
                 break;
             case 'months' :
-                $value = 'P' . $value . 'M';
+                $value = 'P'.$value.'M';
                 break;
             case 'weeks' :
-                $value = 'P' . $value . 'W';
+                $value = 'P'.$value.'W';
                 break;
             case 'days' :
-                $value = 'P' . $value . 'D';
+                $value = 'P'.$value.'D';
                 break;
             case 'hours' :
-                $value = 'PT' . $value . 'H';
+                $value = 'PT'.$value.'H';
                 break;
             case 'minutes' :
-                $value = 'PT' . $value . 'M';
+                $value = 'PT'.$value.'M';
                 break;
             case 'seconds' :
-                $value = 'PT' . $value . 'S';
+                $value = 'PT'.$value.'S';
                 break;
         }
         switch ($operand) {
@@ -614,7 +613,7 @@ 
      */
     protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+')
     {
-        if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
+        if ( ! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) {
             throw new EE_Error(
                 sprintf(
                     __('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'),
@@ -718,7 +717,7 @@ 
                 'date' => $date_format['js'],
                 'time' => $time_format['js'],
             ),
-            'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
+            'moment' => $date_format['moment'].' '.$time_format['moment'],
         );
     }
 
@@ -737,7 +736,7 @@ 
          *
          * @var array
          */
-        $symbols_map      = array(
+        $symbols_map = array(
             // Day
             //01
             'd' => array(
@@ -895,7 +894,7 @@ 
                     $jquery_ui_format .= $format_string[$i];
                     $moment_format .= $format_string[$i];
                 } else {
-                    $jquery_ui_format .= '\'' . $format_string[$i];
+                    $jquery_ui_format .= '\''.$format_string[$i];
                     $moment_format .= $format_string[$i];
                 }
                 $escaping = true;
@@ -965,7 +964,7 @@ 
     {
 
         if (
-            (! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) ||
+            ( ! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) ||
             ($date_1->format(EE_Datetime_Field::mysql_time_format) != '00:00:00' || $date_2->format(EE_Datetime_Field::mysql_time_format) != '00:00:00')
         ) {
             return false;
@@ -997,8 +996,8 @@ 
          */
         $offset         = $DateTimeZone instanceof DateTimeZone ? ($DateTimeZone->getOffset(new DateTime('now'))) / HOUR_IN_SECONDS : get_option('gmt_offset');
         $query_interval = $offset < 0
-            ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)'
-            : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)';
+            ? 'DATE_SUB('.$field_for_interval.', INTERVAL '.$offset * -1.' HOUR)'
+            : 'DATE_ADD('.$field_for_interval.', INTERVAL '.$offset.' HOUR)';
         return $query_interval;
     }
 
@@ -1014,16 +1013,16 @@ 
     public static function get_timezone_string_for_display()
     {
         $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', '');
-        if (! empty($pretty_timezone)) {
+        if ( ! empty($pretty_timezone)) {
             return esc_html($pretty_timezone);
         }
         $timezone_string = get_option('timezone_string');
         if ($timezone_string) {
             static $mo_loaded = false;
             // Load translations for continents and cities just like wp_timezone_choice does
-            if (! $mo_loaded) {
+            if ( ! $mo_loaded) {
                 $locale = get_locale();
-                $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo';
+                $mofile = WP_LANG_DIR.'/continents-cities-'.$locale.'.mo';
                 load_textdomain('continents-cities', $mofile);
                 $mo_loaded = true;
             }
@@ -1044,16 +1043,16 @@ 
         } else {
             $prefix = '';
         }
-        $parts = explode('.', (string)$gmt_offset);
+        $parts = explode('.', (string) $gmt_offset);
         if (count($parts) === 1) {
             $parts[1] = '00';
         } else {
             //convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25)
             //to minutes, eg 30 or 15, respectively
-            $hour_fraction = (float)('0.' . $parts[1]);
-            $parts[1]      = (string)$hour_fraction * 60;
+            $hour_fraction = (float) ('0.'.$parts[1]);
+            $parts[1]      = (string) $hour_fraction * 60;
         }
-        return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts));
+        return sprintf(__('UTC%1$s', 'event_espresso'), $prefix.implode(':', $parts));
     }
 
 
@@ -1079,7 +1078,7 @@ 
      */
     public static function first_of_month_timestamp($month = '')
     {
-        $month = (string)$month;
+        $month = (string) $month;
         $year = '';
         // check if the incoming string has a year in it or not
        if (preg_match('/\b\d{4}\b/', $month, $matches)) {
@@ -1103,7 +1102,7 @@ 
 		//before adding to the timestamp.  Why? Because we want tomorrow to be for midnight the next day in THIS timezone
 		//not an offset from midnight in UTC.  So if we're starting with UTC 00:00:00, then we want to make sure the
 		//final timestamp is equivalent to midnight in this timezone as represented in GMT.
-		return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset()*-1);
+		return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset() * -1);
 	}
 
 
@@ -1137,9 +1136,9 @@ 
         );
 
         // Load translations for continents and cities.
-        if (! $mo_loaded || $locale !== $locale_loaded) {
+        if ( ! $mo_loaded || $locale !== $locale_loaded) {
             $locale_loaded = $locale ? $locale : get_locale();
-            $mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
+            $mofile        = WP_LANG_DIR.'/continents-cities-'.$locale_loaded.'.mo';
             unload_textdomain('continents-cities');
             load_textdomain('continents-cities', $mofile);
             $mo_loaded = true;
@@ -1148,12 +1147,12 @@ 
         $zonen = array();
         foreach (timezone_identifiers_list() as $zone) {
             $zone = explode('/', $zone);
-            if (! in_array($zone[0], $continents)) {
+            if ( ! in_array($zone[0], $continents)) {
                 continue;
             }
 
             // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later
-            $exists    = array(
+            $exists = array(
                 0 => (isset($zone[0]) && $zone[0]),
                 1 => (isset($zone[1]) && $zone[1]),
                 2 => (isset($zone[2]) && $zone[2]),
@@ -1176,7 +1175,7 @@ 
         $structure = array();
 
         if (empty($selected_zone)) {
-            $structure[] = '<option selected="selected" value="">' . __('Select a city') . '</option>';
+            $structure[] = '<option selected="selected" value="">'.__('Select a city').'</option>';
         }
 
         foreach ($zonen as $key => $zone) {
@@ -1190,19 +1189,19 @@ 
                 // It's inside a continent group
 
                 // Continent optgroup
-                if (! isset($zonen[$key - 1]) || $zonen[$key - 1]['continent'] !== $zone['continent']) {
+                if ( ! isset($zonen[$key - 1]) || $zonen[$key - 1]['continent'] !== $zone['continent']) {
                     $label       = $zone['t_continent'];
-                    $structure[] = '<optgroup label="' . esc_attr($label) . '">';
+                    $structure[] = '<optgroup label="'.esc_attr($label).'">';
                 }
 
                 // Add the city to the value
                 $value[] = $zone['city'];
 
                 $display = $zone['t_city'];
-                if (! empty($zone['subcity'])) {
+                if ( ! empty($zone['subcity'])) {
                     // Add the subcity to the value
                     $value[] = $zone['subcity'];
-                    $display .= ' - ' . $zone['t_subcity'];
+                    $display .= ' - '.$zone['t_subcity'];
                 }
             }
 
@@ -1212,10 +1211,10 @@ 
             if ($value === $selected_zone) {
                 $selected = 'selected="selected" ';
             }
-            $structure[] = '<option ' . $selected . 'value="' . esc_attr($value) . '">' . esc_html($display) . "</option>";
+            $structure[] = '<option '.$selected.'value="'.esc_attr($value).'">'.esc_html($display)."</option>";
 
             // Close continent optgroup
-            if (! empty($zone['city']) && (! isset($zonen[$key + 1]) || (isset($zonen[$key + 1]) && $zonen[$key + 1]['continent'] !== $zone['continent']))) {
+            if ( ! empty($zone['city']) && ( ! isset($zonen[$key + 1]) || (isset($zonen[$key + 1]) && $zonen[$key + 1]['continent'] !== $zone['continent']))) {
                 $structure[] = '</optgroup>';
             }
         }

core/libraries/messages/data_class/EE_Messages_Gateways_incoming_data.class.php

Indentation +6 added lines, -6 removed lines

@@ -135,11 +135,11 @@ 
 
 
 
-    /**
-     * _setup_data
-     *
-     * @throws EE_Error
-     */
+	/**
+	 * _setup_data
+	 *
+	 * @throws EE_Error
+	 */
 	protected function _setup_data() {
 
 		$this->reg_info = array();
@@ -157,7 +157,7 @@ 
 		$this->ip_address = isset( $session_data['ip_address'] ) ? $session_data['ip_address'] : '';
 		$this->user_agent = isset( $session_data['user_agent'] ) ? $session_data['user_agent'] : '';
 		$this->init_access = $this->last_access = '';
-        //get all non-trashed registrations
+		//get all non-trashed registrations
 		$this->reg_objs = $this->txn->registrations(array(array('REG_deleted' => false)));
 		$this->_assemble_data();
 

Spacing +22 added lines, -22 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -44,25 +44,25 @@ 
 	 * @param array $data
 	 * @throws EE_Error
 	 */
-	public function __construct( $data ) {
+	public function __construct($data) {
 
 		//test for valid params
-		if ( ! ( $data[0] instanceof EE_Transaction ))
-			throw new EE_Error( __('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso') );
+		if ( ! ($data[0] instanceof EE_Transaction))
+			throw new EE_Error(__('Incoming data for the Gateways data handler must have an EE_Transaction object as the value for the first array index.', 'event_espresso'));
 
-		if ( empty( $data[1] ) || ! $data[1] instanceof  EE_Payment  )
-			$pmt_obj = $this->_get_empty_payment_obj( $data[0] );
+		if (empty($data[1]) || ! $data[1] instanceof  EE_Payment)
+			$pmt_obj = $this->_get_empty_payment_obj($data[0]);
 
-		if ( ! empty( $data[2] ) ) {
+		if ( ! empty($data[2])) {
 			$filtered_reg_status = $data[2];
 		}
 
 		$data = array(
 			'txn_obj' => $data[0],
 			'pmt_obj' => isset($pmt_obj) ? $pmt_obj : $data[1],
-			'filtered_reg_status' => isset( $filtered_reg_status ) ? $filtered_reg_status : null
+			'filtered_reg_status' => isset($filtered_reg_status) ? $filtered_reg_status : null
 			);
-		parent::__construct( $data );
+		parent::__construct($data);
 	}
 
 
@@ -76,18 +76,18 @@ 
 	 *
 	 * @return array   The prepped data for db
 	 */
-	static public function convert_data_for_persistent_storage( $data ) {
+	static public function convert_data_for_persistent_storage($data) {
 		$prepped_data = array();
 
-		if ( $data[0] instanceof EE_Transaction ) {
+		if ($data[0] instanceof EE_Transaction) {
 			$prepped_data['Transaction'] = $data[0]->ID();
 		}
 
-		if ( isset( $data[1] ) && $data[1] instanceof EE_Payment ) {
+		if (isset($data[1]) && $data[1] instanceof EE_Payment) {
 			$prepped_data['Payment'] = $data[1]->ID();
 		}
 
-		if ( ! empty( $data[2] ) ) {
+		if ( ! empty($data[2])) {
 			$prepped_data['filter'] = $data[2];
 		}
 
@@ -107,11 +107,11 @@ 
 	 *
 	 * @return array
 	 */
-	static public function convert_data_from_persistent_storage( $data ) {
+	static public function convert_data_from_persistent_storage($data) {
 		$prepped_data = array(
-			0 => isset( $data['Transaction'] ) ? EEM_Transaction::instance()->get_one_by_ID( $data['Transaction'] ) : null,
-			1 => isset( $data['Payment'] ) ? EEM_Payment::instance()->get_one_by_ID( $data['Payment'] ) : null,
-			2 => isset( $data['filter'] ) ? $data['filter'] : null
+			0 => isset($data['Transaction']) ? EEM_Transaction::instance()->get_one_by_ID($data['Transaction']) : null,
+			1 => isset($data['Payment']) ? EEM_Payment::instance()->get_one_by_ID($data['Payment']) : null,
+			2 => isset($data['filter']) ? $data['filter'] : null
 		);
 		return $prepped_data;
 	}
@@ -122,8 +122,8 @@ 
 	 * @param \EE_Transaction $txn
 	 * @return \EE_Payment
 	 */
-	private function _get_empty_payment_obj( EE_Transaction $txn ) {
-		$PMT = EE_Payment::new_instance( array(
+	private function _get_empty_payment_obj(EE_Transaction $txn) {
+		$PMT = EE_Payment::new_instance(array(
 			'STS_ID' => EEM_Payment::status_id_pending,
 			'PAY_timestamp' => time(),
 			'PMD_ID' => $txn->payment_method_ID(),
@@ -153,9 +153,9 @@ 
 
 
 		//other data from the session (if possible)
-		$this->user_id = isset( $session_data['user_id'] ) ? $session_data['user_id'] : '';
-		$this->ip_address = isset( $session_data['ip_address'] ) ? $session_data['ip_address'] : '';
-		$this->user_agent = isset( $session_data['user_agent'] ) ? $session_data['user_agent'] : '';
+		$this->user_id = isset($session_data['user_id']) ? $session_data['user_id'] : '';
+		$this->ip_address = isset($session_data['ip_address']) ? $session_data['ip_address'] : '';
+		$this->user_agent = isset($session_data['user_agent']) ? $session_data['user_agent'] : '';
 		$this->init_access = $this->last_access = '';
         //get all non-trashed registrations
 		$this->reg_objs = $this->txn->registrations(array(array('REG_deleted' => false)));

core/db_models/fields/EE_Datetime_Field.php

Indentation +748 added lines, -748 removed lines

@@ -15,753 +15,753 @@
 class EE_Datetime_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * The pattern we're looking for is if only the characters 0-9 are found and there are only
-     * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
-     *
-     * @type string unix_timestamp_regex
-     */
-    const unix_timestamp_regex = '/[0-9]{10,}/';
-
-    /**
-     * @type string mysql_timestamp_format
-     */
-    const mysql_timestamp_format = 'Y-m-d H:i:s';
-
-    /**
-     * @type string mysql_date_format
-     */
-    const mysql_date_format = 'Y-m-d';
-
-    /**
-     * @type string mysql_time_format
-     */
-    const mysql_time_format = 'H:i:s';
-
-    /**
-     * Const for using in the default value. If the field's default is set to this,
-     * then we will return the time of calling `get_default_value()`, not
-     * just the current time at construction
-     */
-    const now = 'now';
-
-    /**
-     * The following properties hold the default formats for date and time.
-     * Defaults are set via the constructor and can be overridden on class instantiation.
-     * However they can also be overridden later by the set_format() method
-     * (and corresponding set_date_format, set_time_format methods);
-     */
-    /**
-     * @type string $_date_format
-     */
-    protected $_date_format = '';
-
-    /**
-     * @type string $_time_format
-     */
-    protected $_time_format = '';
-
-    /**
-     * @type string $_pretty_date_format
-     */
-    protected $_pretty_date_format = '';
-
-    /**
-     * @type string $_pretty_time_format
-     */
-    protected $_pretty_time_format = '';
-
-    /**
-     * @type DateTimeZone $_DateTimeZone
-     */
-    protected $_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_UTC_DateTimeZone
-     */
-    protected $_UTC_DateTimeZone;
-
-    /**
-     * @type DateTimeZone $_blog_DateTimeZone
-     */
-    protected $_blog_DateTimeZone;
-
-
-    /**
-     * This property holds how we want the output returned when getting a datetime string.  It is set for the
-     * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
-     * and time returned via getters.
-     *
-     * @var mixed (null|string)
-     */
-    protected $_date_time_output;
-
-
-    /**
-     * timezone string
-     * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
-     * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
-     * coming out of the object to be in.  Default timezone is the current WP timezone option setting
-     *
-     * @var string
-     */
-    protected $_timezone_string;
-
-
-    /**
-     * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
-     * offsets for comparison purposes).
-     *
-     * @var int
-     */
-    protected $_blog_offset;
-
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @param string $timezone_string
-     * @param string $date_format
-     * @param string $time_format
-     * @param string $pretty_date_format
-     * @param string $pretty_time_format
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        $timezone_string = '',
-        $date_format = '',
-        $time_format = '',
-        $pretty_date_format = '',
-        $pretty_time_format = ''
-    ) {
-
-        $this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
-        $this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
-        $this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
-        $this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
-
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->set_timezone($timezone_string);
-        $this->setSchemaFormat('date-time');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws \EE_Error
-     */
-    public function get_UTC_DateTimeZone()
-    {
-        return $this->_UTC_DateTimeZone instanceof DateTimeZone
-            ? $this->_UTC_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('UTC');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws \EE_Error
-     */
-    public function get_blog_DateTimeZone()
-    {
-        return $this->_blog_DateTimeZone instanceof DateTimeZone
-            ? $this->_blog_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('');
-    }
-
-
-    /**
-     * this prepares any incoming date data and make sure its converted to a utc unix timestamp
-     *
-     * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
-     *                                                              timestamp
-     * @return DateTime
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->_get_date_object($value_inputted_for_field_on_model_object);
-    }
-
-
-    /**
-     * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
-     * getters need to know whether we're just returning the date or the time or both.  By default we return both.
-     *
-     * @param bool $pretty If we're returning the pretty formats or standard format string.
-     * @return string    The final assembled format string.
-     */
-    protected function _get_date_time_output($pretty = false)
-    {
-
-        switch ($this->_date_time_output) {
-            case 'time' :
-                return $pretty ? $this->_pretty_time_format : $this->_time_format;
-                break;
-
-            case 'date' :
-                return $pretty ? $this->_pretty_date_format : $this->_date_format;
-                break;
-
-            default :
-                return $pretty
-                    ? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
-                    : $this->_date_format . ' ' . $this->_time_format;
-        }
-    }
-
-
-    /**
-     * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
-     * returned (using the format properties)
-     *
-     * @param string $what acceptable values are 'time' or 'date'.
-     *                     Any other value will be set but will always result
-     *                     in both 'date' and 'time' being returned.
-     * @return void
-     */
-    public function set_date_time_output($what = null)
-    {
-        $this->_date_time_output = $what;
-    }
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
-     * We also set some other properties in this method.
-     *
-     * @param string $timezone_string A valid timezone string as described by @link
-     *                                http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_timezone($timezone_string)
-    {
-        if (empty($timezone_string) && $this->_timezone_string !== null) {
-            // leave the timezone AS-IS if we already have one and
-            // the function arg didn't provide one
-            return;
-        }
-        $timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
-        $this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @access protected
-     * @param string $timezone_string
-     * @return \DateTimeZone
-     * @throws \EE_Error
-     */
-    protected function _create_timezone_object_from_timezone_string($timezone_string = '')
-    {
-        return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone_string;
-    }
-
-
-    /**
-     * set the $_date_format property
-     *
-     * @access public
-     * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_date_format($format, $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_date_format = $format;
-        } else {
-            $this->_date_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_date_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_date_format($pretty = false)
-    {
-        return $pretty ? $this->_pretty_date_format : $this->_date_format;
-    }
-
-
-    /**
-     * set the $_time_format property
-     *
-     * @access public
-     * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_time_format($format, $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_time_format = $format;
-        } else {
-            $this->_time_format = $format;
-        }
-    }
-
-
-    /**
-     * return the $_time_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_time_format($pretty = false)
-    {
-        return $pretty ? $this->_pretty_time_format : $this->_time_format;
-    }
-
-
-    /**
-     * set the $_pretty_date_format property
-     *
-     * @access public
-     * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_date_format($format)
-    {
-        $this->_pretty_date_format = $format;
-    }
-
-
-    /**
-     * set the $_pretty_time_format property
-     *
-     * @access public
-     * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_time_format($format)
-    {
-        $this->_pretty_time_format = $format;
-    }
-
-
-    /**
-     * Only sets the time portion of the datetime.
-     *
-     * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($time_to_set_string instanceof DateTime) {
-            $parsed = array(
-                'hour'   => $time_to_set_string->format('H'),
-                'minute' => $time_to_set_string->format('i'),
-                'second' => $time_to_set_string->format('s'),
-            );
-        } else {
-            //parse incoming string
-            $parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
-        }
-
-        //make sure $current is in the correct timezone.
-        $current->setTimezone($this->_DateTimeZone);
-
-        return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
-    }
-
-
-    /**
-     * Only sets the date portion of the datetime.
-     *
-     * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($date_to_set_string instanceof DateTime) {
-            $parsed = array(
-                'year'  => $date_to_set_string->format('Y'),
-                'month' => $date_to_set_string->format('m'),
-                'day'   => $date_to_set_string->format('d'),
-            );
-        } else {
-            //parse incoming string
-            $parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
-        }
-
-        //make sure $current is in the correct timezone
-        $current->setTimezone($this->_DateTimeZone);
-
-        return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
-     * datetime gets to this stage it should ALREADY be in UTC time
-     *
-     * @param  DateTime $DateTime
-     * @return string formatted date time for given timezone
-     * @throws \EE_Error
-     */
-    public function prepare_for_get($DateTime)
-    {
-        return $this->_prepare_for_display($DateTime);
-    }
-
-
-    /**
-     * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
-     * from the set wp timezone.  If so, then it returns the datetime string formatted via
-     * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
-     * abbreviation to the date_string.
-     *
-     * @param mixed $DateTime
-     * @param null  $schema
-     * @return string
-     * @throws \EE_Error
-     */
-    public function prepare_for_pretty_echoing($DateTime, $schema = null)
-    {
-        return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param DateTime    $DateTime
-     * @param bool|string $schema
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _prepare_for_display($DateTime, $schema = false)
-    {
-        if (! $DateTime instanceof DateTime) {
-            if ($this->_nullable) {
-                return '';
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                } else {
-                    $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
-                                'event_espresso'
-                            ),
-                            $this->_nicename
-                        )
-                    );
-                }
-            }
-        }
-        $format_string = $this->_get_date_time_output($schema);
-        //make sure datetime_value is in the correct timezone (in case that's been updated).
-        $DateTime->setTimezone($this->_DateTimeZone);
-        if ($schema) {
-            if ($this->_display_timezone()) {
-                //must be explicit because schema could equal true.
-                if ($schema === 'no_html') {
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
-                } else {
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
-                }
-            } else {
-                $timezone_string = '';
-            }
-
-            return $DateTime->format($format_string) . $timezone_string;
-        } else {
-            return $DateTime->format($format_string);
-        }
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param  mixed $datetime_value u
-     * @return string mysql timestamp in UTC
-     * @throws \EE_Error
-     */
-    public function prepare_for_use_in_db($datetime_value)
-    {
-        //we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
-            throw new EE_Error(
-            	sprintf(
-            	    __(
-            		    'The incoming value being prepared for setting in the database must either be empty or a php 
+	/**
+	 * The pattern we're looking for is if only the characters 0-9 are found and there are only
+	 * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
+	 *
+	 * @type string unix_timestamp_regex
+	 */
+	const unix_timestamp_regex = '/[0-9]{10,}/';
+
+	/**
+	 * @type string mysql_timestamp_format
+	 */
+	const mysql_timestamp_format = 'Y-m-d H:i:s';
+
+	/**
+	 * @type string mysql_date_format
+	 */
+	const mysql_date_format = 'Y-m-d';
+
+	/**
+	 * @type string mysql_time_format
+	 */
+	const mysql_time_format = 'H:i:s';
+
+	/**
+	 * Const for using in the default value. If the field's default is set to this,
+	 * then we will return the time of calling `get_default_value()`, not
+	 * just the current time at construction
+	 */
+	const now = 'now';
+
+	/**
+	 * The following properties hold the default formats for date and time.
+	 * Defaults are set via the constructor and can be overridden on class instantiation.
+	 * However they can also be overridden later by the set_format() method
+	 * (and corresponding set_date_format, set_time_format methods);
+	 */
+	/**
+	 * @type string $_date_format
+	 */
+	protected $_date_format = '';
+
+	/**
+	 * @type string $_time_format
+	 */
+	protected $_time_format = '';
+
+	/**
+	 * @type string $_pretty_date_format
+	 */
+	protected $_pretty_date_format = '';
+
+	/**
+	 * @type string $_pretty_time_format
+	 */
+	protected $_pretty_time_format = '';
+
+	/**
+	 * @type DateTimeZone $_DateTimeZone
+	 */
+	protected $_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_UTC_DateTimeZone
+	 */
+	protected $_UTC_DateTimeZone;
+
+	/**
+	 * @type DateTimeZone $_blog_DateTimeZone
+	 */
+	protected $_blog_DateTimeZone;
+
+
+	/**
+	 * This property holds how we want the output returned when getting a datetime string.  It is set for the
+	 * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
+	 * and time returned via getters.
+	 *
+	 * @var mixed (null|string)
+	 */
+	protected $_date_time_output;
+
+
+	/**
+	 * timezone string
+	 * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
+	 * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
+	 * coming out of the object to be in.  Default timezone is the current WP timezone option setting
+	 *
+	 * @var string
+	 */
+	protected $_timezone_string;
+
+
+	/**
+	 * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
+	 * offsets for comparison purposes).
+	 *
+	 * @var int
+	 */
+	protected $_blog_offset;
+
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @param string $timezone_string
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param string $pretty_date_format
+	 * @param string $pretty_time_format
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		$timezone_string = '',
+		$date_format = '',
+		$time_format = '',
+		$pretty_date_format = '',
+		$pretty_time_format = ''
+	) {
+
+		$this->_date_format        = ! empty($date_format) ? $date_format : get_option('date_format');
+		$this->_time_format        = ! empty($time_format) ? $time_format : get_option('time_format');
+		$this->_pretty_date_format = ! empty($pretty_date_format) ? $pretty_date_format : get_option('date_format');
+		$this->_pretty_time_format = ! empty($pretty_time_format) ? $pretty_time_format : get_option('time_format');
+
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->set_timezone($timezone_string);
+		$this->setSchemaFormat('date-time');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws \EE_Error
+	 */
+	public function get_UTC_DateTimeZone()
+	{
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone
+			? $this->_UTC_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('UTC');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws \EE_Error
+	 */
+	public function get_blog_DateTimeZone()
+	{
+		return $this->_blog_DateTimeZone instanceof DateTimeZone
+			? $this->_blog_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('');
+	}
+
+
+	/**
+	 * this prepares any incoming date data and make sure its converted to a utc unix timestamp
+	 *
+	 * @param  string|int $value_inputted_for_field_on_model_object could be a string formatted date time or int unix
+	 *                                                              timestamp
+	 * @return DateTime
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->_get_date_object($value_inputted_for_field_on_model_object);
+	}
+
+
+	/**
+	 * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
+	 * getters need to know whether we're just returning the date or the time or both.  By default we return both.
+	 *
+	 * @param bool $pretty If we're returning the pretty formats or standard format string.
+	 * @return string    The final assembled format string.
+	 */
+	protected function _get_date_time_output($pretty = false)
+	{
+
+		switch ($this->_date_time_output) {
+			case 'time' :
+				return $pretty ? $this->_pretty_time_format : $this->_time_format;
+				break;
+
+			case 'date' :
+				return $pretty ? $this->_pretty_date_format : $this->_date_format;
+				break;
+
+			default :
+				return $pretty
+					? $this->_pretty_date_format . ' ' . $this->_pretty_time_format
+					: $this->_date_format . ' ' . $this->_time_format;
+		}
+	}
+
+
+	/**
+	 * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
+	 * returned (using the format properties)
+	 *
+	 * @param string $what acceptable values are 'time' or 'date'.
+	 *                     Any other value will be set but will always result
+	 *                     in both 'date' and 'time' being returned.
+	 * @return void
+	 */
+	public function set_date_time_output($what = null)
+	{
+		$this->_date_time_output = $what;
+	}
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
+	 * We also set some other properties in this method.
+	 *
+	 * @param string $timezone_string A valid timezone string as described by @link
+	 *                                http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_timezone($timezone_string)
+	{
+		if (empty($timezone_string) && $this->_timezone_string !== null) {
+			// leave the timezone AS-IS if we already have one and
+			// the function arg didn't provide one
+			return;
+		}
+		$timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$this->_timezone_string = ! empty($timezone_string) ? $timezone_string : 'UTC';
+		$this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @access protected
+	 * @param string $timezone_string
+	 * @return \DateTimeZone
+	 * @throws \EE_Error
+	 */
+	protected function _create_timezone_object_from_timezone_string($timezone_string = '')
+	{
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone_string;
+	}
+
+
+	/**
+	 * set the $_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_date_format($format, $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_date_format = $format;
+		} else {
+			$this->_date_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_date_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_date_format($pretty = false)
+	{
+		return $pretty ? $this->_pretty_date_format : $this->_date_format;
+	}
+
+
+	/**
+	 * set the $_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_time_format($format, $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_time_format = $format;
+		} else {
+			$this->_time_format = $format;
+		}
+	}
+
+
+	/**
+	 * return the $_time_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_time_format($pretty = false)
+	{
+		return $pretty ? $this->_pretty_time_format : $this->_time_format;
+	}
+
+
+	/**
+	 * set the $_pretty_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new pretty date format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_date_format($format)
+	{
+		$this->_pretty_date_format = $format;
+	}
+
+
+	/**
+	 * set the $_pretty_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new pretty time format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_time_format($format)
+	{
+		$this->_pretty_time_format = $format;
+	}
+
+
+	/**
+	 * Only sets the time portion of the datetime.
+	 *
+	 * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current)
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($time_to_set_string instanceof DateTime) {
+			$parsed = array(
+				'hour'   => $time_to_set_string->format('H'),
+				'minute' => $time_to_set_string->format('i'),
+				'second' => $time_to_set_string->format('s'),
+			);
+		} else {
+			//parse incoming string
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
+		}
+
+		//make sure $current is in the correct timezone.
+		$current->setTimezone($this->_DateTimeZone);
+
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
+	}
+
+
+	/**
+	 * Only sets the date portion of the datetime.
+	 *
+	 * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current)
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($date_to_set_string instanceof DateTime) {
+			$parsed = array(
+				'year'  => $date_to_set_string->format('Y'),
+				'month' => $date_to_set_string->format('m'),
+				'day'   => $date_to_set_string->format('d'),
+			);
+		} else {
+			//parse incoming string
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
+		}
+
+		//make sure $current is in the correct timezone
+		$current->setTimezone($this->_DateTimeZone);
+
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
+	 * datetime gets to this stage it should ALREADY be in UTC time
+	 *
+	 * @param  DateTime $DateTime
+	 * @return string formatted date time for given timezone
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_get($DateTime)
+	{
+		return $this->_prepare_for_display($DateTime);
+	}
+
+
+	/**
+	 * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
+	 * from the set wp timezone.  If so, then it returns the datetime string formatted via
+	 * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
+	 * abbreviation to the date_string.
+	 *
+	 * @param mixed $DateTime
+	 * @param null  $schema
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_pretty_echoing($DateTime, $schema = null)
+	{
+		return $this->_prepare_for_display($DateTime, $schema ? $schema : true);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param DateTime    $DateTime
+	 * @param bool|string $schema
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _prepare_for_display($DateTime, $schema = false)
+	{
+		if (! $DateTime instanceof DateTime) {
+			if ($this->_nullable) {
+				return '';
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				} else {
+					$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now);
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
+								'event_espresso'
+							),
+							$this->_nicename
+						)
+					);
+				}
+			}
+		}
+		$format_string = $this->_get_date_time_output($schema);
+		//make sure datetime_value is in the correct timezone (in case that's been updated).
+		$DateTime->setTimezone($this->_DateTimeZone);
+		if ($schema) {
+			if ($this->_display_timezone()) {
+				//must be explicit because schema could equal true.
+				if ($schema === 'no_html') {
+					$timezone_string = ' (' . $DateTime->format('T') . ')';
+				} else {
+					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+				}
+			} else {
+				$timezone_string = '';
+			}
+
+			return $DateTime->format($format_string) . $timezone_string;
+		} else {
+			return $DateTime->format($format_string);
+		}
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param  mixed $datetime_value u
+	 * @return string mysql timestamp in UTC
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_use_in_db($datetime_value)
+	{
+		//we allow an empty value or DateTime object, but nothing else.
+		if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The incoming value being prepared for setting in the database must either be empty or a php 
             		    DateTime object, instead of: %1$s %2$s',
-                        'event_espresso'
-	                ),
-                    '<br />',
-                    print_r($datetime_value, true)
-                )
-            );
-        }
-
-        if ($datetime_value instanceof DateTime) {
-            if ( ! $datetime_value instanceof DbSafeDateTime) {
-                $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
-            }
-
-            return $datetime_value->setTimezone($this->get_UTC_DateTimeZone())->format(
-                EE_Datetime_Field::mysql_timestamp_format
-            );
-        }
-
-        // if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
-        return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
-    }
-
-
-    /**
-     * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
-     * allowed)
-     *
-     * @param string $datetime_string mysql timestamp in UTC
-     * @return  mixed null | DateTime
-     * @throws \EE_Error
-     */
-    public function prepare_for_set_from_db($datetime_string)
-    {
-        //if $datetime_value is empty, and ! $this->_nullable, just use time()
-        if (empty($datetime_string) && $this->_nullable) {
-            return null;
-        }
-        // datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
-        if (empty($datetime_string)) {
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        } else {
-            $DateTime = DateTime::createFromFormat(
-                EE_Datetime_Field::mysql_timestamp_format,
-                $datetime_string,
-                $this->get_UTC_DateTimeZone()
-            );
-            if ($DateTime instanceof \DateTime) {
-                $DateTime = new DbSafeDateTime(
-                    $DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
-                    $this->get_UTC_DateTimeZone()
-                );
-            }
-        }
-
-        if (! $DateTime instanceof DbSafeDateTime) {
-            // if still no datetime object, then let's just use now
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        }
-        // THEN apply the field's set DateTimeZone
-        $DateTime->setTimezone($this->_DateTimeZone);
-
-        return $DateTime;
-    }
-
-
-    /**
-     * All this method does is determine if we're going to display the timezone string or not on any output.
-     * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
-     * If so, then true.
-     *
-     * @return bool true for yes false for no
-     * @throws \EE_Error
-     */
-    protected function _display_timezone()
-    {
-
-        // first let's do a comparison of timezone strings.
-        // If they match then we can get out without any further calculations
-        $blog_string = get_option('timezone_string');
-        if ($blog_string === $this->_timezone_string) {
-            return false;
-        }
-        // now we need to calc the offset for the timezone string so we can compare with the blog offset.
-        $this_offset = $this->get_timezone_offset($this->_DateTimeZone);
-        $blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
-        // now compare
-        return $blog_offset !== $this_offset;
-    }
-
-
-    /**
-     * This method returns a php DateTime object for setting on the EE_Base_Class model.
-     * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
-     * with.
-     *
-     * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
-     *                                                    in the format that is set on the date_field (or DateTime
-     *                                                    object)!
-     * @return DateTime
-     */
-    protected function _get_date_object($date_string)
-    {
-        //first if this is an empty date_string and nullable is allowed, just return null.
-        if ($this->_nullable && empty($date_string)) {
-            return null;
-        }
-
-        // if incoming date
-        if ($date_string instanceof DateTime) {
-            $date_string->setTimezone($this->_DateTimeZone);
-
-            return $date_string;
-        }
-        // if empty date_string and made it here.
-        // Return a datetime object for now in the given timezone.
-        if (empty($date_string)) {
-            return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-        // if $date_string is matches something that looks like a Unix timestamp let's just use it.
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
-            try {
-                // This is operating under the assumption that the incoming Unix timestamp
-                // is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
-                $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-                $DateTime->setTimestamp($date_string);
-
-                return $DateTime;
-            } catch (Exception $e) {
-                // should be rare, but if things got fooled then let's just continue
-            }
-        }
-        //not a unix timestamp.  So we will use the set format on this object and set timezone to
-        //create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
-        try {
-            $DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if ($DateTime instanceof DateTime) {
-                $DateTime = new DbSafeDateTime(
-                    $DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
-                    $this->_DateTimeZone
-                );
-            }
-            if (! $DateTime instanceof DbSafeDateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        __('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
-                        $date_string,
-                        $format
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            // if we made it here then likely then something went really wrong.
-            // Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
-            $DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-
-        return $DateTime;
-    }
-
-
-
-    /**
-     * get_timezone_transitions
-     *
-     * @param \DateTimeZone $DateTimeZone
-     * @param int           $time
-     * @param bool          $first_only
-     * @return mixed
-     */
-    public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
-    {
-        return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
-    }
-
-
-
-    /**
-     * get_timezone_offset
-     *
-     * @param \DateTimeZone $DateTimeZone
-     * @param int           $time
-     * @return mixed
-     * @throws \DomainException
-     */
-    public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
-    {
-        return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
-    }
-
-
-    /**
-     * This will take an incoming timezone string and return the abbreviation for that timezone
-     *
-     * @param  string $timezone_string
-     * @return string           abbreviation
-     * @throws \EE_Error
-     */
-    public function get_timezone_abbrev($timezone_string)
-    {
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
-
-        return $dateTime->format('T');
-    }
-
-    /**
-     * Overrides the parent to allow for having a dynamic "now" value
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if ($this->_default_value === EE_Datetime_Field::now) {
-            return time();
-        } else {
-            return parent::get_default_value();
-        }
-    }
-
-
-    public function getSchemaDescription()
-    {
-        return sprintf(
-            esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
-            $this->get_nicename()
-        );
-    }
+						'event_espresso'
+					),
+					'<br />',
+					print_r($datetime_value, true)
+				)
+			);
+		}
+
+		if ($datetime_value instanceof DateTime) {
+			if ( ! $datetime_value instanceof DbSafeDateTime) {
+				$datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
+			}
+
+			return $datetime_value->setTimezone($this->get_UTC_DateTimeZone())->format(
+				EE_Datetime_Field::mysql_timestamp_format
+			);
+		}
+
+		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
+		return ! $this->_nullable && empty($datetime_value) ? current_time('mysql', true) : null;
+	}
+
+
+	/**
+	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
+	 * allowed)
+	 *
+	 * @param string $datetime_string mysql timestamp in UTC
+	 * @return  mixed null | DateTime
+	 * @throws \EE_Error
+	 */
+	public function prepare_for_set_from_db($datetime_string)
+	{
+		//if $datetime_value is empty, and ! $this->_nullable, just use time()
+		if (empty($datetime_string) && $this->_nullable) {
+			return null;
+		}
+		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
+		if (empty($datetime_string)) {
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		} else {
+			$DateTime = DateTime::createFromFormat(
+				EE_Datetime_Field::mysql_timestamp_format,
+				$datetime_string,
+				$this->get_UTC_DateTimeZone()
+			);
+			if ($DateTime instanceof \DateTime) {
+				$DateTime = new DbSafeDateTime(
+					$DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
+					$this->get_UTC_DateTimeZone()
+				);
+			}
+		}
+
+		if (! $DateTime instanceof DbSafeDateTime) {
+			// if still no datetime object, then let's just use now
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		}
+		// THEN apply the field's set DateTimeZone
+		$DateTime->setTimezone($this->_DateTimeZone);
+
+		return $DateTime;
+	}
+
+
+	/**
+	 * All this method does is determine if we're going to display the timezone string or not on any output.
+	 * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
+	 * If so, then true.
+	 *
+	 * @return bool true for yes false for no
+	 * @throws \EE_Error
+	 */
+	protected function _display_timezone()
+	{
+
+		// first let's do a comparison of timezone strings.
+		// If they match then we can get out without any further calculations
+		$blog_string = get_option('timezone_string');
+		if ($blog_string === $this->_timezone_string) {
+			return false;
+		}
+		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
+		// now compare
+		return $blog_offset !== $this_offset;
+	}
+
+
+	/**
+	 * This method returns a php DateTime object for setting on the EE_Base_Class model.
+	 * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
+	 * with.
+	 *
+	 * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
+	 *                                                    in the format that is set on the date_field (or DateTime
+	 *                                                    object)!
+	 * @return DateTime
+	 */
+	protected function _get_date_object($date_string)
+	{
+		//first if this is an empty date_string and nullable is allowed, just return null.
+		if ($this->_nullable && empty($date_string)) {
+			return null;
+		}
+
+		// if incoming date
+		if ($date_string instanceof DateTime) {
+			$date_string->setTimezone($this->_DateTimeZone);
+
+			return $date_string;
+		}
+		// if empty date_string and made it here.
+		// Return a datetime object for now in the given timezone.
+		if (empty($date_string)) {
+			return new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
+			try {
+				// This is operating under the assumption that the incoming Unix timestamp
+				// is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
+				$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+				$DateTime->setTimestamp($date_string);
+
+				return $DateTime;
+			} catch (Exception $e) {
+				// should be rare, but if things got fooled then let's just continue
+			}
+		}
+		//not a unix timestamp.  So we will use the set format on this object and set timezone to
+		//create the DateTime object.
+		$format = $this->_date_format . ' ' . $this->_time_format;
+		try {
+			$DateTime = DateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
+			if ($DateTime instanceof DateTime) {
+				$DateTime = new DbSafeDateTime(
+					$DateTime->format(\EE_Datetime_Field::mysql_timestamp_format),
+					$this->_DateTimeZone
+				);
+			}
+			if (! $DateTime instanceof DbSafeDateTime) {
+				throw new EE_Error(
+					sprintf(
+						__('"%1$s" does not represent a valid Date Time in the format "%2$s".', 'event_espresso'),
+						$date_string,
+						$format
+					)
+				);
+			}
+		} catch (Exception $e) {
+			// if we made it here then likely then something went really wrong.
+			// Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
+			$DateTime = new DbSafeDateTime(\EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+
+		return $DateTime;
+	}
+
+
+
+	/**
+	 * get_timezone_transitions
+	 *
+	 * @param \DateTimeZone $DateTimeZone
+	 * @param int           $time
+	 * @param bool          $first_only
+	 * @return mixed
+	 */
+	public function get_timezone_transitions(DateTimeZone $DateTimeZone, $time = null, $first_only = true)
+	{
+		return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
+	}
+
+
+
+	/**
+	 * get_timezone_offset
+	 *
+	 * @param \DateTimeZone $DateTimeZone
+	 * @param int           $time
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
+	{
+		return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
+	}
+
+
+	/**
+	 * This will take an incoming timezone string and return the abbreviation for that timezone
+	 *
+	 * @param  string $timezone_string
+	 * @return string           abbreviation
+	 * @throws \EE_Error
+	 */
+	public function get_timezone_abbrev($timezone_string)
+	{
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$dateTime        = new DateTime(\EE_Datetime_Field::now, new DateTimeZone($timezone_string));
+
+		return $dateTime->format('T');
+	}
+
+	/**
+	 * Overrides the parent to allow for having a dynamic "now" value
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if ($this->_default_value === EE_Datetime_Field::now) {
+			return time();
+		} else {
+			return parent::get_default_value();
+		}
+	}
+
+
+	public function getSchemaDescription()
+	{
+		return sprintf(
+			esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
+			$this->get_nicename()
+		);
+	}
 }

core/db_classes/EE_Registration.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -1164,7 +1164,7 @@ 
      * Sets deleted
      *
      * @param boolean $deleted
-     * @return bool
+     * @return boolean|null
      * @throws EE_Error
      * @throws RuntimeException
      */
@@ -1222,6 +1222,7 @@ 
      * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
      * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
      *                                          consider registration status as well as datetime access.
+     * @param integer $DTT_OR_ID
      * @return bool
      * @throws EE_Error
      */
@@ -1392,7 +1393,7 @@ 
      * Returns the latest datetime related to this registration (via the ticket attached to the registration).
      * "Latest" is defined by the `DTT_EVT_start` column.
      *
-     * @return EE_Datetime|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      */
     public function get_latest_related_datetime()
@@ -1688,7 +1689,7 @@ 
      * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
      * Note: if there are no payments on the registration there will be no payment method returned.
      *
-     * @return EE_Payment_Method|null
+     * @return null|EE_Base_Class
      */
     public function payment_method()
     {

Indentation +1979 added lines, -1979 removed lines

@@ -18,1985 +18,1985 @@
 {
 
 
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_never instead
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_in instead
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @deprecated use \EE_Checkin::status_checked_out instead
-     * @type int
-     */
-    const checkin_status_out = 0;
-
-
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Registration
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Event ID
-     *
-     * @param        int $EVT_ID Event ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_event($EVT_ID = 0)
-    {
-        $this->set('EVT_ID', $EVT_ID);
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
-     * be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'REG_code':
-                if (! empty($field_value) && $this->reg_code() === null) {
-                    $this->set_reg_code($field_value, $use_default);
-                }
-                break;
-            case 'STS_ID':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string       $new_STS_ID
-     * @param boolean      $use_default
-     * @param Context|null $context
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function set_status($new_STS_ID = null, $use_default = false, Context $context = null)
-    {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        // if status has changed
-        if ($old_STS_ID !== $new_STS_ID // and that status has actually changed
-            && ! empty($old_STS_ID) // and that old status is actually set
-            && ! empty($new_STS_ID) // as well as the new status
-            && $this->ID() // ensure registration is in the db
-        ) {
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->_reserve_registration_space();
-                do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
-                // OR FROM  approved
-            } elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
-                // release a space by decrementing ticket and datetime sold values
-                $this->_release_registration_space();
-                do_action(
-                    'AHEE__EE_Registration__set_status__from_approved',
-                    $this,
-                    $old_STS_ID,
-                    $new_STS_ID,
-                    $context
-                );
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, $context);
-            if($this->statusChangeUpdatesTransaction($context)) {
-                $this->updateTransactionAfterStatusChange();
-            }
-            do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
-            return true;
-        }
-        //even though the old value matches the new value, it's still good to
-        //allow the parent set method to have a say
-        parent::set('STS_ID', $new_STS_ID, $use_default);
-        return true;
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string       $new_STS_ID
-     * @param string       $old_STS_ID
-     * @param Context|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, Context $context = null)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        $this->updateIfCanceled(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-        $this->updateIfDeclined(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array        $closed_reg_statuses
-     * @param string       $new_STS_ID
-     * @param string       $old_STS_ID
-     * @param Context|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateIfCanceled(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
-    {
-        // true if registration has been cancelled or declined
-        if (in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__canceled_or_declined',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-            return;
-        }
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array        $closed_reg_statuses
-     * @param string       $new_STS_ID
-     * @param string       $old_STS_ID
-     * @param Context|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateIfDeclined(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
-    {
-        // true if reinstating cancelled or declined registration
-        if (in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__after_reinstated',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-        }
-    }
-
-
-    /**
-     * @param Context|null $context
-     * @return bool
-     */
-    private function statusChangeUpdatesTransaction(Context $context = null)
-    {
-        $contexts_that_do_not_update_transaction = (array) apply_filters(
-            'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
-            array('spco_reg_step_attendee_information_process_registrations'),
-            $context,
-            $this
-        );
-        return ! (
-            $context instanceof Context
-            && in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateTransactionAfterStatusChange()
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        $transaction_payments->recalculate_transaction_total($this->transaction(), false);
-        $this->transaction()->update_status_based_on_total_paid(true);
-    }
-
-
-    /**
-     *        get Status ID
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _reserve_registration_space()
-    {
-        // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket();
-        $ticket = $this->ticket();
-        $ticket->increase_sold();
-        $ticket->save();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     *
-     * @return EE_Ticket|EE_Base_Class
-     * @throws EE_Error
-     */
-    public function ticket($include_archived = true)
-    {
-        $query_params = array();
-        if ($include_archived) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets the event this registration is for
-     *
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function event()
-    {
-        $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
-            throw new EntityNotFoundException('Event ID', $this->event_ID());
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
-     * with the author of the event this registration is for.
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function wp_user()
-    {
-        $event = $this->event();
-        if ($event instanceof EE_Event) {
-            return $event->wp_user();
-        }
-        return 0;
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _release_registration_space()
-    {
-        $ticket = $this->ticket();
-        $ticket->decrease_sold();
-        $ticket->save();
-    }
-
-
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will increment ticket and datetime reserved count
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function reserve_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call update_extra_meta(), which is why that is done first
-            if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increase_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function release_reserved_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
-            if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decrease_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * Set Attendee ID
-     *
-     * @param        int $ATT_ID Attendee ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param        int $TXN_ID Transaction ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param    string $REG_session PHP Session ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param    string $REG_url_link Registration URL Link
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_reg_url_link($REG_url_link = '')
-    {
-        $this->set('REG_url_link', $REG_url_link);
-    }
-
-
-    /**
-     *        Set Attendee Counter
-     *
-     * @param        int $REG_count Primary Attendee
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param        boolean $REG_group_size Group Registration
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_group_size($REG_group_size = false)
-    {
-        $this->set('REG_group_size', $REG_group_size);
-    }
-
-
-    /**
-     *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_not_approved
-     *
-     * @return        boolean
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_pending_payment
-     *
-     * @return        boolean
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
-     *
-     * @return        boolean
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
-     *
-     * @return        boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
-     *
-     * @return        boolean
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_incomplete
-     *
-     * @return        boolean
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
-    }
-
-
-    /**
-     *        Set Registration Date
-     *
-     * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
-     *                                                 Date
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_reg_date($REG_date = false)
-    {
-        $this->set('REG_date', $REG_date);
-    }
-
-
-    /**
-     *    Set final price owing for this registration after all ticket/price modifications
-     *
-     * @access    public
-     * @param    float $REG_final_price
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_final_price($REG_final_price = 0.00)
-    {
-        $this->set('REG_final_price', $REG_final_price);
-    }
-
-
-    /**
-     *    Set amount paid towards this registration's final price
-     *
-     * @access    public
-     * @param    float $REG_paid
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_paid($REG_paid = 0.00)
-    {
-        $this->set('REG_paid', $REG_paid);
-    }
-
-
-    /**
-     *        Attendee Is Going
-     *
-     * @param        boolean $REG_att_is_going Attendee Is Going
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_att_is_going($REG_att_is_going = false)
-    {
-        $this->set('REG_att_is_going', $REG_att_is_going);
-    }
-
-
-    /**
-     * Gets the related attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public function attendee()
-    {
-        return $this->get_first_related('Attendee');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_ID()
-    {
-        return $this->get('EVT_ID');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_name()
-    {
-        $event = $this->event_obj();
-        if ($event) {
-            return $event->name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Fetches the event this registration is for
-     *
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public function event_obj()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     *        get Attendee ID
-     */
-    public function attendee_ID()
-    {
-        return $this->get('ATT_ID');
-    }
-
-
-    /**
-     *        get PHP Session ID
-     */
-    public function session_ID()
-    {
-        return $this->get('REG_session');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the receipt template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function receipt_url($messenger = 'html')
-    {
-
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom receipt template
-         * already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-        $has_custom             = EEH_Template::locate_template(
-            $template_relative_path,
-            array(),
-            true,
-            true,
-            true
-        );
-
-        if ($has_custom) {
-            return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
-        }
-        return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the invoice template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     * @throws EE_Error
-     */
-    public function invoice_url($messenger = 'html')
-    {
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom invoice template
-         * already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-        $has_custom             = EEH_Template::locate_template(
-            $template_relative_path,
-            array(),
-            true,
-            true,
-            true
-        );
-
-        if ($has_custom) {
-            if ($messenger == 'html') {
-                return $this->invoice_url('launch');
-            }
-            $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
-
-            $query_args = array('ee' => $route, 'id' => $this->reg_url_link());
-            if ($messenger == 'html') {
-                $query_args['html'] = true;
-            }
-            return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
-        }
-        return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
-    }
-
-
-    /**
-     * get Registration URL Link
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     */
-    public function reg_url_link()
-    {
-        return (string) $this->get('REG_url_link');
-    }
-
-
-    /**
-     * Echoes out invoice_url()
-     *
-     * @param string $type 'download','launch', or 'html' (default is 'launch')
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_invoice_url($type = 'launch')
-    {
-        echo $this->invoice_url($type);
-    }
-
-
-    /**
-     * Echoes out payment_overview_url
-     */
-    public function e_payment_overview_url()
-    {
-        echo $this->payment_overview_url();
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @param bool $clear_session Set to true when you want to clear the session on revisiting the
-     *                            payment overview url.
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_overview_url($clear_session = false)
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'payment_options',
-            'revisit'        => true,
-            'clear_session' => (bool) $clear_session
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'attendee_information',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Simply generates and returns the appropriate admin_url link to edit this registration
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_url()
-    {
-        return EEH_URL::add_query_args_and_nonce(array(
-            'page'    => 'espresso_registrations',
-            'action'  => 'view_registration',
-            '_REG_ID' => $this->ID(),
-        ), admin_url('admin.php'));
-    }
-
-
-    /**
-     *    is_primary_registrant?
-     */
-    public function is_primary_registrant()
-    {
-        return $this->get('REG_count') == 1 ? true : false;
-    }
-
-
-    /**
-     * This returns the primary registration object for this registration group (which may be this object).
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_primary_registration()
-    {
-        if ($this->is_primary_registrant()) {
-            return $this;
-        }
-
-        //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-        /** @var EE_Registration $primary_registrant */
-        $primary_registrant = EEM_Registration::instance()->get_one(array(
-            array(
-                'TXN_ID'    => $this->transaction_ID(),
-                'REG_count' => 1,
-            ),
-        ));
-        return $primary_registrant;
-    }
-
-
-    /**
-     *        get  Attendee Number
-     *
-     * @access        public
-     */
-    public function count()
-    {
-        return $this->get('REG_count');
-    }
-
-
-    /**
-     *        get Group Size
-     */
-    public function group_size()
-    {
-        return $this->get('REG_group_size');
-    }
-
-
-    /**
-     *        get Registration Date
-     */
-    public function date()
-    {
-        return $this->get('REG_date');
-    }
-
-
-    /**
-     * gets a pretty date
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_date($date_format = null, $time_format = null)
-    {
-        return $this->get_datetime('REG_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * final_price
-     * the registration's share of the transaction total, so that the
-     * sum of all the transaction's REG_final_prices equal the transaction's total
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function final_price()
-    {
-        return $this->get('REG_final_price');
-    }
-
-
-    /**
-     * pretty_final_price
-     *  final price as formatted string, with correct decimal places and currency symbol
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function paid()
-    {
-        return $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('REG_paid');
-    }
-
-
-    /**
-     * owes_monies_and_can_pay
-     * whether or not this registration has monies owing and it's' status allows payment
-     *
-     * @param array $requires_payment
-     * @return bool
-     * @throws EE_Error
-     */
-    public function owes_monies_and_can_pay($requires_payment = array())
-    {
-        // these reg statuses require payment (if event is not free)
-        $requires_payment = ! empty($requires_payment)
-            ? $requires_payment
-            : EEM_Registration::reg_statuses_that_allow_payment();
-        if (in_array($this->status_ID(), $requires_payment) &&
-            $this->final_price() != 0 &&
-            $this->final_price() != $this->paid()
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Prints out the return value of $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * Returns a nice version of the status for displaying to customers
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->status_ID() => esc_html__('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Registration::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_pending_payment:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_not_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_incomplete:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_wait_list:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[$this->status_ID()];
-    }
-
-
-    /**
-     *        get Attendee Is Going
-     */
-    public function att_is_going()
-    {
-        return $this->get('REG_att_is_going');
-    }
-
-
-    /**
-     * Gets related answers
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Answer[]
-     * @throws EE_Error
-     */
-    public function answers($query_params = null)
-    {
-        return $this->get_many_related('Answer', $query_params);
-    }
-
-
-    /**
-     * Gets the registration's answer value to the specified question
-     * (either the question's ID or a question object)
-     *
-     * @param EE_Question|int $question
-     * @param bool            $pretty_value
-     * @return array|string if pretty_value= true, the result will always be a string
-     * (because the answer might be an array of answer values, so passing pretty_value=true
-     * will convert it into some kind of string)
-     * @throws EE_Error
-     */
-    public function answer_value_to_question($question, $pretty_value = true)
-    {
-        $question_id = EEM_Question::instance()->ensure_is_ID($question);
-        return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
-    }
-
-
-    /**
-     * question_groups
-     * returns an array of EE_Question_Group objects for this registration
-     *
-     * @return EE_Question_Group[]
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function question_groups()
-    {
-        $question_groups = array();
-        if ($this->event() instanceof EE_Event) {
-            $question_groups = $this->event()->question_groups(
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                    'order_by' => array('QSG_order' => 'ASC'),
-                )
-            );
-        }
-        return $question_groups;
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function count_question_groups()
-    {
-        $qg_count = 0;
-        if ($this->event() instanceof EE_Event) {
-            $qg_count = $this->event()->count_related(
-                'Question_Group',
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                )
-            );
-        }
-        return $qg_count;
-    }
-
-
-    /**
-     * Returns the registration date in the 'standard' string format
-     * (function may be improved in the future to allow for different formats and timezones)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function reg_date()
-    {
-        return $this->get_datetime('REG_date');
-    }
-
-
-    /**
-     * Gets the datetime-ticket for this registration (ie, it can be used to isolate
-     * the ticket this registration purchased, or the datetime they have registered
-     * to attend)
-     *
-     * @return EE_Datetime_Ticket
-     * @throws EE_Error
-     */
-    public function datetime_ticket()
-    {
-        return $this->get_first_related('Datetime_Ticket');
-    }
-
-
-    /**
-     * Sets the registration's datetime_ticket.
-     *
-     * @param EE_Datetime_Ticket $datetime_ticket
-     * @return EE_Datetime_Ticket
-     * @throws EE_Error
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-    /**
-     * Gets deleted
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     * @throws EE_Error
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Returns the number of times this registration has checked into any of the datetimes
-     * its available for
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_checkins()
-    {
-        return $this->get_model()->count_related($this, 'Checkin');
-    }
-
-
-    /**
-     * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
-     * registration is for.  Note, this is ONLY checked in (does not include checkedout)
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_checkins_not_checkedout()
-    {
-        return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
-    }
-
-
-    /**
-     * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
-     * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
-     *                                          consider registration status as well as datetime access.
-     * @return bool
-     * @throws EE_Error
-     */
-    public function can_checkin($DTT_OR_ID, $check_approved = true)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        //first check registration status
-        if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
-            return false;
-        }
-        //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
-            array(
-                'TKT_ID' => $this->get('TKT_ID'),
-                'DTT_ID' => $DTT_ID,
-            ),
-        )))
-        ) {
-            return false;
-        }
-
-        //final check is against TKT_uses
-        return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
-    }
-
-
-    /**
-     * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
-     * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
-     * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
-     * then return false.  Otherwise return true.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
-     * @return bool true means can checkin.  false means cannot checkin.
-     * @throws EE_Error
-     */
-    public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        if (! $DTT_ID) {
-            return false;
-        }
-
-        $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
-
-        // if max uses is not set or equals infinity then return true cause its not a factor for whether user can
-        // check-in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
-            return true;
-        }
-
-        //does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
-        //go ahead and toggle.
-        if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
-            return true;
-        }
-
-        //made it here so the last check is whether the number of checkins per unique datetime on this registration
-        //disallows further check-ins.
-        $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
-            array(
-                'REG_ID' => $this->ID(),
-                'CHK_in' => true,
-            ),
-        ), 'DTT_ID', true);
-        // checkins have already reached their max number of uses
-        // so registrant can NOT checkin
-        if ($count_unique_dtt_checkins >= $max_uses) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     */
-    public function toggle_checkin_status($DTT_ID = null, $verify = false)
-    {
-        if (empty($DTT_ID)) {
-            $datetime = $this->get_latest_related_datetime();
-            $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
-            // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
-                        'event_espresso'
-                    ),
-                    $this->ID(),
-                    $DTT_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $status_paths = array(
-            EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
-            EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
-            EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
-        );
-        //start by getting the current status so we know what status we'll be changing to.
-        $cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
-        $status_to  = $status_paths[$cur_status];
-        // database only records true for checked IN or false for checked OUT
-        // no record ( null ) means checked in NEVER, but we obviously don't save that
-        $new_status = $status_to === EE_Checkin::status_checked_in ? true : false;
-        // add relation - note Check-ins are always creating new rows
-        // because we are keeping track of Check-ins over time.
-        // Eventually we'll probably want to show a list table
-        // for the individual Check-ins so that they can be managed.
-        $checkin = EE_Checkin::new_instance(array(
-            'REG_ID' => $this->ID(),
-            'DTT_ID' => $DTT_ID,
-            'CHK_in' => $new_status,
-        ));
-        // if the record could not be saved then return false
-        if ($checkin->save() === 0) {
-            if (WP_DEBUG) {
-                global $wpdb;
-                $error = sprintf(
-                    esc_html__(
-                        'Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = esc_html__(
-                    'Registration check in update failed because of an unknown database error',
-                    'event_espresso'
-                );
-            }
-            EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return $status_to;
-    }
-
-
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws EE_Error
-     */
-    public function get_latest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'DESC'),
-            )
-        );
-    }
-
-
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @throws EE_Error
-     */
-    public function get_earliest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-    }
-
-
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param  int       $DTT_ID  The ID of the datetime we're checking against
-     *                            (if empty we'll get the primary datetime for
-     *                            this registration (via event) and use it's ID);
-     * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
-     *
-     * @return int                Integer representing Check-in status.
-     * @throws EE_Error
-     */
-    public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
-    {
-        $checkin_query_params = array(
-            'order_by' => array('CHK_timestamp' => 'DESC'),
-        );
-
-        if ($DTT_ID > 0) {
-            $checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
-        }
-
-        //get checkin object (if exists)
-        $checkin = $checkin instanceof EE_Checkin
-            ? $checkin
-            : $this->get_first_related('Checkin', $checkin_query_params);
-        if ($checkin instanceof EE_Checkin) {
-            if ($checkin->get('CHK_in')) {
-                return EE_Checkin::status_checked_in; //checked in
-            }
-            return EE_Checkin::status_checked_out; //had checked in but is now checked out.
-        }
-        return EE_Checkin::status_checked_never; //never been checked in
-    }
-
-
-    /**
-     * This method returns a localized message for the toggled Check-in message.
-     *
-     * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
-     *                     then it is assumed Check-in for primary datetime was toggled.
-     * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
-     *                     message can be customized with the attendee name.
-     * @return string internationalized message
-     * @throws EE_Error
-     */
-    public function get_checkin_msg($DTT_ID, $error = false)
-    {
-        //let's get the attendee first so we can include the name of the attendee
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            if ($error) {
-                return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
-            }
-            $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-            //what is the status message going to be?
-            switch ($cur_status) {
-                case EE_Checkin::status_checked_never:
-                    return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
-                        $attendee->full_name());
-                    break;
-                case EE_Checkin::status_checked_in:
-                    return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                    break;
-                case EE_Checkin::status_checked_out:
-                    return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-                    break;
-            }
-        }
-        return esc_html__("The check-in status could not be determined.", "event_espresso");
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function transaction()
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     *        get Registration Code
-     */
-    public function reg_code()
-    {
-        return $this->get('REG_code');
-    }
-
-
-    /**
-     *        get Transaction ID
-     */
-    public function transaction_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     *        Set Registration Code
-     *
-     * @access    public
-     * @param    string  $REG_code Registration Code
-     * @param    boolean $use_default
-     * @throws EE_Error
-     */
-    public function set_reg_code($REG_code, $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(
-                esc_html__('REG_code can not be empty.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-        if (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } else {
-            EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
-                esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
-                '4.6.0'
-            );
-        }
-    }
-
-
-    /**
-     * Returns all other registrations in the same group as this registrant who have the same ticket option.
-     * Note, if you want to just get all registrations in the same transaction (group), use:
-     *    $registration->transaction()->registrations();
-     *
-     * @since 4.5.0
-     * @return EE_Registration[] or empty array if this isn't a group registration.
-     * @throws EE_Error
-     */
-    public function get_all_other_registrations_in_group()
-    {
-        if ($this->group_size() < 2) {
-            return array();
-        }
-
-        $query[0] = array(
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => array('!=', $this->ID()),
-            'TKT_ID' => $this->ticket_ID(),
-        );
-        /** @var EE_Registration[] $registrations */
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page' => 'espresso_registrations',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @param array $query_params
-     *
-     * @return \EE_Registration[]
-     * @throws EE_Error
-     */
-    public function payments($query_params = array())
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     *
-     * @return \EE_Registration_Payment[]
-     * @throws EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
-     * Note: if there are no payments on the registration there will be no payment method returned.
-     *
-     * @return EE_Payment_Method|null
-     */
-    public function payment_method()
-    {
-        return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     */
-    public function ticket_line_item()
-    {
-        $ticket            = $this->ticket();
-        $transaction       = $this->transaction();
-        $line_item         = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Soft Deletes this model object.
-     *
-     * @return boolean | int
-     * @throws RuntimeException
-     * @throws EE_Error
-     */
-    public function delete()
-    {
-        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
-
-
-    /**
-     * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
-     *
-     * @param  boolean $trigger_set_status_logic EE_Registration::set_status() can trigger additional logic
-     *                                           depending on whether the reg status changes to or from "Approved"
-     * @return boolean whether the Registration status was updated
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
-    {
-        $paid = $this->paid();
-        $price = $this->final_price();
-        switch(true) {
-            // overpaid or paid
-            case EEH_Money::compare_floats($paid, $price, '>'):
-            case EEH_Money::compare_floats($paid, $price):
-                $new_status = EEM_Registration::status_id_approved;
-                break;
-            //  underpaid
-            case EEH_Money::compare_floats($paid, $price, '<'):
-                $new_status = EEM_Registration::status_id_pending_payment;
-                break;
-            // uhhh Houston...
-            default:
-                throw new RuntimeException(
-                    esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
-                );
-        }
-        if ($new_status !== $this->status_ID()) {
-            if ($trigger_set_status_logic) {
-                return $this->set_status($new_status);
-            }
-            parent::set('STS_ID', $new_status);
-            return true;
-        }
-        return false;
-    }
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::price_paid()',
-            esc_html__('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        return $this->final_price();
-    }
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     * @param    float $REG_final_price
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
-            esc_html__('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        $this->set_final_price($REG_final_price);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.7.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
-            esc_html__('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
-                'event_espresso'), '4.7.0');
-        return $this->pretty_final_price();
-    }
-
-
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @deprecated 4.9.17
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function get_related_primary_datetime()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_never instead
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_in instead
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_out instead
+	 * @type int
+	 */
+	const checkin_status_out = 0;
+
+
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Registration
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Event ID
+	 *
+	 * @param        int $EVT_ID Event ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_event($EVT_ID = 0)
+	{
+		$this->set('EVT_ID', $EVT_ID);
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
+	 * be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'REG_code':
+				if (! empty($field_value) && $this->reg_code() === null) {
+					$this->set_reg_code($field_value, $use_default);
+				}
+				break;
+			case 'STS_ID':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string       $new_STS_ID
+	 * @param boolean      $use_default
+	 * @param Context|null $context
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false, Context $context = null)
+	{
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		// if status has changed
+		if ($old_STS_ID !== $new_STS_ID // and that status has actually changed
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
+			&& $this->ID() // ensure registration is in the db
+		) {
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->_reserve_registration_space();
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
+				// OR FROM  approved
+			} elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
+				// release a space by decrementing ticket and datetime sold values
+				$this->_release_registration_space();
+				do_action(
+					'AHEE__EE_Registration__set_status__from_approved',
+					$this,
+					$old_STS_ID,
+					$new_STS_ID,
+					$context
+				);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, $context);
+			if($this->statusChangeUpdatesTransaction($context)) {
+				$this->updateTransactionAfterStatusChange();
+			}
+			do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
+			return true;
+		}
+		//even though the old value matches the new value, it's still good to
+		//allow the parent set method to have a say
+		parent::set('STS_ID', $new_STS_ID, $use_default);
+		return true;
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string       $new_STS_ID
+	 * @param string       $old_STS_ID
+	 * @param Context|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, Context $context = null)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		$this->updateIfCanceled(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+		$this->updateIfDeclined(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array        $closed_reg_statuses
+	 * @param string       $new_STS_ID
+	 * @param string       $old_STS_ID
+	 * @param Context|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateIfCanceled(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
+	{
+		// true if registration has been cancelled or declined
+		if (in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__canceled_or_declined',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+			return;
+		}
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array        $closed_reg_statuses
+	 * @param string       $new_STS_ID
+	 * @param string       $old_STS_ID
+	 * @param Context|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateIfDeclined(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
+	{
+		// true if reinstating cancelled or declined registration
+		if (in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__after_reinstated',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+		}
+	}
+
+
+	/**
+	 * @param Context|null $context
+	 * @return bool
+	 */
+	private function statusChangeUpdatesTransaction(Context $context = null)
+	{
+		$contexts_that_do_not_update_transaction = (array) apply_filters(
+			'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
+			array('spco_reg_step_attendee_information_process_registrations'),
+			$context,
+			$this
+		);
+		return ! (
+			$context instanceof Context
+			&& in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateTransactionAfterStatusChange()
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		$transaction_payments->recalculate_transaction_total($this->transaction(), false);
+		$this->transaction()->update_status_based_on_total_paid(true);
+	}
+
+
+	/**
+	 *        get Status ID
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _reserve_registration_space()
+	{
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket();
+		$ticket = $this->ticket();
+		$ticket->increase_sold();
+		$ticket->save();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 *
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function ticket($include_archived = true)
+	{
+		$query_params = array();
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets the event this registration is for
+	 *
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function event()
+	{
+		$event = $this->get_first_related('Event');
+		if (! $event instanceof \EE_Event) {
+			throw new EntityNotFoundException('Event ID', $this->event_ID());
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
+	 * with the author of the event this registration is for.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function wp_user()
+	{
+		$event = $this->event();
+		if ($event instanceof EE_Event) {
+			return $event->wp_user();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _release_registration_space()
+	{
+		$ticket = $this->ticket();
+		$ticket->decrease_sold();
+		$ticket->save();
+	}
+
+
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will increment ticket and datetime reserved count
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function reserve_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call update_extra_meta(), which is why that is done first
+			if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increase_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function release_reserved_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
+			if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decrease_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * Set Attendee ID
+	 *
+	 * @param        int $ATT_ID Attendee ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param        int $TXN_ID Transaction ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param    string $REG_session PHP Session ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param    string $REG_url_link Registration URL Link
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_reg_url_link($REG_url_link = '')
+	{
+		$this->set('REG_url_link', $REG_url_link);
+	}
+
+
+	/**
+	 *        Set Attendee Counter
+	 *
+	 * @param        int $REG_count Primary Attendee
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param        boolean $REG_group_size Group Registration
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_group_size($REG_group_size = false)
+	{
+		$this->set('REG_group_size', $REG_group_size);
+	}
+
+
+	/**
+	 *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_not_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_pending_payment
+	 *
+	 * @return        boolean
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
+	 *
+	 * @return        boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
+	 *
+	 * @return        boolean
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_incomplete
+	 *
+	 * @return        boolean
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
+	}
+
+
+	/**
+	 *        Set Registration Date
+	 *
+	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
+	 *                                                 Date
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_reg_date($REG_date = false)
+	{
+		$this->set('REG_date', $REG_date);
+	}
+
+
+	/**
+	 *    Set final price owing for this registration after all ticket/price modifications
+	 *
+	 * @access    public
+	 * @param    float $REG_final_price
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_final_price($REG_final_price = 0.00)
+	{
+		$this->set('REG_final_price', $REG_final_price);
+	}
+
+
+	/**
+	 *    Set amount paid towards this registration's final price
+	 *
+	 * @access    public
+	 * @param    float $REG_paid
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_paid($REG_paid = 0.00)
+	{
+		$this->set('REG_paid', $REG_paid);
+	}
+
+
+	/**
+	 *        Attendee Is Going
+	 *
+	 * @param        boolean $REG_att_is_going Attendee Is Going
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_att_is_going($REG_att_is_going = false)
+	{
+		$this->set('REG_att_is_going', $REG_att_is_going);
+	}
+
+
+	/**
+	 * Gets the related attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public function attendee()
+	{
+		return $this->get_first_related('Attendee');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_ID()
+	{
+		return $this->get('EVT_ID');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_name()
+	{
+		$event = $this->event_obj();
+		if ($event) {
+			return $event->name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Fetches the event this registration is for
+	 *
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public function event_obj()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 *        get Attendee ID
+	 */
+	public function attendee_ID()
+	{
+		return $this->get('ATT_ID');
+	}
+
+
+	/**
+	 *        get PHP Session ID
+	 */
+	public function session_ID()
+	{
+		return $this->get('REG_session');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the receipt template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function receipt_url($messenger = 'html')
+	{
+
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template
+		 * already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
+		$has_custom             = EEH_Template::locate_template(
+			$template_relative_path,
+			array(),
+			true,
+			true,
+			true
+		);
+
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
+		}
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the invoice template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function invoice_url($messenger = 'html')
+	{
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template
+		 * already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
+		$has_custom             = EEH_Template::locate_template(
+			$template_relative_path,
+			array(),
+			true,
+			true,
+			true
+		);
+
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
+			}
+			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
+
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
+				$query_args['html'] = true;
+			}
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
+		}
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
+	}
+
+
+	/**
+	 * get Registration URL Link
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function reg_url_link()
+	{
+		return (string) $this->get('REG_url_link');
+	}
+
+
+	/**
+	 * Echoes out invoice_url()
+	 *
+	 * @param string $type 'download','launch', or 'html' (default is 'launch')
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_invoice_url($type = 'launch')
+	{
+		echo $this->invoice_url($type);
+	}
+
+
+	/**
+	 * Echoes out payment_overview_url
+	 */
+	public function e_payment_overview_url()
+	{
+		echo $this->payment_overview_url();
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @param bool $clear_session Set to true when you want to clear the session on revisiting the
+	 *                            payment overview url.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_overview_url($clear_session = false)
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'payment_options',
+			'revisit'        => true,
+			'clear_session' => (bool) $clear_session
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'attendee_information',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Simply generates and returns the appropriate admin_url link to edit this registration
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_url()
+	{
+		return EEH_URL::add_query_args_and_nonce(array(
+			'page'    => 'espresso_registrations',
+			'action'  => 'view_registration',
+			'_REG_ID' => $this->ID(),
+		), admin_url('admin.php'));
+	}
+
+
+	/**
+	 *    is_primary_registrant?
+	 */
+	public function is_primary_registrant()
+	{
+		return $this->get('REG_count') == 1 ? true : false;
+	}
+
+
+	/**
+	 * This returns the primary registration object for this registration group (which may be this object).
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->is_primary_registrant()) {
+			return $this;
+		}
+
+		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
+		/** @var EE_Registration $primary_registrant */
+		$primary_registrant = EEM_Registration::instance()->get_one(array(
+			array(
+				'TXN_ID'    => $this->transaction_ID(),
+				'REG_count' => 1,
+			),
+		));
+		return $primary_registrant;
+	}
+
+
+	/**
+	 *        get  Attendee Number
+	 *
+	 * @access        public
+	 */
+	public function count()
+	{
+		return $this->get('REG_count');
+	}
+
+
+	/**
+	 *        get Group Size
+	 */
+	public function group_size()
+	{
+		return $this->get('REG_group_size');
+	}
+
+
+	/**
+	 *        get Registration Date
+	 */
+	public function date()
+	{
+		return $this->get('REG_date');
+	}
+
+
+	/**
+	 * gets a pretty date
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_date($date_format = null, $time_format = null)
+	{
+		return $this->get_datetime('REG_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * final_price
+	 * the registration's share of the transaction total, so that the
+	 * sum of all the transaction's REG_final_prices equal the transaction's total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function final_price()
+	{
+		return $this->get('REG_final_price');
+	}
+
+
+	/**
+	 * pretty_final_price
+	 *  final price as formatted string, with correct decimal places and currency symbol
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function paid()
+	{
+		return $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('REG_paid');
+	}
+
+
+	/**
+	 * owes_monies_and_can_pay
+	 * whether or not this registration has monies owing and it's' status allows payment
+	 *
+	 * @param array $requires_payment
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function owes_monies_and_can_pay($requires_payment = array())
+	{
+		// these reg statuses require payment (if event is not free)
+		$requires_payment = ! empty($requires_payment)
+			? $requires_payment
+			: EEM_Registration::reg_statuses_that_allow_payment();
+		if (in_array($this->status_ID(), $requires_payment) &&
+			$this->final_price() != 0 &&
+			$this->final_price() != $this->paid()
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Prints out the return value of $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * Returns a nice version of the status for displaying to customers
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->status_ID() => esc_html__('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Registration::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_pending_payment:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_not_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_incomplete:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_wait_list:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[$this->status_ID()];
+	}
+
+
+	/**
+	 *        get Attendee Is Going
+	 */
+	public function att_is_going()
+	{
+		return $this->get('REG_att_is_going');
+	}
+
+
+	/**
+	 * Gets related answers
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Answer[]
+	 * @throws EE_Error
+	 */
+	public function answers($query_params = null)
+	{
+		return $this->get_many_related('Answer', $query_params);
+	}
+
+
+	/**
+	 * Gets the registration's answer value to the specified question
+	 * (either the question's ID or a question object)
+	 *
+	 * @param EE_Question|int $question
+	 * @param bool            $pretty_value
+	 * @return array|string if pretty_value= true, the result will always be a string
+	 * (because the answer might be an array of answer values, so passing pretty_value=true
+	 * will convert it into some kind of string)
+	 * @throws EE_Error
+	 */
+	public function answer_value_to_question($question, $pretty_value = true)
+	{
+		$question_id = EEM_Question::instance()->ensure_is_ID($question);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
+	}
+
+
+	/**
+	 * question_groups
+	 * returns an array of EE_Question_Group objects for this registration
+	 *
+	 * @return EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function question_groups()
+	{
+		$question_groups = array();
+		if ($this->event() instanceof EE_Event) {
+			$question_groups = $this->event()->question_groups(
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+					'order_by' => array('QSG_order' => 'ASC'),
+				)
+			);
+		}
+		return $question_groups;
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function count_question_groups()
+	{
+		$qg_count = 0;
+		if ($this->event() instanceof EE_Event) {
+			$qg_count = $this->event()->count_related(
+				'Question_Group',
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+				)
+			);
+		}
+		return $qg_count;
+	}
+
+
+	/**
+	 * Returns the registration date in the 'standard' string format
+	 * (function may be improved in the future to allow for different formats and timezones)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function reg_date()
+	{
+		return $this->get_datetime('REG_date');
+	}
+
+
+	/**
+	 * Gets the datetime-ticket for this registration (ie, it can be used to isolate
+	 * the ticket this registration purchased, or the datetime they have registered
+	 * to attend)
+	 *
+	 * @return EE_Datetime_Ticket
+	 * @throws EE_Error
+	 */
+	public function datetime_ticket()
+	{
+		return $this->get_first_related('Datetime_Ticket');
+	}
+
+
+	/**
+	 * Sets the registration's datetime_ticket.
+	 *
+	 * @param EE_Datetime_Ticket $datetime_ticket
+	 * @return EE_Datetime_Ticket
+	 * @throws EE_Error
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 * @throws EE_Error
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Returns the number of times this registration has checked into any of the datetimes
+	 * its available for
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_checkins()
+	{
+		return $this->get_model()->count_related($this, 'Checkin');
+	}
+
+
+	/**
+	 * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
+	 * registration is for.  Note, this is ONLY checked in (does not include checkedout)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_checkins_not_checkedout()
+	{
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
+	}
+
+
+	/**
+	 * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
+	 * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
+	 *                                          consider registration status as well as datetime access.
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function can_checkin($DTT_OR_ID, $check_approved = true)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		//first check registration status
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
+			return false;
+		}
+		//is there a datetime ticket that matches this dtt_ID?
+		if (! (EEM_Datetime_Ticket::instance()->exists(array(
+			array(
+				'TKT_ID' => $this->get('TKT_ID'),
+				'DTT_ID' => $DTT_ID,
+			),
+		)))
+		) {
+			return false;
+		}
+
+		//final check is against TKT_uses
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
+	}
+
+
+	/**
+	 * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
+	 * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
+	 * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
+	 * then return false.  Otherwise return true.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
+	 * @return bool true means can checkin.  false means cannot checkin.
+	 * @throws EE_Error
+	 */
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		if (! $DTT_ID) {
+			return false;
+		}
+
+		$max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
+
+		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can
+		// check-in or not.
+		if (! $max_uses || $max_uses === EE_INF) {
+			return true;
+		}
+
+		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
+		//go ahead and toggle.
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
+			return true;
+		}
+
+		//made it here so the last check is whether the number of checkins per unique datetime on this registration
+		//disallows further check-ins.
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
+			array(
+				'REG_ID' => $this->ID(),
+				'CHK_in' => true,
+			),
+		), 'DTT_ID', true);
+		// checkins have already reached their max number of uses
+		// so registrant can NOT checkin
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(
+				esc_html__(
+					'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 */
+	public function toggle_checkin_status($DTT_ID = null, $verify = false)
+	{
+		if (empty($DTT_ID)) {
+			$datetime = $this->get_latest_related_datetime();
+			$DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
+			// verify the registration can checkin for the given DTT_ID
+		} elseif (! $this->can_checkin($DTT_ID, $verify)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
+						'event_espresso'
+					),
+					$this->ID(),
+					$DTT_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$status_paths = array(
+			EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
+			EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
+			EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
+		);
+		//start by getting the current status so we know what status we'll be changing to.
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
+		$status_to  = $status_paths[$cur_status];
+		// database only records true for checked IN or false for checked OUT
+		// no record ( null ) means checked in NEVER, but we obviously don't save that
+		$new_status = $status_to === EE_Checkin::status_checked_in ? true : false;
+		// add relation - note Check-ins are always creating new rows
+		// because we are keeping track of Check-ins over time.
+		// Eventually we'll probably want to show a list table
+		// for the individual Check-ins so that they can be managed.
+		$checkin = EE_Checkin::new_instance(array(
+			'REG_ID' => $this->ID(),
+			'DTT_ID' => $DTT_ID,
+			'CHK_in' => $new_status,
+		));
+		// if the record could not be saved then return false
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
+				global $wpdb;
+				$error = sprintf(
+					esc_html__(
+						'Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = esc_html__(
+					'Registration check in update failed because of an unknown database error',
+					'event_espresso'
+				);
+			}
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return $status_to;
+	}
+
+
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws EE_Error
+	 */
+	public function get_latest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'DESC'),
+			)
+		);
+	}
+
+
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @throws EE_Error
+	 */
+	public function get_earliest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+	}
+
+
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param  int       $DTT_ID  The ID of the datetime we're checking against
+	 *                            (if empty we'll get the primary datetime for
+	 *                            this registration (via event) and use it's ID);
+	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
+	 *
+	 * @return int                Integer representing Check-in status.
+	 * @throws EE_Error
+	 */
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
+	{
+		$checkin_query_params = array(
+			'order_by' => array('CHK_timestamp' => 'DESC'),
+		);
+
+		if ($DTT_ID > 0) {
+			$checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
+		}
+
+		//get checkin object (if exists)
+		$checkin = $checkin instanceof EE_Checkin
+			? $checkin
+			: $this->get_first_related('Checkin', $checkin_query_params);
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
+				return EE_Checkin::status_checked_in; //checked in
+			}
+			return EE_Checkin::status_checked_out; //had checked in but is now checked out.
+		}
+		return EE_Checkin::status_checked_never; //never been checked in
+	}
+
+
+	/**
+	 * This method returns a localized message for the toggled Check-in message.
+	 *
+	 * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
+	 *                     then it is assumed Check-in for primary datetime was toggled.
+	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
+	 *                     message can be customized with the attendee name.
+	 * @return string internationalized message
+	 * @throws EE_Error
+	 */
+	public function get_checkin_msg($DTT_ID, $error = false)
+	{
+		//let's get the attendee first so we can include the name of the attendee
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
+			}
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+			//what is the status message going to be?
+			switch ($cur_status) {
+				case EE_Checkin::status_checked_never:
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
+						$attendee->full_name());
+					break;
+				case EE_Checkin::status_checked_in:
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+					break;
+				case EE_Checkin::status_checked_out:
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+					break;
+			}
+		}
+		return esc_html__("The check-in status could not be determined.", "event_espresso");
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function transaction()
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof \EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 *        get Registration Code
+	 */
+	public function reg_code()
+	{
+		return $this->get('REG_code');
+	}
+
+
+	/**
+	 *        get Transaction ID
+	 */
+	public function transaction_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 *        Set Registration Code
+	 *
+	 * @access    public
+	 * @param    string  $REG_code Registration Code
+	 * @param    boolean $use_default
+	 * @throws EE_Error
+	 */
+	public function set_reg_code($REG_code, $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(
+				esc_html__('REG_code can not be empty.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+		if (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} else {
+			EE_Error::doing_it_wrong(
+				__CLASS__ . '::' . __FUNCTION__,
+				esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
+				'4.6.0'
+			);
+		}
+	}
+
+
+	/**
+	 * Returns all other registrations in the same group as this registrant who have the same ticket option.
+	 * Note, if you want to just get all registrations in the same transaction (group), use:
+	 *    $registration->transaction()->registrations();
+	 *
+	 * @since 4.5.0
+	 * @return EE_Registration[] or empty array if this isn't a group registration.
+	 * @throws EE_Error
+	 */
+	public function get_all_other_registrations_in_group()
+	{
+		if ($this->group_size() < 2) {
+			return array();
+		}
+
+		$query[0] = array(
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => array('!=', $this->ID()),
+			'TKT_ID' => $this->ticket_ID(),
+		);
+		/** @var EE_Registration[] $registrations */
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page' => 'espresso_registrations',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 *
+	 * @return \EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function payments($query_params = array())
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 *
+	 * @return \EE_Registration_Payment[]
+	 * @throws EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
+	 * Note: if there are no payments on the registration there will be no payment method returned.
+	 *
+	 * @return EE_Payment_Method|null
+	 */
+	public function payment_method()
+	{
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 */
+	public function ticket_line_item()
+	{
+		$ticket            = $this->ticket();
+		$transaction       = $this->transaction();
+		$line_item         = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @return boolean | int
+	 * @throws RuntimeException
+	 * @throws EE_Error
+	 */
+	public function delete()
+	{
+		if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
+
+
+	/**
+	 * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
+	 *
+	 * @param  boolean $trigger_set_status_logic EE_Registration::set_status() can trigger additional logic
+	 *                                           depending on whether the reg status changes to or from "Approved"
+	 * @return boolean whether the Registration status was updated
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
+	{
+		$paid = $this->paid();
+		$price = $this->final_price();
+		switch(true) {
+			// overpaid or paid
+			case EEH_Money::compare_floats($paid, $price, '>'):
+			case EEH_Money::compare_floats($paid, $price):
+				$new_status = EEM_Registration::status_id_approved;
+				break;
+			//  underpaid
+			case EEH_Money::compare_floats($paid, $price, '<'):
+				$new_status = EEM_Registration::status_id_pending_payment;
+				break;
+			// uhhh Houston...
+			default:
+				throw new RuntimeException(
+					esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
+				);
+		}
+		if ($new_status !== $this->status_ID()) {
+			if ($trigger_set_status_logic) {
+				return $this->set_status($new_status);
+			}
+			parent::set('STS_ID', $new_status);
+			return true;
+		}
+		return false;
+	}
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::price_paid()',
+			esc_html__('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		return $this->final_price();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 * @param    float $REG_final_price
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
+			esc_html__('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		$this->set_final_price($REG_final_price);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.7.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
+			esc_html__('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
+				'event_espresso'), '4.7.0');
+		return $this->pretty_final_price();
+	}
+
+
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @deprecated 4.9.17
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function get_related_primary_datetime()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
 
 
 }

Spacing +14 added lines, -14 removed lines

@@ -120,7 +120,7 @@ 
     {
         switch ($field_name) {
             case 'REG_code':
-                if (! empty($field_value) && $this->reg_code() === null) {
+                if ( ! empty($field_value) && $this->reg_code() === null) {
                     $this->set_reg_code($field_value, $use_default);
                 }
                 break;
@@ -181,7 +181,7 @@ 
             // update status
             parent::set('STS_ID', $new_STS_ID, $use_default);
             $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, $context);
-            if($this->statusChangeUpdatesTransaction($context)) {
+            if ($this->statusChangeUpdatesTransaction($context)) {
                 $this->updateTransactionAfterStatusChange();
             }
             do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
@@ -409,7 +409,7 @@ 
     public function event()
     {
         $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
+        if ( ! $event instanceof \EE_Event) {
             throw new EntityNotFoundException('Event ID', $this->event_ID());
         }
         return $event;
@@ -1100,7 +1100,7 @@ 
             false,
             'sentence'
         );
-        $icon   = '';
+        $icon = '';
         switch ($this->status_ID()) {
             case EEM_Registration::status_id_approved:
                 $icon = $show_icons
@@ -1138,7 +1138,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[$this->status_ID()];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -1356,7 +1356,7 @@ 
             return false;
         }
         //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
+        if ( ! (EEM_Datetime_Ticket::instance()->exists(array(
             array(
                 'TKT_ID' => $this->get('TKT_ID'),
                 'DTT_ID' => $DTT_ID,
@@ -1385,7 +1385,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return false;
         }
 
@@ -1393,7 +1393,7 @@ 
 
         // if max uses is not set or equals infinity then return true cause its not a factor for whether user can
         // check-in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
+        if ( ! $max_uses || $max_uses === EE_INF) {
             return true;
         }
 
@@ -1449,7 +1449,7 @@ 
             $datetime = $this->get_latest_related_datetime();
             $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
             // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
+        } elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -1633,7 +1633,7 @@ 
     public function transaction()
     {
         $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
+        if ( ! $transaction instanceof \EE_Transaction) {
             throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
         }
         return $transaction;
@@ -1687,11 +1687,11 @@ 
             );
             return;
         }
-        if (! $this->reg_code()) {
+        if ( ! $this->reg_code()) {
             parent::set('REG_code', $REG_code, $use_default);
         } else {
             EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
+                __CLASS__.'::'.__FUNCTION__,
                 esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
                 '4.6.0'
             );
@@ -1843,7 +1843,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;
@@ -1900,7 +1900,7 @@ 
     {
         $paid = $this->paid();
         $price = $this->final_price();
-        switch(true) {
+        switch (true) {
             // overpaid or paid
             case EEH_Money::compare_floats($paid, $price, '>'):
             case EEH_Money::compare_floats($paid, $price):

core/services/Benchmark.php

Indentation +303 added lines, -303 removed lines

@@ -17,309 +17,309 @@
 class Benchmark
 {
 
-    /**
-     * array containing the start time for the timers
-     */
-    private static $start_times;
-
-    /**
-     * array containing all the timer'd times, which can be outputted via show_times()
-     */
-    private static $times = array();
-
-    /**
-     * @var array
-     */
-    protected static $memory_usage = array();
-
-
-
-    /**
-     * whether to benchmark code or not
-     */
-    public static function doNotRun()
-    {
-        return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
-    }
-
-
-
-    /**
-     * resetTimes
-     */
-    public static function resetTimes()
-    {
-        Benchmark::$times = array();
-    }
-
-
-
-    /**
-     * Add Benchmark::startTimer() before a block of code you want to measure the performance of
-     *
-     * @param null $timer_name
-     */
-    public static function startTimer($timer_name = null)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        Benchmark::$start_times[$timer_name] = microtime(true);
-    }
-
-
-
-    /**
-     * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
-     *
-     * @param string $timer_name
-     */
-    public static function stopTimer($timer_name = '')
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        if (isset(Benchmark::$start_times[$timer_name])) {
-            $start_time = Benchmark::$start_times[$timer_name];
-            unset(Benchmark::$start_times[$timer_name]);
-        } else {
-            $start_time = array_pop(Benchmark::$start_times);
-        }
-        Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
-    }
-
-
-
-    /**
-     * Measure the memory usage by PHP so far.
-     *
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @param bool    $formatted
-     * @return void
-     */
-    public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $memory_used = Benchmark::convert(memory_get_usage(true));
-        Benchmark::$memory_usage[$label] = $memory_used;
-        if ($output_now) {
-            echo $formatted
-                ? "<br>{$label} : {$memory_used}"
-                : "\n {$label} : {$memory_used}";
-        }
-    }
-
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param bool $formatted
-     * @return void
-     */
-    public static function displayResultsAtShutdown($formatted = true)
-    {
-        add_action(
-            'shutdown',
-            function () use ($formatted) {
-                Benchmark::displayResults(true, $formatted);
-            }
-        );
-    }
-
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     * @return void
-     */
-    public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
-    {
-        add_action(
-            'shutdown',
-            function () use ($filepath, $formatted, $append) {
-                Benchmark::writeResultsToFile($filepath, $formatted, $append);
-            }
-        );
-    }
-
-
-
-    /**
-     * @param bool $formatted
-     * @return string
-     */
-    private static function generateResults($formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return '';
-        }
-        $output = '';
-        if (! empty(Benchmark::$times)) {
-            $total = 0;
-            $output .= $formatted
-                ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
-                : '';
-            foreach (Benchmark::$times as $timer_name => $total_time) {
-                $output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
-                $output .= $formatted ? '<br />'  : "\n";
-                $total += $total_time;
-            }
-            if($formatted) {
-                $output .= '<br />';
-                $output .= '<h4>TOTAL TIME</h4>';
-                $output .= Benchmark::formatTime('', $total, $formatted);
-                $output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
-                $output .= '<br />';
-                $output .= '<h5>Performance scale (from best to worse)</h5>';
-                $output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
-                $output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
-                $output .= '<span style="color:limegreen">Like...groovy!</span><br />';
-                $output .= '<span style="color:gold">Ruh Oh</span><br />';
-                $output .= '<span style="color:darkorange">Zoinks!</span><br />';
-                $output .= '<span style="color:red">Like...HEEELLLP</span><br />';
-            }
-        }
-        if (! empty(Benchmark::$memory_usage)) {
-            $output .= $formatted
-                ? '<h5>Memory</h5>'
-                : "\nMemory";
-            foreach (Benchmark::$memory_usage as $label => $memory_usage) {
-                $output .= $formatted
-                    ? '<br />'
-                    : "\n";
-                $output .= "{$memory_usage} : {$label}";
-            }
-        }
-        if (empty($output)) {
-            return '';
-        }
-        $output = $formatted
-            ? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
-              . (is_admin()
-                ? ' margin:2em 2em 2em 180px;'
-                : ' margin:2em;')
-              . ' padding:2em;">'
-              . '<h4>BENCHMARKING</h4>'
-              . $output
-              . '</div>'
-            : $output;
-        return $output;
-    }
-
-
-
-    /**
-     * @param bool $echo
-     * @param bool $formatted
-     * @return string
-     */
-    public static function displayResults($echo = true, $formatted = true)
-    {
-        $results = Benchmark::generateResults($formatted);
-        if ($echo) {
-            echo $results;
-            $results = '';
-        }
-        return $results;
-    }
-
-
-
-    /**
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     */
-    public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
-    {
-        $filepath = ! empty($filepath) && is_readable(dirname($filepath))
-            ? $filepath
-            : '';
-        if( empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
-        }
-        file_put_contents(
-            $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
-            $append ? FILE_APPEND | LOCK_EX : LOCK_EX
-        );
-    }
-
-
-
-    /**
-     * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
-     *
-     * @param int $size
-     * @return string
-     */
-    public static function convert($size)
-    {
-        $unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
-        return round(
-            $size / pow(1024, $i = floor(log($size, 1024))),
-            2
-        ) . ' ' . $unit[absint($i)];
-    }
-
-
-
-    /**
-     * @param string $timer_name
-     * @param float  $total_time
-     * @param bool   $formatted
-     * @return string
-     */
-    public static function formatTime($timer_name, $total_time, $formatted = true)
-    {
-        $total_time *= 1000;
-        switch ($total_time) {
-            case $total_time > 12500 :
-                $color = 'red';
-                $bold = 'bold';
-                break;
-            case $total_time > 2500 :
-                $color = 'darkorange';
-                $bold = 'bold';
-                break;
-            case $total_time > 500 :
-                $color = 'gold';
-                $bold = 'bold';
-                break;
-            case $total_time > 100 :
-                $color = 'limegreen';
-                $bold = 'normal';
-                break;
-            case $total_time > 20 :
-                $color = 'deepskyblue';
-                $bold = 'normal';
-                break;
-            default :
-                $color = 'mediumpurple';
-                $bold = 'normal';
-                break;
-        }
-        return $formatted
-            ? '<span style="min-width: 10px; margin:0 1em; color:'
-               . $color
-               . '; font-weight:'
-               . $bold
-               . '; font-size:1.2em;">'
-               . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
-               . '</span> '
-               . $timer_name
-            :  str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
-    }
+	/**
+	 * array containing the start time for the timers
+	 */
+	private static $start_times;
+
+	/**
+	 * array containing all the timer'd times, which can be outputted via show_times()
+	 */
+	private static $times = array();
+
+	/**
+	 * @var array
+	 */
+	protected static $memory_usage = array();
+
+
+
+	/**
+	 * whether to benchmark code or not
+	 */
+	public static function doNotRun()
+	{
+		return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
+	}
+
+
+
+	/**
+	 * resetTimes
+	 */
+	public static function resetTimes()
+	{
+		Benchmark::$times = array();
+	}
+
+
+
+	/**
+	 * Add Benchmark::startTimer() before a block of code you want to measure the performance of
+	 *
+	 * @param null $timer_name
+	 */
+	public static function startTimer($timer_name = null)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		Benchmark::$start_times[$timer_name] = microtime(true);
+	}
+
+
+
+	/**
+	 * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
+	 *
+	 * @param string $timer_name
+	 */
+	public static function stopTimer($timer_name = '')
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		if (isset(Benchmark::$start_times[$timer_name])) {
+			$start_time = Benchmark::$start_times[$timer_name];
+			unset(Benchmark::$start_times[$timer_name]);
+		} else {
+			$start_time = array_pop(Benchmark::$start_times);
+		}
+		Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
+	}
+
+
+
+	/**
+	 * Measure the memory usage by PHP so far.
+	 *
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @param bool    $formatted
+	 * @return void
+	 */
+	public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$memory_used = Benchmark::convert(memory_get_usage(true));
+		Benchmark::$memory_usage[$label] = $memory_used;
+		if ($output_now) {
+			echo $formatted
+				? "<br>{$label} : {$memory_used}"
+				: "\n {$label} : {$memory_used}";
+		}
+	}
+
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param bool $formatted
+	 * @return void
+	 */
+	public static function displayResultsAtShutdown($formatted = true)
+	{
+		add_action(
+			'shutdown',
+			function () use ($formatted) {
+				Benchmark::displayResults(true, $formatted);
+			}
+		);
+	}
+
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 * @return void
+	 */
+	public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
+	{
+		add_action(
+			'shutdown',
+			function () use ($filepath, $formatted, $append) {
+				Benchmark::writeResultsToFile($filepath, $formatted, $append);
+			}
+		);
+	}
+
+
+
+	/**
+	 * @param bool $formatted
+	 * @return string
+	 */
+	private static function generateResults($formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return '';
+		}
+		$output = '';
+		if (! empty(Benchmark::$times)) {
+			$total = 0;
+			$output .= $formatted
+				? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
+				: '';
+			foreach (Benchmark::$times as $timer_name => $total_time) {
+				$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
+				$output .= $formatted ? '<br />'  : "\n";
+				$total += $total_time;
+			}
+			if($formatted) {
+				$output .= '<br />';
+				$output .= '<h4>TOTAL TIME</h4>';
+				$output .= Benchmark::formatTime('', $total, $formatted);
+				$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
+				$output .= '<br />';
+				$output .= '<h5>Performance scale (from best to worse)</h5>';
+				$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
+				$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
+				$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
+				$output .= '<span style="color:gold">Ruh Oh</span><br />';
+				$output .= '<span style="color:darkorange">Zoinks!</span><br />';
+				$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
+			}
+		}
+		if (! empty(Benchmark::$memory_usage)) {
+			$output .= $formatted
+				? '<h5>Memory</h5>'
+				: "\nMemory";
+			foreach (Benchmark::$memory_usage as $label => $memory_usage) {
+				$output .= $formatted
+					? '<br />'
+					: "\n";
+				$output .= "{$memory_usage} : {$label}";
+			}
+		}
+		if (empty($output)) {
+			return '';
+		}
+		$output = $formatted
+			? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
+			  . (is_admin()
+				? ' margin:2em 2em 2em 180px;'
+				: ' margin:2em;')
+			  . ' padding:2em;">'
+			  . '<h4>BENCHMARKING</h4>'
+			  . $output
+			  . '</div>'
+			: $output;
+		return $output;
+	}
+
+
+
+	/**
+	 * @param bool $echo
+	 * @param bool $formatted
+	 * @return string
+	 */
+	public static function displayResults($echo = true, $formatted = true)
+	{
+		$results = Benchmark::generateResults($formatted);
+		if ($echo) {
+			echo $results;
+			$results = '';
+		}
+		return $results;
+	}
+
+
+
+	/**
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 */
+	public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
+	{
+		$filepath = ! empty($filepath) && is_readable(dirname($filepath))
+			? $filepath
+			: '';
+		if( empty($filepath)) {
+			$filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+		}
+		file_put_contents(
+			$filepath,
+			"\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+			$append ? FILE_APPEND | LOCK_EX : LOCK_EX
+		);
+	}
+
+
+
+	/**
+	 * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
+	 *
+	 * @param int $size
+	 * @return string
+	 */
+	public static function convert($size)
+	{
+		$unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
+		return round(
+			$size / pow(1024, $i = floor(log($size, 1024))),
+			2
+		) . ' ' . $unit[absint($i)];
+	}
+
+
+
+	/**
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @param bool   $formatted
+	 * @return string
+	 */
+	public static function formatTime($timer_name, $total_time, $formatted = true)
+	{
+		$total_time *= 1000;
+		switch ($total_time) {
+			case $total_time > 12500 :
+				$color = 'red';
+				$bold = 'bold';
+				break;
+			case $total_time > 2500 :
+				$color = 'darkorange';
+				$bold = 'bold';
+				break;
+			case $total_time > 500 :
+				$color = 'gold';
+				$bold = 'bold';
+				break;
+			case $total_time > 100 :
+				$color = 'limegreen';
+				$bold = 'normal';
+				break;
+			case $total_time > 20 :
+				$color = 'deepskyblue';
+				$bold = 'normal';
+				break;
+			default :
+				$color = 'mediumpurple';
+				$bold = 'normal';
+				break;
+		}
+		return $formatted
+			? '<span style="min-width: 10px; margin:0 1em; color:'
+			   . $color
+			   . '; font-weight:'
+			   . $bold
+			   . '; font-size:1.2em;">'
+			   . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
+			   . '</span> '
+			   . $timer_name
+			:  str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
+	}
 
 
 

Spacing +10 added lines, -10 removed lines

@@ -126,7 +126,7 @@ 
     {
         add_action(
             'shutdown',
-            function () use ($formatted) {
+            function() use ($formatted) {
                 Benchmark::displayResults(true, $formatted);
             }
         );
@@ -146,7 +146,7 @@ 
     {
         add_action(
             'shutdown',
-            function () use ($filepath, $formatted, $append) {
+            function() use ($filepath, $formatted, $append) {
                 Benchmark::writeResultsToFile($filepath, $formatted, $append);
             }
         );
@@ -164,17 +164,17 @@ 
             return '';
         }
         $output = '';
-        if (! empty(Benchmark::$times)) {
+        if ( ! empty(Benchmark::$times)) {
             $total = 0;
             $output .= $formatted
                 ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
                 : '';
             foreach (Benchmark::$times as $timer_name => $total_time) {
                 $output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
-                $output .= $formatted ? '<br />'  : "\n";
+                $output .= $formatted ? '<br />' : "\n";
                 $total += $total_time;
             }
-            if($formatted) {
+            if ($formatted) {
                 $output .= '<br />';
                 $output .= '<h4>TOTAL TIME</h4>';
                 $output .= Benchmark::formatTime('', $total, $formatted);
@@ -189,7 +189,7 @@ 
                 $output .= '<span style="color:red">Like...HEEELLLP</span><br />';
             }
         }
-        if (! empty(Benchmark::$memory_usage)) {
+        if ( ! empty(Benchmark::$memory_usage)) {
             $output .= $formatted
                 ? '<h5>Memory</h5>'
                 : "\nMemory";
@@ -245,12 +245,12 @@ 
         $filepath = ! empty($filepath) && is_readable(dirname($filepath))
             ? $filepath
             : '';
-        if( empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+        if (empty($filepath)) {
+            $filepath = EVENT_ESPRESSO_UPLOAD_DIR.'logs/benchmarking-'.date('Y-m-d').'.html';
         }
         file_put_contents(
             $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+            "\n".date('Y-m-d H:i:s').Benchmark::generateResults($formatted),
             $append ? FILE_APPEND | LOCK_EX : LOCK_EX
         );
     }
@@ -269,7 +269,7 @@ 
         return round(
             $size / pow(1024, $i = floor(log($size, 1024))),
             2
-        ) . ' ' . $unit[absint($i)];
+        ).' '.$unit[absint($i)];
     }
 
 

core/domain/services/registration/CopyRegistrationService.php

Indentation +140 added lines, -140 removed lines

@@ -12,7 +12,7 @@ 
 use RuntimeException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -30,145 +30,145 @@ 
 {
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EntityNotFoundException
-     * @throws RuntimeException
-     * @throws EE_Error
-     */
-    public function copyRegistrationDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        // copy attendee
-        $target_registration->set_attendee_id($registration_to_copy->attendee_ID());
-        $target_registration->updateStatusBasedOnTotalPaid(false);
-        $target_registration->save();
-        // get answers to previous reg questions
-        $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
-        // get questions to new event reg form
-        $new_event       = $target_registration->event();
-        $question_groups = $new_event->question_groups(
-            array(
-                array(
-                    'Event.EVT_ID'                     => $new_event->ID(),
-                    'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(),
-                ),
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof \EE_Question_Group) {
-                foreach ($question_group->questions() as $question) {
-                    if ($question instanceof EE_Question) {
-                        $this->generateNewAnswer(
-                            $question,
-                            $target_registration,
-                            $answers
-                        );
-                    }
-                }
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @param EE_Answer[] $answers
-     * @return array
-     * @throws EE_Error
-     */
-    protected function reindexAnswersByQuestionId(array $answers)
-    {
-        $reindexed_answers = array();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
-            }
-        }
-        return $reindexed_answers;
-    }
-
-
-
-    /**
-     * @param EE_Question      $question
-     * @param EE_Registration  $registration
-     * @param                  $previous_answers
-     * @return EE_Answer
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function generateNewAnswer(
-        EE_Question $question,
-        EE_Registration $registration,
-        $previous_answers
-    ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
-            : '';
-        $new_answer       = EE_Answer::new_instance(
-            array(
-                'QST_ID'    => $question->ID(),
-                'REG_ID'    => $registration->ID(),
-                'ANS_value' => $old_answer_value,
-            )
-        );
-        if ( ! $new_answer instanceof EE_Answer) {
-            throw new UnexpectedEntityException($new_answer, 'EE_Answer');
-        }
-        $new_answer->save();
-        return $new_answer;
-    }
-
-
-
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function copyPaymentDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        $previous_payments = $registration_to_copy->registration_payments();
-        foreach ($previous_payments as $previous_payment) {
-            if (
-                $previous_payment instanceof \EE_Registration_Payment
-                && $previous_payment->payment() instanceof \EE_Payment
-                && $previous_payment->payment()->is_approved()
-            ) {
-                $new_registration_payment = \EE_Registration_Payment::new_instance(
-                    array(
-                        'REG_ID'     => $target_registration->ID(),
-                        'PAY_ID'     => $previous_payment->ID(),
-                        'RPY_amount' => $previous_payment->amount(),
-                    )
-                );
-                if ( ! $new_registration_payment instanceof \EE_Registration_Payment) {
-                    throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
-                }
-                $new_registration_payment->save();
-                $target_registration->set_paid($previous_payment->amount());
-                $target_registration->save();
-                // if new reg payment is good, then set old reg payment amount to zero
-                $previous_payment->set_amount(0);
-                $previous_payment->save();
-                $registration_to_copy->set_paid(0);
-                $registration_to_copy->save();
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EntityNotFoundException
+	 * @throws RuntimeException
+	 * @throws EE_Error
+	 */
+	public function copyRegistrationDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		// copy attendee
+		$target_registration->set_attendee_id($registration_to_copy->attendee_ID());
+		$target_registration->updateStatusBasedOnTotalPaid(false);
+		$target_registration->save();
+		// get answers to previous reg questions
+		$answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
+		// get questions to new event reg form
+		$new_event       = $target_registration->event();
+		$question_groups = $new_event->question_groups(
+			array(
+				array(
+					'Event.EVT_ID'                     => $new_event->ID(),
+					'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(),
+				),
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof \EE_Question_Group) {
+				foreach ($question_group->questions() as $question) {
+					if ($question instanceof EE_Question) {
+						$this->generateNewAnswer(
+							$question,
+							$target_registration,
+							$answers
+						);
+					}
+				}
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @param EE_Answer[] $answers
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function reindexAnswersByQuestionId(array $answers)
+	{
+		$reindexed_answers = array();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				$reindexed_answers[ $answer->question_ID() ] = $answer->value();
+			}
+		}
+		return $reindexed_answers;
+	}
+
+
+
+	/**
+	 * @param EE_Question      $question
+	 * @param EE_Registration  $registration
+	 * @param                  $previous_answers
+	 * @return EE_Answer
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function generateNewAnswer(
+		EE_Question $question,
+		EE_Registration $registration,
+		$previous_answers
+	) {
+		$old_answer_value = isset($previous_answers[ $question->ID() ])
+			? $previous_answers[ $question->ID() ]
+			: '';
+		$new_answer       = EE_Answer::new_instance(
+			array(
+				'QST_ID'    => $question->ID(),
+				'REG_ID'    => $registration->ID(),
+				'ANS_value' => $old_answer_value,
+			)
+		);
+		if ( ! $new_answer instanceof EE_Answer) {
+			throw new UnexpectedEntityException($new_answer, 'EE_Answer');
+		}
+		$new_answer->save();
+		return $new_answer;
+	}
+
+
+
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function copyPaymentDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		$previous_payments = $registration_to_copy->registration_payments();
+		foreach ($previous_payments as $previous_payment) {
+			if (
+				$previous_payment instanceof \EE_Registration_Payment
+				&& $previous_payment->payment() instanceof \EE_Payment
+				&& $previous_payment->payment()->is_approved()
+			) {
+				$new_registration_payment = \EE_Registration_Payment::new_instance(
+					array(
+						'REG_ID'     => $target_registration->ID(),
+						'PAY_ID'     => $previous_payment->ID(),
+						'RPY_amount' => $previous_payment->amount(),
+					)
+				);
+				if ( ! $new_registration_payment instanceof \EE_Registration_Payment) {
+					throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
+				}
+				$new_registration_payment->save();
+				$target_registration->set_paid($previous_payment->amount());
+				$target_registration->save();
+				// if new reg payment is good, then set old reg payment amount to zero
+				$previous_payment->set_amount(0);
+				$previous_payment->save();
+				$registration_to_copy->set_paid(0);
+				$registration_to_copy->save();
+			}
+		}
+		return true;
+	}
 
 
 }

Spacing +3 added lines, -3 removed lines

@@ -88,7 +88,7 @@ 
         $reindexed_answers = array();
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
+                $reindexed_answers[$answer->question_ID()] = $answer->value();
             }
         }
         return $reindexed_answers;
@@ -109,8 +109,8 @@ 
         EE_Registration $registration,
         $previous_answers
     ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
+        $old_answer_value = isset($previous_answers[$question->ID()])
+            ? $previous_answers[$question->ID()]
             : '';
         $new_answer       = EE_Answer::new_instance(
             array(

core/libraries/messages/EE_Messages_Generator.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -459,7 +459,7 @@ 
      * there's a single shared message template group among all the events.  Otherwise it returns null.
      *
      * @param array $event_ids
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -495,7 +495,7 @@ 
     /**
      * Retrieves the global message template group for the current messenger and message type.
      *
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
@@ -641,7 +641,7 @@ 
      * @param EE_Messages_Addressee     $recipient
      * @param array                     $templates formatted array of templates used for parsing data.
      * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
+     * @return EE_Message
      * @throws EE_Error
      */
     protected function _setup_message_object(

Indentation +966 added lines, -966 removed lines

@@ -13,970 +13,970 @@
 {
 
 
-    /**
-     * @type EE_Messages_Data_Handler_Collection
-     */
-    protected $_data_handler_collection;
-
-    /**
-     * @type  EE_Message_Template_Group_Collection
-     */
-    protected $_template_collection;
-
-    /**
-     * This will hold the data handler for the current EE_Message being generated.
-     *
-     * @type EE_Messages_incoming_data
-     */
-    protected $_current_data_handler;
-
-    /**
-     * This holds the EE_Messages_Queue that contains the messages to generate.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_generation_queue;
-
-    /**
-     * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_ready_queue;
-
-    /**
-     * This is a container for any error messages that get created through the generation
-     * process.
-     *
-     * @type array
-     */
-    protected $_error_msg = array();
-
-    /**
-     * Flag used to set when the current EE_Message in the generation queue has been verified.
-     *
-     * @type bool
-     */
-    protected $_verified = false;
-
-    /**
-     * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_messenger
-     */
-    protected $_current_messenger;
-
-    /**
-     * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_message_type
-     */
-    protected $_current_message_type;
-
-    /**
-     * @type EEH_Parse_Shortcodes
-     */
-    protected $_shortcode_parser;
-
-
-    /**
-     * @param EE_Messages_Queue                     $generation_queue
-     * @param \EE_Messages_Queue                    $ready_queue
-     * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
-     * @param \EE_Message_Template_Group_Collection $template_collection
-     * @param \EEH_Parse_Shortcodes                 $shortcode_parser
-     */
-    public function __construct(
-        EE_Messages_Queue $generation_queue,
-        EE_Messages_Queue $ready_queue,
-        EE_Messages_Data_Handler_Collection $data_handler_collection,
-        EE_Message_Template_Group_Collection $template_collection,
-        EEH_Parse_Shortcodes $shortcode_parser
-    ) {
-        $this->_generation_queue        = $generation_queue;
-        $this->_ready_queue             = $ready_queue;
-        $this->_data_handler_collection = $data_handler_collection;
-        $this->_template_collection     = $template_collection;
-        $this->_shortcode_parser        = $shortcode_parser;
-    }
-
-
-    /**
-     * @return EE_Messages_Queue
-     */
-    public function generation_queue()
-    {
-        return $this->_generation_queue;
-    }
-
-
-    /**
-     *  This iterates through the provided queue and generates the EE_Message objects.
-     *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
-     *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
-     *  for the caller to decide what to do with it.
-     *
-     * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
-     * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate($save = true)
-    {
-        //iterate through the messages in the queue, generate, and add to new queue.
-        $this->_generation_queue->get_message_repository()->rewind();
-        while ($this->_generation_queue->get_message_repository()->valid()) {
-            //reset "current" properties
-            $this->_reset_current_properties();
-
-            /** @type EE_Message $msg */
-            $msg = $this->_generation_queue->get_message_repository()->current();
-
-            /**
-             * need to get the next object and capture it for setting manually after deletes.  The reason is that when
-             * an object is removed from the repo then valid for the next object will fail.
-             */
-            $this->_generation_queue->get_message_repository()->next();
-            $next_msg = $this->_generation_queue->get_message_repository()->current();
-            //restore pointer to current item
-            $this->_generation_queue->get_message_repository()->set_current($msg);
-
-            //skip and delete if the current $msg is NOT incomplete (queued for generation)
-            if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
-                //we keep this item in the db just remove from the repo.
-                $this->_generation_queue->get_message_repository()->remove($msg);
-                //next item
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            if ($this->_verify()) {
-                //let's get generating!
-                $this->_generate();
-            }
-
-            //don't persist debug_only messages if the messages system is not in debug mode.
-            if ($msg->STS_ID() === EEM_Message::status_debug_only
-                && ! EEM_Message::debug()
-            ) {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_debug_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $this->_generation_queue->get_message_repository()->delete();
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            //if there are error messages then let's set the status and the error message.
-            if ($this->_error_msg) {
-                //if the status is already debug only, then let's leave it at that.
-                if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
-                    $msg->set_STS_ID(EEM_Message::status_failed);
-                }
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__processing_failed_message',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $msg->set_error_message(
-                    esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
-                    . "\n"
-                    . implode("\n", $this->_error_msg)
-                );
-                $msg->set_modified(time());
-            } else {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                //remove from db
-                $this->_generation_queue->get_message_repository()->delete();
-            }
-            //next item
-            $this->_generation_queue->get_message_repository()->set_current($next_msg);
-        }
-
-        //generation queue is ALWAYS saved to record any errors in the generation process.
-        $this->_generation_queue->save();
-
-        /**
-         * save _ready_queue if flag set.
-         * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
-         * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
-         * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
-         * irrelevant.
-         */
-        if ($save) {
-            $this->_ready_queue->save();
-        }
-
-        //final reset of properties
-        $this->_reset_current_properties();
-
-        return $this->_ready_queue;
-    }
-
-
-    /**
-     * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
-     * in the generation queue.
-     */
-    protected function _reset_current_properties()
-    {
-        $this->_verified = false;
-        //make sure any _data value in the current message type is reset
-        if ($this->_current_message_type instanceof EE_message_type) {
-            $this->_current_message_type->reset_data();
-        }
-        $this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
-    }
-
-
-    /**
-     * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
-     * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
-     * _generating_queue.
-     *
-     * @return bool Whether the message was successfully generated or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _generate()
-    {
-        //double check verification has run and that everything is ready to work with (saves us having to validate
-        // everything again).
-        if (! $this->_verified) {
-            return false; //get out because we don't have a valid setup to work with.
-        }
-
-
-        try {
-            $addressees = $this->_current_message_type->get_addressees(
-                $this->_current_data_handler,
-                $this->_generation_queue->get_message_repository()->current()->context()
-            );
-        } catch (EE_Error $e) {
-            $this->_error_msg[] = $e->getMessage();
-            return false;
-        }
-
-
-        //if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
-            do_action(
-                'AHEE__EE_Messages_Generator___generate__invalid_addressees',
-                $this->_generation_queue->get_message_repository()->current(),
-                $addressees,
-                $this->_current_messenger,
-                $this->_current_message_type,
-                $this->_current_data_handler
-            );
-            $this->_generation_queue->get_message_repository()->current()->set_STS_ID(
-                EEM_Message::status_debug_only
-            );
-            $this->_error_msg[] = esc_html__(
-                'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        $message_template_group = $this->_get_message_template_group();
-
-        //in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        //get formatted templates for using to parse and setup EE_Message objects.
-        $templates = $this->_get_templates($message_template_group);
-
-
-        //setup new EE_Message objects (and add to _ready_queue)
-        return $this->_assemble_messages($addressees, $templates, $message_template_group);
-    }
-
-
-    /**
-     * Retrieves the message template group being used for generating messages.
-     * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_message_template_group()
-    {
-        //first see if there is a specific message template group requested (current message in the queue has a specific
-        //GRP_ID
-        $message_template_group = $this->_specific_message_template_group_from_queue();
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //get event_ids from the datahandler so we can check to see if there's already a message template group for them
-        //in the collection.
-        $event_ids              = $this->_get_event_ids_from_current_data_handler();
-        $message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                $event_ids
-            )
-        );
-
-        //if we have a message template group then no need to hit the database, just return it.
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //okay made it here, so let's get the global group first for this messenger and message type to ensure
-        //there is no override set.
-        $global_message_template_group =
-            $this->_get_global_message_template_group_for_current_messenger_and_message_type();
-
-        if ($global_message_template_group instanceof EE_Message_Template_Group
-            && $global_message_template_group->get('MTP_is_override')
-        ) {
-            return $global_message_template_group;
-        }
-
-        //if we're still here, that means there was no message template group for the events in the collection and
-        //the global message template group for the messenger and message type is not set for override.  So next step is
-        //to see if there is a common shared custom message template group for this set of events.
-        $message_template_group = $this->_get_shared_message_template_for_events($event_ids);
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
-        //So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
-        //and return it.
-        if ($global_message_template_group instanceof EE_Message_Template_Group) {
-            $this->_template_collection->add(
-                $global_message_template_group,
-                $event_ids
-            );
-            return $global_message_template_group;
-        }
-
-        //if we land here that means there's NO active message template group for this set.
-        //TODO this will be a good target for some optimization down the road.  Whenever there is no active message
-        //template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
-        //this should likely bit hit rarely enough that it's not a significant issue.
-        return null;
-    }
-
-
-    /**
-     * This checks the current message in the queue and determines if there is a specific Message Template Group
-     * requested for that message.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _specific_message_template_group_from_queue()
-    {
-        //is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
-        //so let's use that.
-        $GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
-
-        if ($GRP_ID) {
-            //attempt to retrieve from repo first
-            $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  //got it!
-            }
-
-            //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
-            //is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add($message_template_group);
-                return $message_template_group;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether the event ids passed in all share the same message template group for the current message type
-     * and messenger.
-     *
-     * @param array $event_ids
-     * @return bool true means they DO share the same message template group, false means they don't.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
-    {
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[$event['ID']] = $event['ID'];
-        }
-        $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
-            array(
-                array(
-                    'Event.EVT_ID'           => array('IN', $event_ids),
-                    'MTP_messenger'    => $this->_current_messenger->name,
-                    'MTP_message_type' => $this->_current_message_type->name,
-                ),
-            ),
-            'GRP_ID',
-            true
-        );
-        return $count_of_message_template_groups === 1;
-    }
-
-
-    /**
-     * This will get the shared message template group for events that are in the current data handler but ONLY if
-     * there's a single shared message template group among all the events.  Otherwise it returns null.
-     *
-     * @param array $event_ids
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_shared_message_template_for_events(array $event_ids)
-    {
-        $message_template_group = null;
-        if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'Event.EVT_ID'           => array('IN', $event_ids),
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                    ),
-                    'group_by' => 'GRP_ID',
-                )
-            );
-            //store this in the collection if its valid
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $message_template_group,
-                    $event_ids
-                );
-            }
-        }
-        return $message_template_group;
-    }
-
-
-    /**
-     * Retrieves the global message template group for the current messenger and message type.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_global_message_template_group_for_current_messenger_and_message_type()
-    {
-        //first check the collection (we use an array with 0 in it to represent global groups).
-        $global_message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                array(0)
-            )
-        );
-
-        //if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
-            $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-            //if we have a group, add it to the collection.
-            if ($global_message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $global_message_template_group,
-                    array(0)
-                );
-            }
-        }
-        return $global_message_template_group;
-    }
-
-
-    /**
-     * Returns an array of event ids for all the events within the current data handler.
-     *
-     * @return array
-     */
-    protected function _get_event_ids_from_current_data_handler()
-    {
-        $event_ids = array();
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[$event['ID']] = $event['ID'];
-        }
-        return $event_ids;
-    }
-
-
-    /**
-     *  Retrieves formatted array of template information for each context specific to the given
-     *  EE_Message_Template_Group
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @return array The returned array is in this structure:
-     *                          array(
-     *                          'field_name' => array(
-     *                          'context' => 'content'
-     *                          )
-     *                          )
-     * @throws EE_Error
-     */
-    protected function _get_templates(EE_Message_Template_Group $message_template_group)
-    {
-        $templates         = array();
-        $context_templates = $message_template_group->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
-                    continue;
-                }
-                $templates[$template_field][$context] = $template_obj->get('MTP_content');
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Assembles new fully generated EE_Message objects and adds to _ready_queue
-     *
-     * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
-     *                                               context.
-     * @param array                     $templates   formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
-     *                                               method will attempt to generate ALL EE_Message objects and add to
-     *                                               the _ready_queue.  Successfully generated messages get added to the
-     *                                               queue with EEM_Message::status_idle, unsuccessfully generated
-     *                                               messages will get added to the queue as EEM_Message::status_failed.
-     *                                               Very rarely should "false" be returned from this method.
-     * @throws EE_Error
-     */
-    protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
-    {
-
-        //if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to assemble messages because there are no templates retrieved for generating the messages with',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        //We use this as the counter for generated messages because don't forget we may be executing this inside of a
-        //generation_queue.  So _ready_queue may have generated EE_Message objects already.
-        $generated_count = 0;
-        foreach ($addressees as $context => $recipients) {
-            foreach ($recipients as $recipient) {
-                $message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
-                if ($message instanceof EE_Message) {
-                    $this->_ready_queue->add(
-                        $message,
-                        array(),
-                        $this->_generation_queue->get_message_repository()->is_preview(),
-                        $this->_generation_queue->get_message_repository()->is_test_send()
-                    );
-                    $generated_count++;
-                }
-
-                //if the current MSG being generated is for a test send then we'll only use ONE message in the
-                // generation.
-                if ($this->_generation_queue->get_message_repository()->is_test_send()) {
-                    break 2;
-                }
-            }
-        }
-
-        //if there are no generated messages then something else fatal went wrong.
-        return $generated_count > 0;
-    }
-
-
-    /**
-     * @param string                    $context   The context for the generated message.
-     * @param EE_Messages_Addressee     $recipient
-     * @param array                     $templates formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
-     * @throws EE_Error
-     */
-    protected function _setup_message_object(
-        $context,
-        EE_Messages_Addressee $recipient,
-        $templates,
-        EE_Message_Template_Group $message_template_group
-    ) {
-        //stuff we already know
-        $transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
-        $transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
-            ? $this->_current_data_handler->txn->ID()
-            : $transaction_id;
-        $message_fields = array(
-            'GRP_ID'           => $message_template_group->ID(),
-            'TXN_ID'           => $transaction_id,
-            'MSG_messenger'    => $this->_current_messenger->name,
-            'MSG_message_type' => $this->_current_message_type->name,
-            'MSG_context'      => $context,
-        );
-
-        //recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
-        // the info from the att_obj found in the EE_Messages_Addressee object.
-        if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
-            $message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
-                ? $recipient->att_obj->ID()
-                : 0;
-            $message_fields['MSG_recipient_type'] = 'Attendee';
-        } else {
-            $message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
-            $message_fields['MSG_recipient_type'] = $recipient->recipient_type;
-        }
-        $message = EE_Message_Factory::create($message_fields);
-
-        //grab valid shortcodes for shortcode parser
-        $mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
-        $m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
-
-        //if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
-        if ((
-                (
-                    empty($templates['to'][$context])
-                    && ! $this->_current_messenger->allow_empty_to_field()
-                )
-                || ! $message_template_group->is_context_active($context)
-            )
-            && ! $this->_generation_queue->get_message_repository()->is_preview()
-        ) {
-            //we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
-            //field.
-            return false;
-        }
-        $error_msg = array();
-        foreach ($templates as $field => $field_context) {
-            $error_msg = array();
-            //let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[$context];
-            //merge in valid shortcodes for the field.
-            $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
-            if (isset($templates[$field][$context])) {
-                //prefix field.
-                $column_name = 'MSG_' . $field;
-                try {
-                    $content = $this->_shortcode_parser->parse_message_template(
-                        $templates[$field][$context],
-                        $recipient,
-                        $shortcodes,
-                        $this->_current_message_type,
-                        $this->_current_messenger,
-                        $message
-                    );
-                    $message->set_field_or_extra_meta($column_name, $content);
-                } catch (EE_Error $e) {
-                    $error_msg[] = sprintf(
-                        esc_html__(
-                            'There was a problem generating the content for the field %s: %s',
-                            'event_espresso'
-                        ),
-                        $field,
-                        $e->getMessage()
-                    );
-                    $message->set_STS_ID(EEM_Message::status_failed);
-                }
-            }
-        }
-
-        if ($message->STS_ID() === EEM_Message::status_failed) {
-            $error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
-                         . "\n"
-                         . implode("\n", $error_msg);
-            $message->set_error_message($error_msg);
-        } else {
-            $message->set_STS_ID(EEM_Message::status_idle);
-        }
-        return $message;
-    }
-
-
-    /**
-     * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
-     * error message if either is missing.
-     *
-     * @return bool true means there were no errors, false means there were errors.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _verify()
-    {
-        //reset error message to an empty array.
-        $this->_error_msg = array();
-        $valid            = true;
-        $valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
-        $valid            = $valid ? $this->_validate_and_setup_data() : $valid;
-
-        //set the verified flag so we know everything has been validated.
-        $this->_verified = $valid;
-
-        return $valid;
-    }
-
-
-    /**
-     * This accepts an array and validates that it is an array indexed by context with each value being an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
-     * @return bool
-     */
-    protected function _valid_addressees($addressees)
-    {
-        if (! $addressees || ! is_array($addressees)) {
-            return false;
-        }
-
-        foreach ($addressees as $addressee_array) {
-            foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
-     * queue. This process sets error messages if something is wrong.
-     *
-     * @return bool   true is if there are no errors.  false is if there is.
-     */
-    protected function _validate_messenger_and_message_type()
-    {
-
-        //first are there any existing error messages?  If so then return.
-        if ($this->_error_msg) {
-            return false;
-        }
-        /** @type EE_Message $message */
-        $message = $this->_generation_queue->get_message_repository()->current();
-        try {
-            $this->_current_messenger = $message->valid_messenger(true)
-                ? $message->messenger_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-        try {
-            $this->_current_message_type = $message->valid_message_type(true)
-                ? $message->message_type_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-
-        /**
-         * Check if there is any generation data, but only if this is not for a preview.
-         */
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
-            && (
-                ! $this->_generation_queue->get_message_repository()->is_preview()
-                && $this->_generation_queue->get_message_repository()->get_data_handler()
-                   !== 'EE_Messages_Preview_incoming_data'
-            )
-        ) {
-            $this->_error_msg[] = esc_html__(
-                'There is no generation data for this message. Unable to generate.',
-                'event_espresso'
-            );
-        }
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * This method retrieves the expected data handler for the message type and validates the generation data for that
-     * data handler.
-     *
-     * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _validate_and_setup_data()
-    {
-
-        //First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
-        //be used anyways.
-        if ($this->_error_msg) {
-            return false;
-        }
-
-        $generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
-
-        /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually*/
-        $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
-            ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
-
-        //If this EE_Message is for a preview, then let's switch out to the preview data handler.
-        if ($this->_generation_queue->get_message_repository()->is_preview()) {
-            $data_handler_class_name = 'EE_Messages_Preview_incoming_data';
-        }
-
-        //First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
-            $this->_error_msg[] = sprintf(
-                esc_html__(
-                    'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
-                    'event_espresso'
-                ),
-                'EE_Messages_incoming_data',
-                $data_handler_class_name
-            );
-            return false;
-        }
-
-        //convert generation_data for data_handler_instantiation.
-        $generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
-
-        //note, this may set error messages as well.
-        $this->_set_data_handler($generation_data, $data_handler_class_name);
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
-     * adds it to the _data repository.
-     *
-     * @param mixed  $generating_data           This is data expected by the instantiated data handler.
-     * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
-     *                                          instantiated.
-     * @return void .
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_data_handler($generating_data, $data_handler_class_name)
-    {
-        //valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
-        //is already a ready data handler in the repository.
-        $this->_current_data_handler = $this->_data_handler_collection->get_by_key(
-            $this->_data_handler_collection->get_key(
-                $data_handler_class_name,
-                $generating_data
-            )
-        );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
-            //no saved data_handler in the repo so let's set one up and add it to the repo.
-            try {
-                $this->_current_data_handler = new $data_handler_class_name($generating_data);
-                $this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
-            } catch (EE_Error $e) {
-                $this->_error_msg[] = $e->get_error();
-            }
-        }
-    }
-
-
-    /**
-     * The queued EE_Message for generation does not save the data used for generation as objects
-     * because serialization of those objects could be problematic if the data is saved to the db.
-     * So this method calls the static method on the associated data_handler for the given message_type
-     * and that preps the data for later instantiation when generating.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $preview Indicate whether this is being used for a preview or not.
-     * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
-     */
-    protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
-    {
-        /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
-        $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        if (! $message_to_generate->valid()) {
-            return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
-        }
-        return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
-    }
-
-
-    /**
-     * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        //prep data
-        $data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
-
-        $message = $message_to_generate->get_EE_Message();
-
-        //is there a GRP_ID in the request?
-        if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
-            $message->set_GRP_ID($GRP_ID);
-        }
-
-        if ($data === false) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                esc_html__(
-                    'Unable to prepare data for persistence to the database.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            //make sure that the data handler is cached on the message as well
-            $data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
-        }
-
-        $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
-    }
+	/**
+	 * @type EE_Messages_Data_Handler_Collection
+	 */
+	protected $_data_handler_collection;
+
+	/**
+	 * @type  EE_Message_Template_Group_Collection
+	 */
+	protected $_template_collection;
+
+	/**
+	 * This will hold the data handler for the current EE_Message being generated.
+	 *
+	 * @type EE_Messages_incoming_data
+	 */
+	protected $_current_data_handler;
+
+	/**
+	 * This holds the EE_Messages_Queue that contains the messages to generate.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_generation_queue;
+
+	/**
+	 * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_ready_queue;
+
+	/**
+	 * This is a container for any error messages that get created through the generation
+	 * process.
+	 *
+	 * @type array
+	 */
+	protected $_error_msg = array();
+
+	/**
+	 * Flag used to set when the current EE_Message in the generation queue has been verified.
+	 *
+	 * @type bool
+	 */
+	protected $_verified = false;
+
+	/**
+	 * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_messenger
+	 */
+	protected $_current_messenger;
+
+	/**
+	 * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_message_type
+	 */
+	protected $_current_message_type;
+
+	/**
+	 * @type EEH_Parse_Shortcodes
+	 */
+	protected $_shortcode_parser;
+
+
+	/**
+	 * @param EE_Messages_Queue                     $generation_queue
+	 * @param \EE_Messages_Queue                    $ready_queue
+	 * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
+	 * @param \EE_Message_Template_Group_Collection $template_collection
+	 * @param \EEH_Parse_Shortcodes                 $shortcode_parser
+	 */
+	public function __construct(
+		EE_Messages_Queue $generation_queue,
+		EE_Messages_Queue $ready_queue,
+		EE_Messages_Data_Handler_Collection $data_handler_collection,
+		EE_Message_Template_Group_Collection $template_collection,
+		EEH_Parse_Shortcodes $shortcode_parser
+	) {
+		$this->_generation_queue        = $generation_queue;
+		$this->_ready_queue             = $ready_queue;
+		$this->_data_handler_collection = $data_handler_collection;
+		$this->_template_collection     = $template_collection;
+		$this->_shortcode_parser        = $shortcode_parser;
+	}
+
+
+	/**
+	 * @return EE_Messages_Queue
+	 */
+	public function generation_queue()
+	{
+		return $this->_generation_queue;
+	}
+
+
+	/**
+	 *  This iterates through the provided queue and generates the EE_Message objects.
+	 *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
+	 *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
+	 *  for the caller to decide what to do with it.
+	 *
+	 * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
+	 * @return EE_Messages_Queue The new queue for holding generated EE_Message objects.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate($save = true)
+	{
+		//iterate through the messages in the queue, generate, and add to new queue.
+		$this->_generation_queue->get_message_repository()->rewind();
+		while ($this->_generation_queue->get_message_repository()->valid()) {
+			//reset "current" properties
+			$this->_reset_current_properties();
+
+			/** @type EE_Message $msg */
+			$msg = $this->_generation_queue->get_message_repository()->current();
+
+			/**
+			 * need to get the next object and capture it for setting manually after deletes.  The reason is that when
+			 * an object is removed from the repo then valid for the next object will fail.
+			 */
+			$this->_generation_queue->get_message_repository()->next();
+			$next_msg = $this->_generation_queue->get_message_repository()->current();
+			//restore pointer to current item
+			$this->_generation_queue->get_message_repository()->set_current($msg);
+
+			//skip and delete if the current $msg is NOT incomplete (queued for generation)
+			if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
+				//we keep this item in the db just remove from the repo.
+				$this->_generation_queue->get_message_repository()->remove($msg);
+				//next item
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			if ($this->_verify()) {
+				//let's get generating!
+				$this->_generate();
+			}
+
+			//don't persist debug_only messages if the messages system is not in debug mode.
+			if ($msg->STS_ID() === EEM_Message::status_debug_only
+				&& ! EEM_Message::debug()
+			) {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_debug_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$this->_generation_queue->get_message_repository()->delete();
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			//if there are error messages then let's set the status and the error message.
+			if ($this->_error_msg) {
+				//if the status is already debug only, then let's leave it at that.
+				if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
+					$msg->set_STS_ID(EEM_Message::status_failed);
+				}
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__processing_failed_message',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$msg->set_error_message(
+					esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
+					. "\n"
+					. implode("\n", $this->_error_msg)
+				);
+				$msg->set_modified(time());
+			} else {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				//remove from db
+				$this->_generation_queue->get_message_repository()->delete();
+			}
+			//next item
+			$this->_generation_queue->get_message_repository()->set_current($next_msg);
+		}
+
+		//generation queue is ALWAYS saved to record any errors in the generation process.
+		$this->_generation_queue->save();
+
+		/**
+		 * save _ready_queue if flag set.
+		 * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
+		 * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
+		 * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
+		 * irrelevant.
+		 */
+		if ($save) {
+			$this->_ready_queue->save();
+		}
+
+		//final reset of properties
+		$this->_reset_current_properties();
+
+		return $this->_ready_queue;
+	}
+
+
+	/**
+	 * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
+	 * in the generation queue.
+	 */
+	protected function _reset_current_properties()
+	{
+		$this->_verified = false;
+		//make sure any _data value in the current message type is reset
+		if ($this->_current_message_type instanceof EE_message_type) {
+			$this->_current_message_type->reset_data();
+		}
+		$this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
+	}
+
+
+	/**
+	 * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
+	 * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
+	 * _generating_queue.
+	 *
+	 * @return bool Whether the message was successfully generated or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _generate()
+	{
+		//double check verification has run and that everything is ready to work with (saves us having to validate
+		// everything again).
+		if (! $this->_verified) {
+			return false; //get out because we don't have a valid setup to work with.
+		}
+
+
+		try {
+			$addressees = $this->_current_message_type->get_addressees(
+				$this->_current_data_handler,
+				$this->_generation_queue->get_message_repository()->current()->context()
+			);
+		} catch (EE_Error $e) {
+			$this->_error_msg[] = $e->getMessage();
+			return false;
+		}
+
+
+		//if no addressees then get out because there is nothing to generation (possible bad data).
+		if (! $this->_valid_addressees($addressees)) {
+			do_action(
+				'AHEE__EE_Messages_Generator___generate__invalid_addressees',
+				$this->_generation_queue->get_message_repository()->current(),
+				$addressees,
+				$this->_current_messenger,
+				$this->_current_message_type,
+				$this->_current_data_handler
+			);
+			$this->_generation_queue->get_message_repository()->current()->set_STS_ID(
+				EEM_Message::status_debug_only
+			);
+			$this->_error_msg[] = esc_html__(
+				'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		$message_template_group = $this->_get_message_template_group();
+
+		//in the unlikely event there is no EE_Message_Template_Group available, get out!
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		//get formatted templates for using to parse and setup EE_Message objects.
+		$templates = $this->_get_templates($message_template_group);
+
+
+		//setup new EE_Message objects (and add to _ready_queue)
+		return $this->_assemble_messages($addressees, $templates, $message_template_group);
+	}
+
+
+	/**
+	 * Retrieves the message template group being used for generating messages.
+	 * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_message_template_group()
+	{
+		//first see if there is a specific message template group requested (current message in the queue has a specific
+		//GRP_ID
+		$message_template_group = $this->_specific_message_template_group_from_queue();
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//get event_ids from the datahandler so we can check to see if there's already a message template group for them
+		//in the collection.
+		$event_ids              = $this->_get_event_ids_from_current_data_handler();
+		$message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				$event_ids
+			)
+		);
+
+		//if we have a message template group then no need to hit the database, just return it.
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//okay made it here, so let's get the global group first for this messenger and message type to ensure
+		//there is no override set.
+		$global_message_template_group =
+			$this->_get_global_message_template_group_for_current_messenger_and_message_type();
+
+		if ($global_message_template_group instanceof EE_Message_Template_Group
+			&& $global_message_template_group->get('MTP_is_override')
+		) {
+			return $global_message_template_group;
+		}
+
+		//if we're still here, that means there was no message template group for the events in the collection and
+		//the global message template group for the messenger and message type is not set for override.  So next step is
+		//to see if there is a common shared custom message template group for this set of events.
+		$message_template_group = $this->_get_shared_message_template_for_events($event_ids);
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
+		//So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
+		//and return it.
+		if ($global_message_template_group instanceof EE_Message_Template_Group) {
+			$this->_template_collection->add(
+				$global_message_template_group,
+				$event_ids
+			);
+			return $global_message_template_group;
+		}
+
+		//if we land here that means there's NO active message template group for this set.
+		//TODO this will be a good target for some optimization down the road.  Whenever there is no active message
+		//template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
+		//this should likely bit hit rarely enough that it's not a significant issue.
+		return null;
+	}
+
+
+	/**
+	 * This checks the current message in the queue and determines if there is a specific Message Template Group
+	 * requested for that message.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _specific_message_template_group_from_queue()
+	{
+		//is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
+		//so let's use that.
+		$GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
+
+		if ($GRP_ID) {
+			//attempt to retrieve from repo first
+			$message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				return $message_template_group;  //got it!
+			}
+
+			//nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
+			//is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add($message_template_group);
+				return $message_template_group;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether the event ids passed in all share the same message template group for the current message type
+	 * and messenger.
+	 *
+	 * @param array $event_ids
+	 * @return bool true means they DO share the same message template group, false means they don't.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
+	{
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[$event['ID']] = $event['ID'];
+		}
+		$count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
+			array(
+				array(
+					'Event.EVT_ID'           => array('IN', $event_ids),
+					'MTP_messenger'    => $this->_current_messenger->name,
+					'MTP_message_type' => $this->_current_message_type->name,
+				),
+			),
+			'GRP_ID',
+			true
+		);
+		return $count_of_message_template_groups === 1;
+	}
+
+
+	/**
+	 * This will get the shared message template group for events that are in the current data handler but ONLY if
+	 * there's a single shared message template group among all the events.  Otherwise it returns null.
+	 *
+	 * @param array $event_ids
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_shared_message_template_for_events(array $event_ids)
+	{
+		$message_template_group = null;
+		if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'Event.EVT_ID'           => array('IN', $event_ids),
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+					),
+					'group_by' => 'GRP_ID',
+				)
+			);
+			//store this in the collection if its valid
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$message_template_group,
+					$event_ids
+				);
+			}
+		}
+		return $message_template_group;
+	}
+
+
+	/**
+	 * Retrieves the global message template group for the current messenger and message type.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_global_message_template_group_for_current_messenger_and_message_type()
+	{
+		//first check the collection (we use an array with 0 in it to represent global groups).
+		$global_message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				array(0)
+			)
+		);
+
+		//if we don't have a group lets hit the db.
+		if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+			$global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+			//if we have a group, add it to the collection.
+			if ($global_message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$global_message_template_group,
+					array(0)
+				);
+			}
+		}
+		return $global_message_template_group;
+	}
+
+
+	/**
+	 * Returns an array of event ids for all the events within the current data handler.
+	 *
+	 * @return array
+	 */
+	protected function _get_event_ids_from_current_data_handler()
+	{
+		$event_ids = array();
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[$event['ID']] = $event['ID'];
+		}
+		return $event_ids;
+	}
+
+
+	/**
+	 *  Retrieves formatted array of template information for each context specific to the given
+	 *  EE_Message_Template_Group
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return array The returned array is in this structure:
+	 *                          array(
+	 *                          'field_name' => array(
+	 *                          'context' => 'content'
+	 *                          )
+	 *                          )
+	 * @throws EE_Error
+	 */
+	protected function _get_templates(EE_Message_Template_Group $message_template_group)
+	{
+		$templates         = array();
+		$context_templates = $message_template_group->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			foreach ($template_fields as $template_field => $template_obj) {
+				if (! $template_obj instanceof EE_Message_Template) {
+					continue;
+				}
+				$templates[$template_field][$context] = $template_obj->get('MTP_content');
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Assembles new fully generated EE_Message objects and adds to _ready_queue
+	 *
+	 * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
+	 *                                               context.
+	 * @param array                     $templates   formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
+	 *                                               method will attempt to generate ALL EE_Message objects and add to
+	 *                                               the _ready_queue.  Successfully generated messages get added to the
+	 *                                               queue with EEM_Message::status_idle, unsuccessfully generated
+	 *                                               messages will get added to the queue as EEM_Message::status_failed.
+	 *                                               Very rarely should "false" be returned from this method.
+	 * @throws EE_Error
+	 */
+	protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
+	{
+
+		//if templates are empty then get out because we can't generate anything.
+		if (! $templates) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to assemble messages because there are no templates retrieved for generating the messages with',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		//We use this as the counter for generated messages because don't forget we may be executing this inside of a
+		//generation_queue.  So _ready_queue may have generated EE_Message objects already.
+		$generated_count = 0;
+		foreach ($addressees as $context => $recipients) {
+			foreach ($recipients as $recipient) {
+				$message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
+				if ($message instanceof EE_Message) {
+					$this->_ready_queue->add(
+						$message,
+						array(),
+						$this->_generation_queue->get_message_repository()->is_preview(),
+						$this->_generation_queue->get_message_repository()->is_test_send()
+					);
+					$generated_count++;
+				}
+
+				//if the current MSG being generated is for a test send then we'll only use ONE message in the
+				// generation.
+				if ($this->_generation_queue->get_message_repository()->is_test_send()) {
+					break 2;
+				}
+			}
+		}
+
+		//if there are no generated messages then something else fatal went wrong.
+		return $generated_count > 0;
+	}
+
+
+	/**
+	 * @param string                    $context   The context for the generated message.
+	 * @param EE_Messages_Addressee     $recipient
+	 * @param array                     $templates formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool|EE_Message
+	 * @throws EE_Error
+	 */
+	protected function _setup_message_object(
+		$context,
+		EE_Messages_Addressee $recipient,
+		$templates,
+		EE_Message_Template_Group $message_template_group
+	) {
+		//stuff we already know
+		$transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
+		$transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
+			? $this->_current_data_handler->txn->ID()
+			: $transaction_id;
+		$message_fields = array(
+			'GRP_ID'           => $message_template_group->ID(),
+			'TXN_ID'           => $transaction_id,
+			'MSG_messenger'    => $this->_current_messenger->name,
+			'MSG_message_type' => $this->_current_message_type->name,
+			'MSG_context'      => $context,
+		);
+
+		//recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
+		// the info from the att_obj found in the EE_Messages_Addressee object.
+		if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
+			$message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
+				? $recipient->att_obj->ID()
+				: 0;
+			$message_fields['MSG_recipient_type'] = 'Attendee';
+		} else {
+			$message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
+			$message_fields['MSG_recipient_type'] = $recipient->recipient_type;
+		}
+		$message = EE_Message_Factory::create($message_fields);
+
+		//grab valid shortcodes for shortcode parser
+		$mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
+		$m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
+
+		//if the 'to' field is empty or the context is inactive we skip EXCEPT if we're previewing
+		if ((
+				(
+					empty($templates['to'][$context])
+					&& ! $this->_current_messenger->allow_empty_to_field()
+				)
+				|| ! $message_template_group->is_context_active($context)
+			)
+			&& ! $this->_generation_queue->get_message_repository()->is_preview()
+		) {
+			//we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
+			//field.
+			return false;
+		}
+		$error_msg = array();
+		foreach ($templates as $field => $field_context) {
+			$error_msg = array();
+			//let's setup the valid shortcodes for the incoming context.
+			$valid_shortcodes = $mt_shortcodes[$context];
+			//merge in valid shortcodes for the field.
+			$shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
+			if (isset($templates[$field][$context])) {
+				//prefix field.
+				$column_name = 'MSG_' . $field;
+				try {
+					$content = $this->_shortcode_parser->parse_message_template(
+						$templates[$field][$context],
+						$recipient,
+						$shortcodes,
+						$this->_current_message_type,
+						$this->_current_messenger,
+						$message
+					);
+					$message->set_field_or_extra_meta($column_name, $content);
+				} catch (EE_Error $e) {
+					$error_msg[] = sprintf(
+						esc_html__(
+							'There was a problem generating the content for the field %s: %s',
+							'event_espresso'
+						),
+						$field,
+						$e->getMessage()
+					);
+					$message->set_STS_ID(EEM_Message::status_failed);
+				}
+			}
+		}
+
+		if ($message->STS_ID() === EEM_Message::status_failed) {
+			$error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
+						 . "\n"
+						 . implode("\n", $error_msg);
+			$message->set_error_message($error_msg);
+		} else {
+			$message->set_STS_ID(EEM_Message::status_idle);
+		}
+		return $message;
+	}
+
+
+	/**
+	 * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
+	 * error message if either is missing.
+	 *
+	 * @return bool true means there were no errors, false means there were errors.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _verify()
+	{
+		//reset error message to an empty array.
+		$this->_error_msg = array();
+		$valid            = true;
+		$valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
+		$valid            = $valid ? $this->_validate_and_setup_data() : $valid;
+
+		//set the verified flag so we know everything has been validated.
+		$this->_verified = $valid;
+
+		return $valid;
+	}
+
+
+	/**
+	 * This accepts an array and validates that it is an array indexed by context with each value being an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
+	 * @return bool
+	 */
+	protected function _valid_addressees($addressees)
+	{
+		if (! $addressees || ! is_array($addressees)) {
+			return false;
+		}
+
+		foreach ($addressees as $addressee_array) {
+			foreach ($addressee_array as $addressee) {
+				if (! $addressee instanceof EE_Messages_Addressee) {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
+	 * queue. This process sets error messages if something is wrong.
+	 *
+	 * @return bool   true is if there are no errors.  false is if there is.
+	 */
+	protected function _validate_messenger_and_message_type()
+	{
+
+		//first are there any existing error messages?  If so then return.
+		if ($this->_error_msg) {
+			return false;
+		}
+		/** @type EE_Message $message */
+		$message = $this->_generation_queue->get_message_repository()->current();
+		try {
+			$this->_current_messenger = $message->valid_messenger(true)
+				? $message->messenger_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+		try {
+			$this->_current_message_type = $message->valid_message_type(true)
+				? $message->message_type_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+
+		/**
+		 * Check if there is any generation data, but only if this is not for a preview.
+		 */
+		if (! $this->_generation_queue->get_message_repository()->get_generation_data()
+			&& (
+				! $this->_generation_queue->get_message_repository()->is_preview()
+				&& $this->_generation_queue->get_message_repository()->get_data_handler()
+				   !== 'EE_Messages_Preview_incoming_data'
+			)
+		) {
+			$this->_error_msg[] = esc_html__(
+				'There is no generation data for this message. Unable to generate.',
+				'event_espresso'
+			);
+		}
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * This method retrieves the expected data handler for the message type and validates the generation data for that
+	 * data handler.
+	 *
+	 * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _validate_and_setup_data()
+	{
+
+		//First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
+		//be used anyways.
+		if ($this->_error_msg) {
+			return false;
+		}
+
+		$generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
+
+		/** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually*/
+		$data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
+			? $this->_generation_queue->get_message_repository()->get_data_handler()
+			: 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+
+		//If this EE_Message is for a preview, then let's switch out to the preview data handler.
+		if ($this->_generation_queue->get_message_repository()->is_preview()) {
+			$data_handler_class_name = 'EE_Messages_Preview_incoming_data';
+		}
+
+		//First get the class name for the data handler (and also verifies it exists.
+		if (! class_exists($data_handler_class_name)) {
+			$this->_error_msg[] = sprintf(
+				esc_html__(
+					'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
+					'event_espresso'
+				),
+				'EE_Messages_incoming_data',
+				$data_handler_class_name
+			);
+			return false;
+		}
+
+		//convert generation_data for data_handler_instantiation.
+		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
+
+		//note, this may set error messages as well.
+		$this->_set_data_handler($generation_data, $data_handler_class_name);
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
+	 * adds it to the _data repository.
+	 *
+	 * @param mixed  $generating_data           This is data expected by the instantiated data handler.
+	 * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
+	 *                                          instantiated.
+	 * @return void .
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_data_handler($generating_data, $data_handler_class_name)
+	{
+		//valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
+		//is already a ready data handler in the repository.
+		$this->_current_data_handler = $this->_data_handler_collection->get_by_key(
+			$this->_data_handler_collection->get_key(
+				$data_handler_class_name,
+				$generating_data
+			)
+		);
+		if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+			//no saved data_handler in the repo so let's set one up and add it to the repo.
+			try {
+				$this->_current_data_handler = new $data_handler_class_name($generating_data);
+				$this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
+			} catch (EE_Error $e) {
+				$this->_error_msg[] = $e->get_error();
+			}
+		}
+	}
+
+
+	/**
+	 * The queued EE_Message for generation does not save the data used for generation as objects
+	 * because serialization of those objects could be problematic if the data is saved to the db.
+	 * So this method calls the static method on the associated data_handler for the given message_type
+	 * and that preps the data for later instantiation when generating.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $preview Indicate whether this is being used for a preview or not.
+	 * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
+	 */
+	protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
+	{
+		/** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
+		$data_handler = $message_to_generate->get_data_handler_class_name($preview);
+		if (! $message_to_generate->valid()) {
+			return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
+		}
+		return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
+	}
+
+
+	/**
+	 * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		//prep data
+		$data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
+
+		$message = $message_to_generate->get_EE_Message();
+
+		//is there a GRP_ID in the request?
+		if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
+			$message->set_GRP_ID($GRP_ID);
+		}
+
+		if ($data === false) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				esc_html__(
+					'Unable to prepare data for persistence to the database.',
+					'event_espresso'
+				)
+			);
+		} else {
+			//make sure that the data handler is cached on the message as well
+			$data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
+		}
+
+		$this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -259,7 +259,7 @@ 
     {
         //double check verification has run and that everything is ready to work with (saves us having to validate
         // everything again).
-        if (! $this->_verified) {
+        if ( ! $this->_verified) {
             return false; //get out because we don't have a valid setup to work with.
         }
 
@@ -276,7 +276,7 @@ 
 
 
         //if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
+        if ( ! $this->_valid_addressees($addressees)) {
             do_action(
                 'AHEE__EE_Messages_Generator___generate__invalid_addressees',
                 $this->_generation_queue->get_message_repository()->current(),
@@ -298,7 +298,7 @@ 
         $message_template_group = $this->_get_message_template_group();
 
         //in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             $this->_error_msg[] = esc_html__(
                 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
                 'event_espresso'
@@ -408,7 +408,7 @@ 
             //attempt to retrieve from repo first
             $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
             if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  //got it!
+                return $message_template_group; //got it!
             }
 
             //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
@@ -513,7 +513,7 @@ 
         );
 
         //if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $global_message_template_group instanceof EE_Message_Template_Group) {
             $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -570,7 +570,7 @@ 
         $context_templates = $message_template_group->context_templates();
         foreach ($context_templates as $context => $template_fields) {
             foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
+                if ( ! $template_obj instanceof EE_Message_Template) {
                     continue;
                 }
                 $templates[$template_field][$context] = $template_obj->get('MTP_content');
@@ -599,7 +599,7 @@ 
     {
 
         //if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
+        if ( ! $templates) {
             $this->_error_msg[] = esc_html__(
                 'Unable to assemble messages because there are no templates retrieved for generating the messages with',
                 'event_espresso'
@@ -703,7 +703,7 @@ 
             $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
             if (isset($templates[$field][$context])) {
                 //prefix field.
-                $column_name = 'MSG_' . $field;
+                $column_name = 'MSG_'.$field;
                 try {
                     $content = $this->_shortcode_parser->parse_message_template(
                         $templates[$field][$context],
@@ -772,13 +772,13 @@ 
      */
     protected function _valid_addressees($addressees)
     {
-        if (! $addressees || ! is_array($addressees)) {
+        if ( ! $addressees || ! is_array($addressees)) {
             return false;
         }
 
         foreach ($addressees as $addressee_array) {
             foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
+                if ( ! $addressee instanceof EE_Messages_Addressee) {
                     return false;
                 }
             }
@@ -820,7 +820,7 @@ 
         /**
          * Check if there is any generation data, but only if this is not for a preview.
          */
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
+        if ( ! $this->_generation_queue->get_message_repository()->get_generation_data()
             && (
                 ! $this->_generation_queue->get_message_repository()->is_preview()
                 && $this->_generation_queue->get_message_repository()->get_data_handler()
@@ -859,7 +859,7 @@ 
         /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually*/
         $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
             ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+            : 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
 
         //If this EE_Message is for a preview, then let's switch out to the preview data handler.
         if ($this->_generation_queue->get_message_repository()->is_preview()) {
@@ -867,7 +867,7 @@ 
         }
 
         //First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
+        if ( ! class_exists($data_handler_class_name)) {
             $this->_error_msg[] = sprintf(
                 esc_html__(
                     'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
@@ -910,7 +910,7 @@ 
                 $generating_data
             )
         );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+        if ( ! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
             //no saved data_handler in the repo so let's set one up and add it to the repo.
             try {
                 $this->_current_data_handler = new $data_handler_class_name($generating_data);
@@ -936,7 +936,7 @@ 
     {
         /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
         $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
         }
         return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());

admin_pages/messages/templates/ee_msg_editor_active_context_element.template.php

Indentation +18 added lines, -18 removed lines

@@ -10,22 +10,22 @@ 
  * @var int    $message_template_group_id The ID for the message template group this context belongs to.
  */
 $active_message = sprintf(
-    esc_html__(
-        'The template for %1$s is currently %2$sactive%3$s.',
-        'event_espresso'
-    ),
-    $context_label,
-    '<strong>',
-    '</strong>'
+	esc_html__(
+		'The template for %1$s is currently %2$sactive%3$s.',
+		'event_espresso'
+	),
+	$context_label,
+	'<strong>',
+	'</strong>'
 );
 $inactive_message = sprintf(
-    esc_html__(
-        'The template for %1$s is currently %2$sinactive%3$s.',
-        'event_espresso'
-    ),
-    $context_label,
-    '<strong>',
-    '</strong>'
+	esc_html__(
+		'The template for %1$s is currently %2$sinactive%3$s.',
+		'event_espresso'
+	),
+	$context_label,
+	'<strong>',
+	'</strong>'
 );
 ?>
 <div class="context-active-control-container">
@@ -34,8 +34,8 @@ 
         <span id="on-off-nonce-<?php echo $context; ?>" class="hidden"><?php echo $nonce; ?></span>
         <span class="ee-on-off-toggle-label">
             <?php
-            echo $is_active ? $active_message : $inactive_message;
-            ?>
+			echo $is_active ? $active_message : $inactive_message;
+			?>
         </span>
         <div class="hidden js-data">
             <span class="ee-active-message"><?php echo $active_message; ?></span>
@@ -43,8 +43,8 @@ 
         </div>
         <div class="switch">
             <?php
-            $checked = $is_active ? ' checked="checked"' : '';
-            ?>
+			$checked = $is_active ? ' checked="checked"' : '';
+			?>
             <input data-grpid="<?php echo $message_template_group_id; ?>" id="ee-on-off-toggle-<?php echo $context; ?>" type="checkbox" class="ee-on-off-toggle ee-toggle-round-flat"<?php echo $checked; ?> value="<?php echo $on_off_action; ?>">
             <label for="ee-on-off-toggle-<?php echo $context; ?>"></label>
         </div>