eventespresso / event-espresso-core

core/helpers/EEH_DTT_Helper.helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -944,7 +944,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 = '')
     {
@@ -1105,7 +1105,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 +1046 added lines, -1046 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,233 +26,233 @@ 
 {
 
 
-    /**
-     * 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';
-        $gmt_offset      = ! empty($gmt_offset) ? $gmt_offset : get_option('gmt_offset');
-        if ($gmt_offset !== '') {
-            // convert GMT offset to seconds
-            $gmt_offset = $gmt_offset * HOUR_IN_SECONDS;
-            // account for WP offsets that aren't valid UTC
-            $gmt_offset = EEH_DTT_Helper::adjust_invalid_gmt_offsets($gmt_offset);
-            // although we don't know the TZ abbreviation, we know the UTC offset
-            $timezone_string = timezone_name_from_abbr(null, $gmt_offset);
-        }
-        // 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);
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @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) {
-
-            //			case -30600 :
-            //				$gmt_offset = -28800;
-            //				break;
-
-            case -27000 :
-                $gmt_offset = -25200;
-                break;
-
-            case -23400 :
-                $gmt_offset = -21600;
-                break;
-
-            case -19800 :
-                $gmt_offset = -18000;
-                break;
-
-            case -9000 :
-                $gmt_offset = -7200;
-                break;
-
-            case -5400 :
-                $gmt_offset = -3600;
-                break;
-
-            case -1800 :
-                $gmt_offset = 0;
-                break;
-
-            case 1800 :
-                $gmt_offset = 3600;
-                break;
-
-            case 49500 :
-                $gmt_offset = 50400;
-                break;
-
-        }
-        return $gmt_offset;
-    }
-
-
-    /**
-     * get_timezone_string_from_abbreviations_list
-     *
-     * @access public
-     * @param int $gmt_offset
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0)
-    {
-        $abbreviations = timezone_abbreviations_list();
-        foreach ($abbreviations as $abbreviation) {
-            foreach ($abbreviation as $city) {
-                if ($city['offset'] === $gmt_offset && $city['dst'] === false) {
-                    // check if the timezone is valid but don't throw any errors if it isn't
-                    if (EEH_DTT_Helper::validate_timezone($city['timezone_id'], false)) {
-                        return $city['timezone_id'];
-                    }
-                }
-            }
-        }
-        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>'
-            )
-        );
-    }
-
-
-    /**
-     * @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';
+		$gmt_offset      = ! empty($gmt_offset) ? $gmt_offset : get_option('gmt_offset');
+		if ($gmt_offset !== '') {
+			// convert GMT offset to seconds
+			$gmt_offset = $gmt_offset * HOUR_IN_SECONDS;
+			// account for WP offsets that aren't valid UTC
+			$gmt_offset = EEH_DTT_Helper::adjust_invalid_gmt_offsets($gmt_offset);
+			// although we don't know the TZ abbreviation, we know the UTC offset
+			$timezone_string = timezone_name_from_abbr(null, $gmt_offset);
+		}
+		// 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);
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @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) {
+
+			//			case -30600 :
+			//				$gmt_offset = -28800;
+			//				break;
+
+			case -27000 :
+				$gmt_offset = -25200;
+				break;
+
+			case -23400 :
+				$gmt_offset = -21600;
+				break;
+
+			case -19800 :
+				$gmt_offset = -18000;
+				break;
+
+			case -9000 :
+				$gmt_offset = -7200;
+				break;
+
+			case -5400 :
+				$gmt_offset = -3600;
+				break;
+
+			case -1800 :
+				$gmt_offset = 0;
+				break;
+
+			case 1800 :
+				$gmt_offset = 3600;
+				break;
+
+			case 49500 :
+				$gmt_offset = 50400;
+				break;
+
+		}
+		return $gmt_offset;
+	}
+
+
+	/**
+	 * get_timezone_string_from_abbreviations_list
+	 *
+	 * @access public
+	 * @param int $gmt_offset
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0)
+	{
+		$abbreviations = timezone_abbreviations_list();
+		foreach ($abbreviations as $abbreviation) {
+			foreach ($abbreviation as $city) {
+				if ($city['offset'] === $gmt_offset && $city['dst'] === false) {
+					// check if the timezone is valid but don't throw any errors if it isn't
+					if (EEH_DTT_Helper::validate_timezone($city['timezone_id'], false)) {
+						return $city['timezone_id'];
+					}
+				}
+			}
+		}
+		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>'
+			)
+		);
+	}
+
+
+	/**
+	 * @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>
@@ -265,13 +265,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; ?>
@@ -280,693 +280,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;
+	}
+
+
+	/**
+	 *    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;
+	}
+
 
 	/**
-     * 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()
+	 * 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
@@ -976,135 +976,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 +50 added lines, -51 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(
@@ -135,7 +135,7 @@ 
             }
         }
         $offset = get_option('gmt_offset');
-        return (int)($offset * HOUR_IN_SECONDS);
+        return (int) ($offset * HOUR_IN_SECONDS);
     }
 
 
@@ -149,7 +149,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) {
 
             //			case -30600 :
@@ -233,7 +233,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
@@ -245,9 +245,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';
             }
@@ -269,11 +269,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) : ?>
@@ -306,11 +306,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.');
                 }
@@ -338,13 +337,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;
     }
 
 
@@ -427,7 +426,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'),
@@ -437,25 +436,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) {
@@ -483,7 +482,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'),
@@ -587,7 +586,7 @@ 
                 'date' => $date_format['js'],
                 'time' => $time_format['js'],
             ),
-            'moment' => $date_format['moment'] . ' ' . $time_format['moment'],
+            'moment' => $date_format['moment'].' '.$time_format['moment'],
         );
     }
 
@@ -606,7 +605,7 @@ 
          *
          * @var array
          */
-        $symbols_map      = array(
+        $symbols_map = array(
             // Day
             //01
             'd' => array(
@@ -764,7 +763,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;
@@ -834,7 +833,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;
@@ -866,8 +865,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;
     }
 
@@ -883,16 +882,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;
             }
@@ -913,16 +912,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));
     }
 
 
@@ -948,7 +947,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)) {
@@ -972,7 +971,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);
 	}
 
 
@@ -1006,9 +1005,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;
@@ -1017,12 +1016,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]),
@@ -1045,7 +1044,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) {
@@ -1059,19 +1058,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'];
                 }
             }
 
@@ -1081,10 +1080,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>';
             }
         }

caffeinated/EE_Caf_Messages.class.php

Indentation +714 added lines, -714 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.3.2
  */
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -22,735 +22,735 @@ 
 {
     
     
-    /**
-     * constructor.
-     */
-    public function __construct()
-    {
-        $this->_caf_hooks();
-    }
-    
-    
-    /**
-     * Contains all the hooks filters for setting up caffeinated messages functionality.
-     *
-     * @since 4.3.2
-     *
-     * @return void
-     */
-    private function _caf_hooks()
-    {
-        add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
-        add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'),
-            5, 2);
-        add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5,
-            2);
-        add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5,
-            2);
-        add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5,
-            2);
-        add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
-        add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5,
-            2);
-        add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
-            array($this, 'new_default_templates'), 5, 7);
-        add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5,
-            2);
-        
-        //shortcode parsers
-        add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
-        add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes',
-            array($this, 'additional_recipient_details_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after',
-            array($this, 'additional_recipient_details_parser'), 5, 5);
-        add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
-            array($this, 'additional_primary_registration_details_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
-            array($this, 'additional_primary_registration_details_parser'), 5, 5);
-        
-        /**
-         * @since 4.2.0
-         */
-        add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
-        add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
-        
-        /**
-         * @since 4.3.0
-         */
-        //eat our own dog food!
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
-        do_action('EE_Brewing_Regular___messages_caf');
-    }
-    
-    
-    /**
-     * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
-     * messages system.
-     *
-     * @param  array $dir_ref original array of paths
-     *
-     * @return array           appended paths
-     */
-    public function messages_autoload_paths($dir_ref)
-    {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
-        
-        return $dir_ref;
-    }
-    
-    
-    public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]')
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]')
-        );
-        
-        return $validator_config;
-    }
-    
-    
-    public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]')
-        );
-        
-        return $template_fields;
-    }
-    
-    
-    public function new_default_templates(
-        $contents,
-        $actual_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        
-        //we're only modifying templates for the default template pack
-        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $contents;
-        }
-        
-        //the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
-        
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
-        
-        if ($messenger->name == 'email' && $message_type->name == 'registration') {
+	/**
+	 * constructor.
+	 */
+	public function __construct()
+	{
+		$this->_caf_hooks();
+	}
+    
+    
+	/**
+	 * Contains all the hooks filters for setting up caffeinated messages functionality.
+	 *
+	 * @since 4.3.2
+	 *
+	 * @return void
+	 */
+	private function _caf_hooks()
+	{
+		add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
+		add_filter('FHEE__EE_Email_messenger__get_validator_config', array($this, 'email_messenger_validator_config'),
+			5, 2);
+		add_filter('FHEE__EE_Email_messenger__get_template_fields', array($this, 'email_messenger_template_fields'), 5,
+			2);
+		add_filter('FHEE__EE_Html_messenger__get_template_fields', array($this, 'html_messenger_template_fields'), 5,
+			2);
+		add_filter('FHEE__EE_Html_messenger__get_validator_config', array($this, 'html_messenger_validator_config'), 5,
+			2);
+		add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
+		add_filter('FHEE__EE_Pdf_messenger__get_validator_config', array($this, 'pdf_messenger_validator_config'), 5,
+			2);
+		add_filter('FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
+			array($this, 'new_default_templates'), 5, 7);
+		add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', array($this, 'message_types_valid_shortcodes'), 5,
+			2);
+        
+		//shortcode parsers
+		add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
+		add_filter('FHEE__EE_Recipient_List_Shortcodes__shortcodes',
+			array($this, 'additional_recipient_details_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Recipient_List_Shortcodes__parser_after',
+			array($this, 'additional_recipient_details_parser'), 5, 5);
+		add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
+			array($this, 'additional_primary_registration_details_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
+			array($this, 'additional_primary_registration_details_parser'), 5, 5);
+        
+		/**
+		 * @since 4.2.0
+		 */
+		add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
+		add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
+        
+		/**
+		 * @since 4.3.0
+		 */
+		//eat our own dog food!
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
+		do_action('EE_Brewing_Regular___messages_caf');
+	}
+    
+    
+	/**
+	 * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
+	 * messages system.
+	 *
+	 * @param  array $dir_ref original array of paths
+	 *
+	 * @return array           appended paths
+	 */
+	public function messages_autoload_paths($dir_ref)
+	{
+		$dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        
+		return $dir_ref;
+	}
+    
+    
+	public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]')
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]')
+		);
+        
+		return $validator_config;
+	}
+    
+    
+	public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]')
+		);
+        
+		return $template_fields;
+	}
+    
+    
+	public function new_default_templates(
+		$contents,
+		$actual_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+        
+		//we're only modifying templates for the default template pack
+		if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $contents;
+		}
+        
+		//the template file name we're replacing contents for.
+		$template_file_prefix = $field . '_' . $context;
+		$msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
+        
+		$base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        
+		if ($messenger->name == 'email' && $message_type->name == 'registration') {
             
-            switch ($template_file_prefix) {
+			switch ($template_file_prefix) {
                 
-                case 'question_list_admin' :
-                case 'question_list_attendee' :
-                case 'question_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'question_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'question_list_admin' :
+				case 'question_list_attendee' :
+				case 'question_list_primary_attendee' :
+					$path     = $base_path . $msg_prefix . 'question_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'attendee_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'attendee_list_primary_attendee' :
+					$path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'attendee_list_admin' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
-                    $contents = EEH_Template::display_template($path,
-                        array(), true);
-                    break;
+				case 'attendee_list_admin' :
+					$path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+					$contents = EEH_Template::display_template($path,
+						array(), true);
+					break;
                 
-                case 'attendee_list_attendee' :
-                    $contents = '';
-                    break;
+				case 'attendee_list_attendee' :
+					$contents = '';
+					break;
                 
-                case 'event_list_attendee' :
-                    $path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
-            switch ($template_file_prefix) {
+				case 'event_list_attendee' :
+					$path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
+			switch ($template_file_prefix) {
                 
-                case 'content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'content_attendee' :
+					$path     = $base_path . $msg_prefix . 'content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'newsletter_content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
+				case 'newsletter_content_attendee' :
+					$path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
                 
-                case 'newsletter_subject_attendee' :
-                    $path     = $base_path . $msg_prefix . 'subject.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
-            switch ($template_file_prefix) {
-                case 'attendee_list_purchaser' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        }
-        
-        return $contents;
-        
-    }
-    
-    
-    public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
-    {
-        //make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
-        $include_with = array(
-            'registration',
-            'cancelled_registration',
-            'declined_registration',
-            'not_approved_registration',
-            'payment_declined',
-            'payment_failed',
-            'payment_cancelled',
-            'payment',
-            'payment_reminder',
-            'pending_approval',
-            'registration_summary',
-            'invoice',
-            'receipt'
-        );
-        if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
-            $contexts = array_keys($msg->get_contexts());
-            foreach ($contexts as $context) {
-                $valid_shortcodes[$context][] = 'question_list';
-                $valid_shortcodes[$context][] = 'question';
-            }
-        }
-        
-        return $valid_shortcodes;
-    }
-    
-    
-    public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[ANSWER_*]'] = __('This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if (strpos($shortcode,
-                '[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations)
-        ) {
-            return $parsed;
-        }
-        
-        //let's get the question from the code.
-        $shortcode = str_replace('[ANSWER_*', '', $shortcode);
-        $shortcode = trim(str_replace(']', '', $shortcode));
-        
-        $registration = $data instanceof EE_Registration ? $data : null;
-        $registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
-        
-        $aee = $data instanceof EE_Messages_Addressee ? $data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
-        
-        if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        //now let's figure out which question has this text.
-        foreach ($aee->questions as $ansid => $question) {
-            if (
-                $question instanceof EE_Question
-                && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
-            ) {
-                return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value',
-                    'no_wpautop');
-            }
-        }
-        
-        //nothing!
-        return $parsed;
-    }
-    
-    
-    /**
-     * Callback for additional shortcodes filter for adding additional datetime shortcodes.
-     *
-     * @since  4.2
-     *
-     * @param  array                  $shortcodes         array of shortcodes and
-     *                                                    descriptions
-     * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
-     *
-     * @return array                                        array of shortcodes and
-     *                                                        descriptions
-     */
-    public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[DTT_NAME]']          = __('This will be parsed to the Title given for a Datetime',
-            'event_espresso');
-        $shortcodes['[DTT_DESCRIPTION]']   = __('This will be parsed to the description for a Datetime',
-            'event_espresso');
-        $shortcodes['[DTT_NAME_OR_DATES]'] = __('When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for additional shortcodes parser filter used for adding parser for new
-     * Datetime shortcodes
-     *
-     * @since  4.2
-     *
-     * @param  string                 $parsed     The finished parsed string for the given shortcode.
-     * @param  string                 $shortcode  The shortcode being parsed.
-     * @param  object                 $data       The incoming data object for the Shortcode Parser.
-     * @param  object                 $extra_data The incoming extra date object for the Shortcode
-     *                                            Parser.
-     * @param  EE_Datetime_Shortcodes $shortcode_parser
-     *
-     * @return string                   The new parsed string.
-     */
-    public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if ( ! $data instanceof EE_Datetime) {
-            return ''; //get out because we can only parse with the datetime object.
-        }
-        
-        switch ($shortcode) {
-            case '[DTT_NAME]' :
-                return $data->name();
-                break;
-            case '[DTT_DESCRIPTION]' :
-                return $data->description();
-                break;
-            case '[DTT_NAME_OR_DATES]' :
-                return $data->get_dtt_display_name(true);
-                break;
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __('This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-        
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-        
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-        
-        if ( ! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        switch ($shortcode) {
-            case '[RECIPIENT_QUESTION_LIST]' :
-                $att                       = $recipient->att_obj;
-                $registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array();
-                $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
-                $answers                   = array();
+				case 'newsletter_subject_attendee' :
+					$path     = $base_path . $msg_prefix . 'subject.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
+			switch ($template_file_prefix) {
+				case 'attendee_list_purchaser' :
+					$path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		}
+        
+		return $contents;
+        
+	}
+    
+    
+	public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
+	{
+		//make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
+		$include_with = array(
+			'registration',
+			'cancelled_registration',
+			'declined_registration',
+			'not_approved_registration',
+			'payment_declined',
+			'payment_failed',
+			'payment_cancelled',
+			'payment',
+			'payment_reminder',
+			'pending_approval',
+			'registration_summary',
+			'invoice',
+			'receipt'
+		);
+		if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
+			$contexts = array_keys($msg->get_contexts());
+			foreach ($contexts as $context) {
+				$valid_shortcodes[$context][] = 'question_list';
+				$valid_shortcodes[$context][] = 'question';
+			}
+		}
+        
+		return $valid_shortcodes;
+	}
+    
+    
+	public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[ANSWER_*]'] = __('This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if (strpos($shortcode,
+				'[ANSWER_*') === false || ! isset($extra_data['data']->questions) || ! isset($extra_data['data']->registrations)
+		) {
+			return $parsed;
+		}
+        
+		//let's get the question from the code.
+		$shortcode = str_replace('[ANSWER_*', '', $shortcode);
+		$shortcode = trim(str_replace(']', '', $shortcode));
+        
+		$registration = $data instanceof EE_Registration ? $data : null;
+		$registration = ! $registration instanceof EE_Registration && is_array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
+        
+		$aee = $data instanceof EE_Messages_Addressee ? $data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array($extra_data) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
+        
+		if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		//now let's figure out which question has this text.
+		foreach ($aee->questions as $ansid => $question) {
+			if (
+				$question instanceof EE_Question
+				&& trim($question->display_text()) == trim($shortcode)
+				&& isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
+			) {
+				return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty('ANS_value',
+					'no_wpautop');
+			}
+		}
+        
+		//nothing!
+		return $parsed;
+	}
+    
+    
+	/**
+	 * Callback for additional shortcodes filter for adding additional datetime shortcodes.
+	 *
+	 * @since  4.2
+	 *
+	 * @param  array                  $shortcodes         array of shortcodes and
+	 *                                                    descriptions
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
+	 *
+	 * @return array                                        array of shortcodes and
+	 *                                                        descriptions
+	 */
+	public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[DTT_NAME]']          = __('This will be parsed to the Title given for a Datetime',
+			'event_espresso');
+		$shortcodes['[DTT_DESCRIPTION]']   = __('This will be parsed to the description for a Datetime',
+			'event_espresso');
+		$shortcodes['[DTT_NAME_OR_DATES]'] = __('When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for additional shortcodes parser filter used for adding parser for new
+	 * Datetime shortcodes
+	 *
+	 * @since  4.2
+	 *
+	 * @param  string                 $parsed     The finished parsed string for the given shortcode.
+	 * @param  string                 $shortcode  The shortcode being parsed.
+	 * @param  object                 $data       The incoming data object for the Shortcode Parser.
+	 * @param  object                 $extra_data The incoming extra date object for the Shortcode
+	 *                                            Parser.
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser
+	 *
+	 * @return string                   The new parsed string.
+	 */
+	public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if ( ! $data instanceof EE_Datetime) {
+			return ''; //get out because we can only parse with the datetime object.
+		}
+        
+		switch ($shortcode) {
+			case '[DTT_NAME]' :
+				return $data->name();
+				break;
+			case '[DTT_DESCRIPTION]' :
+				return $data->description();
+				break;
+			case '[DTT_NAME_OR_DATES]' :
+				return $data->get_dtt_display_name(true);
+				break;
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[RECIPIENT_QUESTION_LIST]'] = __('This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+        
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+        
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+        
+		if ( ! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		switch ($shortcode) {
+			case '[RECIPIENT_QUESTION_LIST]' :
+				$att                       = $recipient->att_obj;
+				$registrations_on_attendee = $att instanceof EE_Attendee ? $recipient->attendees[$att->ID()]['reg_objs'] : array();
+				$registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
+				$answers                   = array();
                 
-                $template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
+				$template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
                 
-                //if the context is main_content then get all answers for all registrations on this attendee
-                if ($data['data'] instanceof EE_Messages_Addressee) {
+				//if the context is main_content then get all answers for all registrations on this attendee
+				if ($data['data'] instanceof EE_Messages_Addressee) {
                     
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[$ans->ID()] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[$ans->ID()] = $ans;
+								}
+							}
+						}
+					}
+				}
                 
-                //if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
-                if ($data['data'] instanceof EE_Event) {
-                    $event = $data['data'];
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[$ans->ID()] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
+				//if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
+				if ($data['data'] instanceof EE_Event) {
+					$event = $data['data'];
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
+							$anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) ? $recipient->registrations[$reg->ID()]['ans_objs'] : array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[$ans->ID()] = $ans;
+								}
+							}
+						}
+					}
+				}
                 
-                $questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
+				$questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
                 
-                //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                //object on it.
-                if ( ! isset( $extra_data['data'] ) ) {
-                    $extra_data['data'] = $recipient;
-                }
+				//if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				//object on it.
+				if ( ! isset( $extra_data['data'] ) ) {
+					$extra_data['data'] = $recipient;
+				}
                 
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
             
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __('This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
-            'event_espresso');
-        
-        return $shortcodes;
-    }
-    
-    
-    /**
-     * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_primary_registration_details_parser(
-        $parsed,
-        $shortcode,
-        $data,
-        $extra_data,
-        $shortcode_parser
-    ) {
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-        
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-        
-        if ( ! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-        
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_QUESTION_LIST]' :
-                if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                $registration     = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
-                    ? $recipient->registrations[$registration->ID()]['ans_objs']
-                    : array();
-                if (empty($answers)) {
-                    return '';
-                }
-                $template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-                $answers          = $recipient->registrations[$registration->ID()]['ans_objs'];
-                $questions = isset($recipient->questions) ? $recipient->questions : array();
-                //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                //object on it.
-                if ( ! isset( $extra_data['data'] ) ){
-                    $extra_data['data'] = $recipient;
-                }
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __('This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
+			'event_espresso');
+        
+		return $shortcodes;
+	}
+    
+    
+	/**
+	 * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_primary_registration_details_parser(
+		$parsed,
+		$shortcode,
+		$data,
+		$extra_data,
+		$shortcode_parser
+	) {
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+        
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+        
+		if ( ! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+        
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_QUESTION_LIST]' :
+				if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				$registration     = $recipient->primary_reg_obj;
+				$answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
+					? $recipient->registrations[$registration->ID()]['ans_objs']
+					: array();
+				if (empty($answers)) {
+					return '';
+				}
+				$template         = is_array($data['template']) && isset($data['template']['question_list']) ? $data['template']['question_list'] : $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+				$answers          = $recipient->registrations[$registration->ID()]['ans_objs'];
+				$questions = isset($recipient->questions) ? $recipient->questions : array();
+				//if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				//object on it.
+				if ( ! isset( $extra_data['data'] ) ){
+					$extra_data['data'] = $recipient;
+				}
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
             
-            default :
-                return $parsed;
-                break;
-        }
-    }
-    
-    
-    /**
-     * Takes care of registering the  message types that are only available in caffeinated EE.
-     *
-     * @since   4.3.2
-     *
-     * @return  void
-     */
-    public function register_caf_message_types()
-    {
-        //register newsletter message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
-            'autoloadpaths'               => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
-            ),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('newsletter', $setup_args);
-        
-        //register payment reminder message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_reminder', $setup_args);
-        
-        //register payment declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_declined', $setup_args);
-        
-        //register registration declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('declined_registration', $setup_args);
-        
-        //register registration cancelled message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('cancelled_registration', $setup_args);
-        
-        
-        //register payment failed message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_failed', $setup_args);
-        
-        //register payment declined message type
-        $setup_args = array(
-            'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
-            'messengers_to_activate_with' => array('email'),
-            'messengers_to_validate_with' => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email')
-        );
-        EE_Register_Message_Type::register('payment_cancelled', $setup_args);
-    }
-    
-    
-    /**
-     * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
-     *
-     * @since   4.3.2
-     *
-     * @return void
-     */
-    public function register_caf_shortcodes()
-    {
-        $setup_args = array(
-            'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/'
-            ),
-            'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
-            'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
-            'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]')
-        );
-        EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
-    }
-    
-    
-    /**
-     * Parses a question list shortcode using given data and template
-     *
-     * @param \EE_Shortcodes $shortcode_parser
-     * @param EE_Question[]  $questions        An array of questions indexed by answer id.
-     * @param EE_Answer[]    $answers          An array of answer objects
-     * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
-     * @param array          $extra_data       Extra data that might be used when parsing the template.
-     */
-    protected function _parse_question_list_for_primary_or_recipient_registration(
-        $shortcode_parser,
-        $questions,
-        $answers,
-        $template,
-        $valid_shortcodes,
-        $extra_data
-    ) {
-        $question_list = '';
-        /** @var EEH_Parse_Shortcodes $shortcode_helper */
-        $shortcode_helper = $shortcode_parser->get_shortcode_helper();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                //first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
-                $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (
-                    ! $question instanceof EE_Question
-                    || (
-                        $question instanceof EE_Question
-                        && $question->admin_only()
-                    )
-                ) {
-                    continue;
-                }
-                $question_list .= $shortcode_helper->parse_question_list_template(
-                    $template,
-                    $answer,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-            }
-        }
-        
-        return $question_list;
-    }
+			default :
+				return $parsed;
+				break;
+		}
+	}
+    
+    
+	/**
+	 * Takes care of registering the  message types that are only available in caffeinated EE.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return  void
+	 */
+	public function register_caf_message_types()
+	{
+		//register newsletter message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
+			'autoloadpaths'               => array(
+				EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
+			),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('newsletter', $setup_args);
+        
+		//register payment reminder message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_reminder', $setup_args);
+        
+		//register payment declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_declined', $setup_args);
+        
+		//register registration declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('declined_registration', $setup_args);
+        
+		//register registration cancelled message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('cancelled_registration', $setup_args);
+        
+        
+		//register payment failed message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_failed', $setup_args);
+        
+		//register payment declined message type
+		$setup_args = array(
+			'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
+			'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+			'messengers_to_activate_with' => array('email'),
+			'messengers_to_validate_with' => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email')
+		);
+		EE_Register_Message_Type::register('payment_cancelled', $setup_args);
+	}
+    
+    
+	/**
+	 * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return void
+	 */
+	public function register_caf_shortcodes()
+	{
+		$setup_args = array(
+			'autoloadpaths'                 => array(
+				EE_CAF_LIBRARIES . 'shortcodes/'
+			),
+			'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
+			'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
+			'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]')
+		);
+		EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
+	}
+    
+    
+	/**
+	 * Parses a question list shortcode using given data and template
+	 *
+	 * @param \EE_Shortcodes $shortcode_parser
+	 * @param EE_Question[]  $questions        An array of questions indexed by answer id.
+	 * @param EE_Answer[]    $answers          An array of answer objects
+	 * @param string         $template         Template content to be parsed.
+	 * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+	 * @param array          $extra_data       Extra data that might be used when parsing the template.
+	 */
+	protected function _parse_question_list_for_primary_or_recipient_registration(
+		$shortcode_parser,
+		$questions,
+		$answers,
+		$template,
+		$valid_shortcodes,
+		$extra_data
+	) {
+		$question_list = '';
+		/** @var EEH_Parse_Shortcodes $shortcode_helper */
+		$shortcode_helper = $shortcode_parser->get_shortcode_helper();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				//first see if the question is in our $questions array. If not then try to get from answer object.
+				$question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
+				$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+				if (
+					! $question instanceof EE_Question
+					|| (
+						$question instanceof EE_Question
+						&& $question->admin_only()
+					)
+				) {
+					continue;
+				}
+				$question_list .= $shortcode_helper->parse_question_list_template(
+					$template,
+					$answer,
+					$valid_shortcodes,
+					$extra_data
+				);
+			}
+		}
+        
+		return $question_list;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -95,7 +95,7 @@ 
      */
     public function messages_autoload_paths($dir_ref)
     {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/';
         
         return $dir_ref;
     }
@@ -216,10 +216,10 @@ 
         }
         
         //the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix           = $messenger->name . '_' . $message_type->name . '_';
+        $template_file_prefix = $field.'_'.$context;
+        $msg_prefix           = $messenger->name.'_'.$message_type->name.'_';
         
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/';
         
         if ($messenger->name == 'email' && $message_type->name == 'registration') {
             
@@ -228,17 +228,17 @@ 
                 case 'question_list_admin' :
                 case 'question_list_attendee' :
                 case 'question_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'question_list.template.php';
+                    $path     = $base_path.$msg_prefix.'question_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'attendee_list_primary_attendee' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'attendee_list_admin' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list_admin.template.php';
                     $contents = EEH_Template::display_template($path,
                         array(), true);
                     break;
@@ -248,7 +248,7 @@ 
                     break;
                 
                 case 'event_list_attendee' :
-                    $path     = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+                    $path     = $base_path.$msg_prefix.'event_list_attendee.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -256,24 +256,24 @@ 
             switch ($template_file_prefix) {
                 
                 case 'content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'content.template.php';
+                    $path     = $base_path.$msg_prefix.'content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'newsletter_content_attendee' :
-                    $path     = $base_path . $msg_prefix . 'newsletter_content.template.php';
+                    $path     = $base_path.$msg_prefix.'newsletter_content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
                 
                 case 'newsletter_subject_attendee' :
-                    $path     = $base_path . $msg_prefix . 'subject.template.php';
+                    $path     = $base_path.$msg_prefix.'subject.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
             switch ($template_file_prefix) {
                 case 'attendee_list_purchaser' :
-                    $path     = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path     = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -505,7 +505,7 @@ 
                 
                 //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 //object on it.
-                if ( ! isset( $extra_data['data'] ) ) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 
@@ -569,7 +569,7 @@ 
                 if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
-                $registration     = $recipient->primary_reg_obj;
+                $registration = $recipient->primary_reg_obj;
                 $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
                     ? $recipient->registrations[$registration->ID()]['ans_objs']
                     : array();
@@ -582,7 +582,7 @@ 
                 $questions = isset($recipient->questions) ? $recipient->questions : array();
                 //if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 //object on it.
-                if ( ! isset( $extra_data['data'] ) ){
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 return $this->_parse_question_list_for_primary_or_recipient_registration(
@@ -615,7 +615,7 @@ 
         $setup_args = array(
             'mtfilename'                  => 'EE_Newsletter_message_type.class.php',
             'autoloadpaths'               => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/'
+                EE_CAF_LIBRARIES.'messages/message_type/newsletter/'
             ),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
@@ -626,7 +626,7 @@ 
         //register payment reminder message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -636,7 +636,7 @@ 
         //register payment declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -646,7 +646,7 @@ 
         //register registration declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -656,7 +656,7 @@ 
         //register registration cancelled message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -667,7 +667,7 @@ 
         //register payment failed message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -677,7 +677,7 @@ 
         //register payment declined message type
         $setup_args = array(
             'mtfilename'                  => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'               => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+            'autoloadpaths'               => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'),
             'messengers_to_activate_with' => array('email'),
             'messengers_to_validate_with' => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email')
@@ -697,7 +697,7 @@ 
     {
         $setup_args = array(
             'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/'
+                EE_CAF_LIBRARIES.'shortcodes/'
             ),
             'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
             'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),

core/services/shortcodes/ShortcodesManager.php

Indentation +205 added lines, -205 removed lines

@@ -32,211 +32,211 @@
 class ShortcodesManager
 {
 
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * @var ShortcodeInterface[] $shortcodes
-     */
-    private $shortcodes;
-
-
-
-    /**
-     * ShortcodesManager constructor
-     *
-     * @param LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) {
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        // assemble a list of installed and active shortcodes
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            array($this, 'registerShortcodes'),
-            999
-        );
-        //  call add_shortcode() for all installed shortcodes
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes'));
-        // check content for shortcodes the old way
-        add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5);
-        // check content for shortcodes the NEW more efficient way
-        add_action('template_redirect', array($this, 'templateRedirect'), 999);
-    }
-
-
-
-    /**
-     * @return CollectionInterface|ShortcodeInterface[]
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    public function getShortcodes()
-    {
-        if ( ! $this->shortcodes instanceof CollectionInterface) {
-            $this->shortcodes = $this->loadShortcodesCollection();
-        }
-        return $this->shortcodes;
-    }
-
-
-
-    /**
-     * @return CollectionInterface|ShortcodeInterface[]
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function loadShortcodesCollection()
-    {
-        $loader = new CollectionLoader(
-            new CollectionDetails(
-            // collection name
-                'shortcodes',
-                // collection interface
-                'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-                // FQCNs for classes to add (all classes within that namespace will be loaded)
-                array('EventEspresso\core\domain\entities\shortcodes'),
-                // filepaths to classes to add
-                array(),
-                // file mask to use if parsing folder for files to add
-                '',
-                // what to use as identifier for collection entities
-                // using CLASS NAME prevents duplicates (works like a singleton)
-                CollectionDetails::ID_CLASS_NAME
-            )
-        );
-        return $loader->getCollection();
-    }
-
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    public function registerShortcodes()
-    {
-        try {
-            $this->shortcodes = apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
-                $this->getShortcodes()
-            );
-            if (! $this->shortcodes instanceof CollectionInterface) {
-                throw new InvalidEntityException(
-                    $this->shortcodes,
-                    'CollectionInterface',
-                    sprintf(
-                        esc_html__(
-                            'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.',
-                            'event_espresso'
-                        ),
-                        is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes)
-                    )
-                );
-            }
-            $this->legacy_shortcodes_manager->registerShortcodes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function addShortcodes()
-    {
-        try {
-            // cycle thru shortcode folders
-            foreach ($this->shortcodes as $shortcode) {
-                /** @var ShortcodeInterface $shortcode */
-                if ( $shortcode instanceof EnqueueAssetsInterface) {
-                    add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10);
-                    add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11);
-                }
-                // add_shortcode() if it has not already been added
-                if ( ! shortcode_exists($shortcode->getTag())) {
-                    add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback'));
-                }
-            }
-            $this->legacy_shortcodes_manager->addShortcodes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-
-    /**
-     * callback for the "template_redirect" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @return void
-     */
-    public function templateRedirect()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)) {
-            return;
-        }
-        $load_assets = false;
-        // array of posts displayed in current request
-        $posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts);
-        foreach ($posts as $post) {
-            // now check post content and excerpt for EE shortcodes
-            $load_assets = $this->parseContentForShortcodes($post->post_content)
-                ? true
-                : $load_assets;
-        }
-        if ($load_assets) {
-            $this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-    }
-
-
-
-    /**
-     * checks supplied content against list of shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @return bool
-     */
-    public function parseContentForShortcodes($content)
-    {
-        $has_shortcode = false;
-        if(empty($this->shortcodes)){
-            return $has_shortcode;
-        }
-        foreach ($this->shortcodes as $shortcode) {
-            /** @var ShortcodeInterface $shortcode */
-            if (has_shortcode($content, $shortcode->getTag())) {
-                $shortcode->initializeShortcode();
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * @var ShortcodeInterface[] $shortcodes
+	 */
+	private $shortcodes;
+
+
+
+	/**
+	 * ShortcodesManager constructor
+	 *
+	 * @param LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) {
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		// assemble a list of installed and active shortcodes
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			array($this, 'registerShortcodes'),
+			999
+		);
+		//  call add_shortcode() for all installed shortcodes
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes'));
+		// check content for shortcodes the old way
+		add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5);
+		// check content for shortcodes the NEW more efficient way
+		add_action('template_redirect', array($this, 'templateRedirect'), 999);
+	}
+
+
+
+	/**
+	 * @return CollectionInterface|ShortcodeInterface[]
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	public function getShortcodes()
+	{
+		if ( ! $this->shortcodes instanceof CollectionInterface) {
+			$this->shortcodes = $this->loadShortcodesCollection();
+		}
+		return $this->shortcodes;
+	}
+
+
+
+	/**
+	 * @return CollectionInterface|ShortcodeInterface[]
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function loadShortcodesCollection()
+	{
+		$loader = new CollectionLoader(
+			new CollectionDetails(
+			// collection name
+				'shortcodes',
+				// collection interface
+				'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+				// FQCNs for classes to add (all classes within that namespace will be loaded)
+				array('EventEspresso\core\domain\entities\shortcodes'),
+				// filepaths to classes to add
+				array(),
+				// file mask to use if parsing folder for files to add
+				'',
+				// what to use as identifier for collection entities
+				// using CLASS NAME prevents duplicates (works like a singleton)
+				CollectionDetails::ID_CLASS_NAME
+			)
+		);
+		return $loader->getCollection();
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	public function registerShortcodes()
+	{
+		try {
+			$this->shortcodes = apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+				$this->getShortcodes()
+			);
+			if (! $this->shortcodes instanceof CollectionInterface) {
+				throw new InvalidEntityException(
+					$this->shortcodes,
+					'CollectionInterface',
+					sprintf(
+						esc_html__(
+							'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.',
+							'event_espresso'
+						),
+						is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes)
+					)
+				);
+			}
+			$this->legacy_shortcodes_manager->registerShortcodes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function addShortcodes()
+	{
+		try {
+			// cycle thru shortcode folders
+			foreach ($this->shortcodes as $shortcode) {
+				/** @var ShortcodeInterface $shortcode */
+				if ( $shortcode instanceof EnqueueAssetsInterface) {
+					add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10);
+					add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11);
+				}
+				// add_shortcode() if it has not already been added
+				if ( ! shortcode_exists($shortcode->getTag())) {
+					add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback'));
+				}
+			}
+			$this->legacy_shortcodes_manager->addShortcodes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+
+	/**
+	 * callback for the "template_redirect" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @return void
+	 */
+	public function templateRedirect()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)) {
+			return;
+		}
+		$load_assets = false;
+		// array of posts displayed in current request
+		$posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts);
+		foreach ($posts as $post) {
+			// now check post content and excerpt for EE shortcodes
+			$load_assets = $this->parseContentForShortcodes($post->post_content)
+				? true
+				: $load_assets;
+		}
+		if ($load_assets) {
+			$this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+	}
+
+
+
+	/**
+	 * checks supplied content against list of shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @return bool
+	 */
+	public function parseContentForShortcodes($content)
+	{
+		$has_shortcode = false;
+		if(empty($this->shortcodes)){
+			return $has_shortcode;
+		}
+		foreach ($this->shortcodes as $shortcode) {
+			/** @var ShortcodeInterface $shortcode */
+			if (has_shortcode($content, $shortcode->getTag())) {
+				$shortcode->initializeShortcode();
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
 
 }
 // End of file ShortcodesManager.php

core/EE_Front_Controller.core.php

Indentation +466 added lines, -466 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\widgets\EspressoWidget;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -26,378 +26,378 @@ 
 final class EE_Front_Controller
 {
 
-    /**
-     * @var string $_template_path
-     */
-    private $_template_path;
-
-    /**
-     * @var string $_template
-     */
-    private $_template;
-
-    /**
-     * @type EE_Registry $Registry
-     */
-    protected $Registry;
-
-    /**
-     * @type EE_Request_Handler $Request_Handler
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type EE_Module_Request_Router $Module_Request_Router
-     */
-    protected $Module_Request_Router;
-
-
-    /**
-     *    class constructor
-     *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
-     *
-     * @access    public
-     * @param \EE_Registry              $Registry
-     * @param \EE_Request_Handler       $Request_Handler
-     * @param \EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        EE_Request_Handler $Request_Handler,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry              = $Registry;
-        $this->Request_Handler       = $Request_Handler;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // determine how to integrate WP_Query with the EE models
-        add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy'));
-        // load other resources and begin to actually run shortcodes and modules
-        add_action('wp_loaded', array($this, 'wp_loaded'), 5);
-        // analyse the incoming WP request
-        add_action('parse_request', array($this, 'get_request'), 1, 1);
-        // process request with module factory
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
-        // before headers sent
-        add_action('wp', array($this, 'wp'), 5);
-        // primarily used to process any content shortcodes
-        add_action('template_redirect', array($this, 'templateRedirect'), 999);
-        // header
-        add_action('wp_head', array($this, 'header_meta_tag'), 5);
-        add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
-        add_filter('template_include', array($this, 'template_include'), 1);
-        // display errors
-        add_action('loop_start', array($this, 'display_errors'), 2);
-        // the content
-        // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
-        //exclude our private cpt comments
-        add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
-        //make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
-        add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
-        // action hook EE
-        do_action('AHEE__EE_Front_Controller__construct__done', $this);
-        // for checking that browser cookies are enabled
-        if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
-            setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/');
-        }
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     */
-    public function Request_Handler()
-    {
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    public function getLegacyShortcodesManager()
-    {
-        return EE_Config::getLegacyShortcodesManager();
-    }
-
-
-
-
-
-    /***********************************************        INIT ACTION HOOK         ***********************************************/
-
-
-
-    /**
-     * filter_wp_comments
-     * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
-     * widgets/queries done on frontend
-     *
-     * @param  array $clauses array of comment clauses setup by WP_Comment_Query
-     * @return array array of comment clauses with modifications.
-     */
-    public function filter_wp_comments($clauses)
-    {
-        global $wpdb;
-        if (strpos($clauses['join'], $wpdb->posts) !== false) {
-            $cpts = EE_Register_CPTs::get_private_CPTs();
-            foreach ($cpts as $cpt => $details) {
-                $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
-            }
-        }
-        return $clauses;
-    }
-
-
-    /**
-     *    employ_CPT_Strategy
-     *
-     * @access    public
-     * @return    void
-     */
-    public function employ_CPT_Strategy()
-    {
-        if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) {
-            $this->Registry->load_core('CPT_Strategy');
-        }
-    }
-
-
-    /**
-     * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
-     *
-     * @param  string $url incoming url
-     * @return string         final assembled url
-     */
-    public function maybe_force_admin_ajax_ssl($url)
-    {
-        if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
-            $url = str_replace('http://', 'https://', $url);
-        }
-        return $url;
-    }
-
-
-
-
-
-
-    /***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
-     *    default priority init phases have run
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-
-
-    /***********************************************        PARSE_REQUEST HOOK         ***********************************************/
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @param WP $WP
-     * @return void
-     */
-    public function get_request(WP $WP)
-    {
-        do_action('AHEE__EE_Front_Controller__get_request__start');
-        $this->Request_Handler->parse_request($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-    }
-
-
-
-    /**
-     *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
-     *
-     * @access    public
-     * @param   WP_Query $WP_Query
-     * @return    void
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // only load Module_Request_Router if this is the main query
-        if (
-            $this->Module_Request_Router instanceof EE_Module_Request_Router
-            && $WP_Query->is_main_query()
-        ) {
-            // cycle thru module routes
-            while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
-                // determine module and method for route
-                $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
-                if ($module instanceof EED_Module) {
-                    // get registered view for route
-                    $this->_template_path = $this->Module_Request_Router->get_view($route);
-                    // grab module name
-                    $module_name = $module->module_name();
-                    // map the module to the module objects
-                    $this->Registry->modules->{$module_name} = $module;
-                }
-            }
-        }
-    }
-
-
-
-
-
-    /***********************************************        WP HOOK         ***********************************************/
-
-
-    /**
-     *    wp - basically last chance to do stuff before headers sent
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-    }
-
-
-
-    /***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
-
-
-
-    /**
-     * callback for the "template_redirect" hook point
-     * checks sidebars for EE widgets
-     * loads resources and assets accordingly
-     *
-     * @return void
-     */
-    public function templateRedirect()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)){
-            return;
-        }
-        // if we already know this is an espresso page, then load assets
-        $load_assets = $this->Request_Handler->is_espresso_page();
-        // if we are already loading assets then just move along, otherwise check for widgets
-        $load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars();
-        if ( $load_assets){
-            wp_enqueue_style('espresso_default');
-            wp_enqueue_style('espresso_custom_css');
-            wp_enqueue_script('espresso_core');
-        }
-    }
-
-
-
-    /**
-     * builds list of active widgets then scans active sidebars looking for them
-     * returns true is an EE widget is found in an active sidebar
-     * Please Note: this does NOT mean that the sidebar or widget
-     * is actually in use in a given template, as that is unfortunately not known
-     * until a sidebar and it's widgets are actually loaded
-     *
-     * @return boolean
-     */
-    private function espresso_widgets_in_active_sidebars()
-    {
-        $espresso_widgets = array();
-        foreach ($this->Registry->widgets as $widget_class => $widget) {
-            $id_base = EspressoWidget::getIdBase($widget_class);
-            if (is_active_widget(false, false, $id_base)) {
-                $espresso_widgets[] = $id_base;
-            }
-        }
-        $all_sidebar_widgets = wp_get_sidebars_widgets();
-        foreach ($all_sidebar_widgets as $sidebar_name => $sidebar_widgets) {
-            if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
-                foreach ($sidebar_widgets as $sidebar_widget) {
-                    foreach ($espresso_widgets as $espresso_widget) {
-                        if (strpos($sidebar_widget, $espresso_widget) !== false) {
-                            return true;
-                        }
-                    }
-                }
-            }
-        }
-        return false;
-    }
-
-
-
-
-    /**
-     *    header_meta_tag
-     *
-     * @access    public
-     * @return    void
-     */
-    public function header_meta_tag()
-    {
-        print(
-            apply_filters(
-                'FHEE__EE_Front_Controller__header_meta_tag',
-                '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
-        );
-
-        //let's exclude all event type taxonomy term archive pages from search engine indexing
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/10249
-        //also exclude all critical pages from indexing
-        if (
-            (
-                is_tax('espresso_event_type')
-                && get_option( 'blog_public' ) !== '0'
-            )
-            || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
-        ) {
-            print(
-                apply_filters(
-                    'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                    '<meta name="robots" content="noindex,follow" />' . "\n"
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * wp_print_scripts
-     *
-     * @return void
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (
-            isset($post->EE_Event)
-            && $post->EE_Event instanceof EE_Event
-            && get_post_type() === 'espresso_events'
-            && is_singular()
-        ) {
-            \EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
-        }
-    }
-
-
-
-
-    /***********************************************        THE_CONTENT FILTER HOOK         **********************************************
+	/**
+	 * @var string $_template_path
+	 */
+	private $_template_path;
+
+	/**
+	 * @var string $_template
+	 */
+	private $_template;
+
+	/**
+	 * @type EE_Registry $Registry
+	 */
+	protected $Registry;
+
+	/**
+	 * @type EE_Request_Handler $Request_Handler
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type EE_Module_Request_Router $Module_Request_Router
+	 */
+	protected $Module_Request_Router;
+
+
+	/**
+	 *    class constructor
+	 *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
+	 *
+	 * @access    public
+	 * @param \EE_Registry              $Registry
+	 * @param \EE_Request_Handler       $Request_Handler
+	 * @param \EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		EE_Request_Handler $Request_Handler,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry              = $Registry;
+		$this->Request_Handler       = $Request_Handler;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// determine how to integrate WP_Query with the EE models
+		add_action('AHEE__EE_System__initialize', array($this, 'employ_CPT_Strategy'));
+		// load other resources and begin to actually run shortcodes and modules
+		add_action('wp_loaded', array($this, 'wp_loaded'), 5);
+		// analyse the incoming WP request
+		add_action('parse_request', array($this, 'get_request'), 1, 1);
+		// process request with module factory
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
+		// before headers sent
+		add_action('wp', array($this, 'wp'), 5);
+		// primarily used to process any content shortcodes
+		add_action('template_redirect', array($this, 'templateRedirect'), 999);
+		// header
+		add_action('wp_head', array($this, 'header_meta_tag'), 5);
+		add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
+		add_filter('template_include', array($this, 'template_include'), 1);
+		// display errors
+		add_action('loop_start', array($this, 'display_errors'), 2);
+		// the content
+		// add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
+		//exclude our private cpt comments
+		add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
+		//make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
+		add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
+		// action hook EE
+		do_action('AHEE__EE_Front_Controller__construct__done', $this);
+		// for checking that browser cookies are enabled
+		if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
+			setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/');
+		}
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 */
+	public function Request_Handler()
+	{
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	public function getLegacyShortcodesManager()
+	{
+		return EE_Config::getLegacyShortcodesManager();
+	}
+
+
+
+
+
+	/***********************************************        INIT ACTION HOOK         ***********************************************/
+
+
+
+	/**
+	 * filter_wp_comments
+	 * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
+	 * widgets/queries done on frontend
+	 *
+	 * @param  array $clauses array of comment clauses setup by WP_Comment_Query
+	 * @return array array of comment clauses with modifications.
+	 */
+	public function filter_wp_comments($clauses)
+	{
+		global $wpdb;
+		if (strpos($clauses['join'], $wpdb->posts) !== false) {
+			$cpts = EE_Register_CPTs::get_private_CPTs();
+			foreach ($cpts as $cpt => $details) {
+				$clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
+			}
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 *    employ_CPT_Strategy
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function employ_CPT_Strategy()
+	{
+		if (apply_filters('FHEE__EE_Front_Controller__employ_CPT_Strategy', true)) {
+			$this->Registry->load_core('CPT_Strategy');
+		}
+	}
+
+
+	/**
+	 * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
+	 *
+	 * @param  string $url incoming url
+	 * @return string         final assembled url
+	 */
+	public function maybe_force_admin_ajax_ssl($url)
+	{
+		if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
+			$url = str_replace('http://', 'https://', $url);
+		}
+		return $url;
+	}
+
+
+
+
+
+
+	/***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
+	 *    default priority init phases have run
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+
+
+	/***********************************************        PARSE_REQUEST HOOK         ***********************************************/
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function get_request(WP $WP)
+	{
+		do_action('AHEE__EE_Front_Controller__get_request__start');
+		$this->Request_Handler->parse_request($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+	}
+
+
+
+	/**
+	 *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
+	 *
+	 * @access    public
+	 * @param   WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// only load Module_Request_Router if this is the main query
+		if (
+			$this->Module_Request_Router instanceof EE_Module_Request_Router
+			&& $WP_Query->is_main_query()
+		) {
+			// cycle thru module routes
+			while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
+				// determine module and method for route
+				$module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
+				if ($module instanceof EED_Module) {
+					// get registered view for route
+					$this->_template_path = $this->Module_Request_Router->get_view($route);
+					// grab module name
+					$module_name = $module->module_name();
+					// map the module to the module objects
+					$this->Registry->modules->{$module_name} = $module;
+				}
+			}
+		}
+	}
+
+
+
+
+
+	/***********************************************        WP HOOK         ***********************************************/
+
+
+	/**
+	 *    wp - basically last chance to do stuff before headers sent
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+	}
+
+
+
+	/***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
+
+
+
+	/**
+	 * callback for the "template_redirect" hook point
+	 * checks sidebars for EE widgets
+	 * loads resources and assets accordingly
+	 *
+	 * @return void
+	 */
+	public function templateRedirect()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)){
+			return;
+		}
+		// if we already know this is an espresso page, then load assets
+		$load_assets = $this->Request_Handler->is_espresso_page();
+		// if we are already loading assets then just move along, otherwise check for widgets
+		$load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars();
+		if ( $load_assets){
+			wp_enqueue_style('espresso_default');
+			wp_enqueue_style('espresso_custom_css');
+			wp_enqueue_script('espresso_core');
+		}
+	}
+
+
+
+	/**
+	 * builds list of active widgets then scans active sidebars looking for them
+	 * returns true is an EE widget is found in an active sidebar
+	 * Please Note: this does NOT mean that the sidebar or widget
+	 * is actually in use in a given template, as that is unfortunately not known
+	 * until a sidebar and it's widgets are actually loaded
+	 *
+	 * @return boolean
+	 */
+	private function espresso_widgets_in_active_sidebars()
+	{
+		$espresso_widgets = array();
+		foreach ($this->Registry->widgets as $widget_class => $widget) {
+			$id_base = EspressoWidget::getIdBase($widget_class);
+			if (is_active_widget(false, false, $id_base)) {
+				$espresso_widgets[] = $id_base;
+			}
+		}
+		$all_sidebar_widgets = wp_get_sidebars_widgets();
+		foreach ($all_sidebar_widgets as $sidebar_name => $sidebar_widgets) {
+			if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
+				foreach ($sidebar_widgets as $sidebar_widget) {
+					foreach ($espresso_widgets as $espresso_widget) {
+						if (strpos($sidebar_widget, $espresso_widget) !== false) {
+							return true;
+						}
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+
+
+
+	/**
+	 *    header_meta_tag
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function header_meta_tag()
+	{
+		print(
+			apply_filters(
+				'FHEE__EE_Front_Controller__header_meta_tag',
+				'<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
+		);
+
+		//let's exclude all event type taxonomy term archive pages from search engine indexing
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/10249
+		//also exclude all critical pages from indexing
+		if (
+			(
+				is_tax('espresso_event_type')
+				&& get_option( 'blog_public' ) !== '0'
+			)
+			|| is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
+		) {
+			print(
+				apply_filters(
+					'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
+					'<meta name="robots" content="noindex,follow" />' . "\n"
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * wp_print_scripts
+	 *
+	 * @return void
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (
+			isset($post->EE_Event)
+			&& $post->EE_Event instanceof EE_Event
+			&& get_post_type() === 'espresso_events'
+			&& is_singular()
+		) {
+			\EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
+		}
+	}
+
+
+
+
+	/***********************************************        THE_CONTENT FILTER HOOK         **********************************************
 
 
 
@@ -408,99 +408,99 @@ 
     //  * @param   $the_content
     //  * @return    string
     //  */
-    // public function the_content( $the_content ) {
-    // 	// nothing gets loaded at this point unless other systems turn this hookpoint on by using:  add_filter( 'FHEE_run_EE_the_content', '__return_true' );
-    // 	if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) {
-    // 	}
-    // 	return $the_content;
-    // }
-
-
-
-    /***********************************************        WP_FOOTER         ***********************************************/
-
-
-    /**
-     * display_errors
-     *
-     * @access public
-     * @return void
-     */
-    public function display_errors()
-    {
-        static $shown_already = false;
-        do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (
-            ! $shown_already
-            && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
-            && is_main_query()
-            && ! is_feed()
-            && in_the_loop()
-            && $this->Request_Handler->is_espresso_page()
-        ) {
-            echo EE_Error::get_notices();
-            $shown_already = true;
-            EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-    /**
-     *    template_include
-     *
-     * @access    public
-     * @param   string $template_include_path
-     * @return    string
-     */
-    public function template_include($template_include_path = null)
-    {
-        if ($this->Request_Handler->is_espresso_page()) {
-            $this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path);
-            $template_path        = EEH_Template::locate_template($this->_template_path, array(), false);
-            $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
-            $this->_template      = basename($this->_template_path);
-            return $this->_template_path;
-        }
-        return $template_include_path;
-    }
-
-
-    /**
-     *    get_selected_template
-     *
-     * @access    public
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
-
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param string $shortcode_class
-     * @param \WP    $wp
-     */
-    public function initialize_shortcode($shortcode_class = '', WP $wp = null)
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
-    }
+	// public function the_content( $the_content ) {
+	// 	// nothing gets loaded at this point unless other systems turn this hookpoint on by using:  add_filter( 'FHEE_run_EE_the_content', '__return_true' );
+	// 	if ( apply_filters( 'FHEE_run_EE_the_content', FALSE ) ) {
+	// 	}
+	// 	return $the_content;
+	// }
+
+
+
+	/***********************************************        WP_FOOTER         ***********************************************/
+
+
+	/**
+	 * display_errors
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function display_errors()
+	{
+		static $shown_already = false;
+		do_action('AHEE__EE_Front_Controller__display_errors__begin');
+		if (
+			! $shown_already
+			&& apply_filters('FHEE__EE_Front_Controller__display_errors', true)
+			&& is_main_query()
+			&& ! is_feed()
+			&& in_the_loop()
+			&& $this->Request_Handler->is_espresso_page()
+		) {
+			echo EE_Error::get_notices();
+			$shown_already = true;
+			EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+	/**
+	 *    template_include
+	 *
+	 * @access    public
+	 * @param   string $template_include_path
+	 * @return    string
+	 */
+	public function template_include($template_include_path = null)
+	{
+		if ($this->Request_Handler->is_espresso_page()) {
+			$this->_template_path = ! empty($this->_template_path) ? basename($this->_template_path) : basename($template_include_path);
+			$template_path        = EEH_Template::locate_template($this->_template_path, array(), false);
+			$this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
+			$this->_template      = basename($this->_template_path);
+			return $this->_template_path;
+		}
+		return $template_include_path;
+	}
+
+
+	/**
+	 *    get_selected_template
+	 *
+	 * @access    public
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param string $shortcode_class
+	 * @param \WP    $wp
+	 */
+	public function initialize_shortcode($shortcode_class = '', WP $wp = null)
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		$this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
+	}
 
 }
 // End of file EE_Front_Controller.core.php

Spacing +7 added lines, -7 removed lines

@@ -97,7 +97,7 @@ 
         do_action('AHEE__EE_Front_Controller__construct__done', $this);
         // for checking that browser cookies are enabled
         if (apply_filters('FHEE__EE_Front_Controller____construct__set_test_cookie', true)) {
-            setcookie('ee_cookie_test', uniqid('ect',true), time() + DAY_IN_SECONDS, '/');
+            setcookie('ee_cookie_test', uniqid('ect', true), time() + DAY_IN_SECONDS, '/');
         }
     }
 
@@ -289,14 +289,14 @@ 
     public function templateRedirect()
     {
         global $wp_query;
-        if (empty($wp_query->posts)){
+        if (empty($wp_query->posts)) {
             return;
         }
         // if we already know this is an espresso page, then load assets
         $load_assets = $this->Request_Handler->is_espresso_page();
         // if we are already loading assets then just move along, otherwise check for widgets
         $load_assets = $load_assets ? $load_assets : $this->espresso_widgets_in_active_sidebars();
-        if ( $load_assets){
+        if ($load_assets) {
             wp_enqueue_style('espresso_default');
             wp_enqueue_style('espresso_custom_css');
             wp_enqueue_script('espresso_core');
@@ -352,7 +352,7 @@ 
         print(
             apply_filters(
                 'FHEE__EE_Front_Controller__header_meta_tag',
-                '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n")
+                '<meta name="generator" content="Event Espresso Version '.EVENT_ESPRESSO_VERSION."\" />\n")
         );
 
         //let's exclude all event type taxonomy term archive pages from search engine indexing
@@ -361,14 +361,14 @@ 
         if (
             (
                 is_tax('espresso_event_type')
-                && get_option( 'blog_public' ) !== '0'
+                && get_option('blog_public') !== '0'
             )
             || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
         ) {
             print(
                 apply_filters(
                     'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                    '<meta name="robots" content="noindex,follow" />' . "\n"
+                    '<meta name="robots" content="noindex,follow" />'."\n"
                 )
             );
         }
@@ -440,7 +440,7 @@ 
         ) {
             echo EE_Error::get_notices();
             $shown_already = true;
-            EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+            EEH_Template::display_template(EE_TEMPLATES.'espresso-ajax-notices.template.php');
         }
         do_action('AHEE__EE_Front_Controller__display_errors__end');
     }

core/db_classes/EE_Registration.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -1072,7 +1072,7 @@ 
      * Sets deleted
      *
      * @param boolean $deleted
-     * @return boolean
+     * @return boolean|null
      */
     public function set_deleted($deleted)
     {
@@ -1125,6 +1125,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
      */
     public function can_checkin($DTT_OR_ID, $check_approved = true)
@@ -1278,7 +1279,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()
@@ -1557,7 +1558,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()
     {

Spacing +13 added lines, -13 removed lines

@@ -1,6 +1,6 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -106,7 +106,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;
@@ -281,7 +281,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;
@@ -673,7 +673,7 @@ 
      */
     public function reg_url_link()
     {
-        return (string)$this->get('REG_url_link');
+        return (string) $this->get('REG_url_link');
     }
 
 
@@ -934,7 +934,7 @@ 
                 $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
                 break;
         }
-        return $icon . $status[$this->status_ID()];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -1136,7 +1136,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,
@@ -1164,7 +1164,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return false;
         }
 
@@ -1172,7 +1172,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;
         }
 
@@ -1221,7 +1221,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(
                     __('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',
@@ -1393,7 +1393,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;
@@ -1440,11 +1440,11 @@ 
             EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
             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__,
                 __('Can not change a registration REG_code once it has been set.', 'event_espresso'),
                 '4.6.0'
             );
@@ -1590,7 +1590,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;

Indentation +1685 added lines, -1685 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -15,1690 +15,1690 @@ 
 {
 
 
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @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
-     */
-    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
-     */
-    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 \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
-     * @return bool
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function set_status($new_STS_ID = null, $use_default = false)
-    {
-        // 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);
-                // OR FROM  approved
-            } else if ($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);
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
-            /** @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);
-            do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID);
-            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
-     * @throws \EE_Error
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
-    {
-        // 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
-        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);
-            return;
-        }
-        // 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);
-        }
-    }
-
-
-    /**
-     *        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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param        int $TXN_ID Transaction ID
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param    string $REG_session PHP Session ID
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param    string $REG_url_link Registration URL Link
-     */
-    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
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param        boolean $REG_group_size Group Registration
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     *
-     * @return string
-     */
-    public function payment_overview_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'payment_options',
-            'revisit'        => true,
-        ), 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
-     */
-    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
-     */
-    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
-     */
-    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
-        $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
-     */
-    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
-     */
-    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
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return    float
-     */
-    public function paid()
-    {
-        return $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return    float
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('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[]
-     */
-    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)
-     */
-    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[]
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return boolean
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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.
-     */
-    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(__('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(
-                    __('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_Registration::checkin_status_never => EE_Registration::checkin_status_in,
-            EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
-            EE_Registration::checkin_status_out   => EE_Registration::checkin_status_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_Registration::checkin_status_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(
-                    __('Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = __('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_Registration::checkin_status_in; //checked in
-            }
-            return EE_Registration::checkin_status_out; //had checked in but is now checked out.
-        }
-        return EE_Registration::checkin_status_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
-     */
-    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_Registration::checkin_status_never :
-                    return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
-                        $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_in :
-                    return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_out :
-                    return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-                    break;
-            }
-        }
-        return __("The check-in status could not be determined.", "event_espresso");
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     */
-    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
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     *        Set Registration Code
-     *
-     * @access    public
-     * @param    string  $REG_code Registration Code
-     * @param    boolean $use_default
-     */
-    public function set_reg_code($REG_code, $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(__('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__,
-                __('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.
-     */
-    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(),
-        );
-
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    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
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    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();
-    }
-
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::price_paid()',
-            __('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
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
-            __('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
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
-            __('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
-     */
-    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.
+	 *
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @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
+	 */
+	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
+	 */
+	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 \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
+	 * @return bool
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false)
+	{
+		// 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);
+				// OR FROM  approved
+			} else if ($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);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
+			/** @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);
+			do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID);
+			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
+	 * @throws \EE_Error
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
+	{
+		// 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
+		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);
+			return;
+		}
+		// 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);
+		}
+	}
+
+
+	/**
+	 *        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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param        int $TXN_ID Transaction ID
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param    string $REG_session PHP Session ID
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param    string $REG_url_link Registration URL Link
+	 */
+	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
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param        boolean $REG_group_size Group Registration
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 *
+	 * @return string
+	 */
+	public function payment_overview_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'payment_options',
+			'revisit'        => true,
+		), 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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+		$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
+	 */
+	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
+	 */
+	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
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return    float
+	 */
+	public function paid()
+	{
+		return $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return    float
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('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[]
+	 */
+	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)
+	 */
+	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[]
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return boolean
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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.
+	 */
+	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(__('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(
+					__('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_Registration::checkin_status_never => EE_Registration::checkin_status_in,
+			EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
+			EE_Registration::checkin_status_out   => EE_Registration::checkin_status_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_Registration::checkin_status_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(
+					__('Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = __('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_Registration::checkin_status_in; //checked in
+			}
+			return EE_Registration::checkin_status_out; //had checked in but is now checked out.
+		}
+		return EE_Registration::checkin_status_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
+	 */
+	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_Registration::checkin_status_never :
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
+						$attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_in :
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_out :
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+					break;
+			}
+		}
+		return __("The check-in status could not be determined.", "event_espresso");
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 */
+	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
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 *        Set Registration Code
+	 *
+	 * @access    public
+	 * @param    string  $REG_code Registration Code
+	 * @param    boolean $use_default
+	 */
+	public function set_reg_code($REG_code, $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(__('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__,
+				__('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.
+	 */
+	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(),
+		);
+
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	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
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	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();
+	}
+
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::price_paid()',
+			__('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
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
+			__('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
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
+			__('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
+	 */
+	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();
+	}
 
 
 }

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

Indentation +244 added lines, -244 removed lines

@@ -14,248 +14,248 @@
 abstract class EE_Form_Section_Layout_Base
 {
 
-    /**
-     * Form form section to lay out
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_form_section;
-
-
-
-    /**
-     *  __construct
-     */
-    function __construct()
-    {
-    }
-
-
-
-    /**
-     * The form section on which this strategy is to perform
-     *
-     * @param EE_Form_Section_Proper $form
-     */
-    public function _construct_finalize(EE_Form_Section_Proper $form)
-    {
-        $this->_form_section = $form;
-    }
-
-
-
-    /**
-     * @return \EE_Form_Section_Proper
-     */
-    public function form_section()
-    {
-        return $this->_form_section;
-    }
-
-
-
-    /**
-     * Also has teh side effect of enqueuing any needed JS and CSS for
-     * this form.
-     * Creates all the HTML necessary for displaying this form, its inputs, and
-     * proper subsections.
-     * Returns the HTML
-     *
-     * @return string HTML for displaying
-     */
-    public function layout_form()
-    {
-        $html = '';
-        // layout_form_begin
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
-            $this->layout_form_begin(),
-            $this->_form_section
-        );
-        // layout_form_loop
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
-            $this->layout_form_loop(),
-            $this->_form_section
-        );
-        // layout_form_end
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
-            $this->layout_form_end(),
-            $this->_form_section
-        );
-        $html = $this->add_form_section_hooks_and_filters($html);
-        return $html;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function layout_form_loop()
-    {
-        $html = '';
-        foreach ($this->_form_section->subsections() as $name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_input($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            } elseif ($subsection instanceof EE_Form_Section_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_subsection($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
-     *
-     * @return string
-     */
-    abstract public function layout_form_begin();
-
-
-
-    /**
-     * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
-     *
-     * @return string
-     */
-    abstract public function layout_form_end();
-
-
-
-    /**
-     * Should be used internally by layout_form() to layout each input (eg, if this layout
-     * is putting each input in a row of its own, this should probably be called by a
-     *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
-     * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
-     * customize the form's layout, but would like to make use of it for laying out
-     * 'easy-to-layout' inputs
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string html
-     */
-    abstract public function layout_input($input);
-
-
-
-    /**
-     * Similar to layout_input(), should be used internally by layout_form() within a
-     * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed
-     * that the proper subsection will layout its container, label, etc on its own.
-     *
-     * @param EE_Form_Section_Base $subsection
-     * @return string html
-     */
-    abstract public function layout_subsection($subsection);
-
-
-
-    /**
-     * Gets the HTML for the label tag and its contents for the input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_label($input)
-    {
-        $class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class();
-        $label_text = $input->required()
-            ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
-            : $input->html_label_text();
-        return '<label id="'
-               . $input->html_label_id()
-               . '" class="'
-               . $class
-               . '" style="'
-               . $input->html_label_style()
-               . '" for="' . $input->html_name()
-               . '">'
-               . $label_text
-               . '</label>';
-    }
-
-
-
-    /**
-     * returns the HTML for the server-side validation errors for the specified input
-     * Note that if JS is enabled, it should remove these and instead
-     * populate the form's errors in the jquery validate fashion
-     * using the localized data provided to the JS
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_errors($input)
-    {
-        if ($input->get_validation_errors()) {
-            return "<label  id='"
-                   . $input->html_id()
-                   . "-error' class='error' for='{$input->html_name()}'>"
-                   . $input->get_validation_error_string()
-                   . "</label>";
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Displays the help span for the specified input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_help_text($input)
-    {
-        if ($input->html_help_text() != '') {
-            $tag = is_admin() ? 'p' : 'span';
-            return '<'
-                   . $tag
-                   . ' id="'
-                   . $input->html_id()
-                   . '-help" class="'
-                   . $input->html_help_class()
-                   . '" style="'
-                   . $input->html_help_style()
-                   . '">'
-                   . $input->html_help_text()
-                   . '</'
-                   . $tag
-                   . '>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     * Does an action and hook onto the end of teh form
-     *
-     * @param string $html
-     * @return string
-     */
-    public function add_form_section_hooks_and_filters($html)
-    {
-        // replace dashes and spaces with underscores
-        $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
-        $html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section);
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
-        return $html;
-    }
+	/**
+	 * Form form section to lay out
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_form_section;
+
+
+
+	/**
+	 *  __construct
+	 */
+	function __construct()
+	{
+	}
+
+
+
+	/**
+	 * The form section on which this strategy is to perform
+	 *
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function _construct_finalize(EE_Form_Section_Proper $form)
+	{
+		$this->_form_section = $form;
+	}
+
+
+
+	/**
+	 * @return \EE_Form_Section_Proper
+	 */
+	public function form_section()
+	{
+		return $this->_form_section;
+	}
+
+
+
+	/**
+	 * Also has teh side effect of enqueuing any needed JS and CSS for
+	 * this form.
+	 * Creates all the HTML necessary for displaying this form, its inputs, and
+	 * proper subsections.
+	 * Returns the HTML
+	 *
+	 * @return string HTML for displaying
+	 */
+	public function layout_form()
+	{
+		$html = '';
+		// layout_form_begin
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+			$this->layout_form_begin(),
+			$this->_form_section
+		);
+		// layout_form_loop
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+			$this->layout_form_loop(),
+			$this->_form_section
+		);
+		// layout_form_end
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+			$this->layout_form_end(),
+			$this->_form_section
+		);
+		$html = $this->add_form_section_hooks_and_filters($html);
+		return $html;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function layout_form_loop()
+	{
+		$html = '';
+		foreach ($this->_form_section->subsections() as $name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(),
+					$this->layout_input($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			} elseif ($subsection instanceof EE_Form_Section_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(),
+					$this->layout_subsection($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_begin();
+
+
+
+	/**
+	 * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_end();
+
+
+
+	/**
+	 * Should be used internally by layout_form() to layout each input (eg, if this layout
+	 * is putting each input in a row of its own, this should probably be called by a
+	 *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
+	 * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
+	 * customize the form's layout, but would like to make use of it for laying out
+	 * 'easy-to-layout' inputs
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string html
+	 */
+	abstract public function layout_input($input);
+
+
+
+	/**
+	 * Similar to layout_input(), should be used internally by layout_form() within a
+	 * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed
+	 * that the proper subsection will layout its container, label, etc on its own.
+	 *
+	 * @param EE_Form_Section_Base $subsection
+	 * @return string html
+	 */
+	abstract public function layout_subsection($subsection);
+
+
+
+	/**
+	 * Gets the HTML for the label tag and its contents for the input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_label($input)
+	{
+		$class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class();
+		$label_text = $input->required()
+			? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+			: $input->html_label_text();
+		return '<label id="'
+			   . $input->html_label_id()
+			   . '" class="'
+			   . $class
+			   . '" style="'
+			   . $input->html_label_style()
+			   . '" for="' . $input->html_name()
+			   . '">'
+			   . $label_text
+			   . '</label>';
+	}
+
+
+
+	/**
+	 * returns the HTML for the server-side validation errors for the specified input
+	 * Note that if JS is enabled, it should remove these and instead
+	 * populate the form's errors in the jquery validate fashion
+	 * using the localized data provided to the JS
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_errors($input)
+	{
+		if ($input->get_validation_errors()) {
+			return "<label  id='"
+				   . $input->html_id()
+				   . "-error' class='error' for='{$input->html_name()}'>"
+				   . $input->get_validation_error_string()
+				   . "</label>";
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Displays the help span for the specified input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_help_text($input)
+	{
+		if ($input->html_help_text() != '') {
+			$tag = is_admin() ? 'p' : 'span';
+			return '<'
+				   . $tag
+				   . ' id="'
+				   . $input->html_id()
+				   . '-help" class="'
+				   . $input->html_help_class()
+				   . '" style="'
+				   . $input->html_help_style()
+				   . '">'
+				   . $input->html_help_text()
+				   . '</'
+				   . $tag
+				   . '>';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * Does an action and hook onto the end of teh form
+	 *
+	 * @param string $html
+	 * @return string
+	 */
+	public function add_form_section_hooks_and_filters($html)
+	{
+		// replace dashes and spaces with underscores
+		$hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
+		do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+		$html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section);
+		$html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
+		$html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+		return $html;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -68,19 +68,19 @@ 
         $html = '';
         // layout_form_begin
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_'.$this->_form_section->name(),
             $this->layout_form_begin(),
             $this->_form_section
         );
         // layout_form_loop
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_'.$this->_form_section->name(),
             $this->layout_form_loop(),
             $this->_form_section
         );
         // layout_form_end
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_'.$this->_form_section->name(),
             $this->layout_form_end(),
             $this->_form_section
         );
@@ -99,14 +99,14 @@ 
         foreach ($this->_form_section->subsections() as $name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
                 $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(),
+                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'.$name.'__in_'.$this->_form_section->name(),
                     $this->layout_input($subsection),
                     $this->_form_section,
                     $subsection
                 );
             } elseif ($subsection instanceof EE_Form_Section_Base) {
                 $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(),
+                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'.$name.'__in_'.$this->_form_section->name(),
                     $this->layout_subsection($subsection),
                     $this->_form_section,
                     $subsection
@@ -171,9 +171,9 @@ 
      */
     public function display_label($input)
     {
-        $class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class();
+        $class = $input->required() ? 'ee-required-label '.$input->html_label_class() : $input->html_label_class();
         $label_text = $input->required()
-            ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+            ? $input->html_label_text().'<span class="ee-asterisk">*</span>'
             : $input->html_label_text();
         return '<label id="'
                . $input->html_label_id()
@@ -181,7 +181,7 @@ 
                . $class
                . '" style="'
                . $input->html_label_style()
-               . '" for="' . $input->html_name()
+               . '" for="'.$input->html_name()
                . '">'
                . $label_text
                . '</label>';
@@ -252,10 +252,10 @@ 
     {
         // replace dashes and spaces with underscores
         $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
-        $html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section);
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+        do_action('AHEE__Form_Section_Layout__'.$hook_name, $this->_form_section);
+        $html = apply_filters('AFEE__Form_Section_Layout__'.$hook_name.'__html', $html, $this->_form_section);
+        $html .= EEH_HTML::nl().'<!-- AHEE__Form_Section_Layout__'.$hook_name.'__html -->';
+        $html .= EEH_HTML::nl().'<!-- AFEE__Form_Section_Layout__'.$hook_name.' -->';
         return $html;
     }
 }

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

Indentation +59 added lines, -59 removed lines

@@ -9,69 +9,69 @@
 class EE_Admin_Two_Column_Layout extends EE_Two_Column_Layout
 {
 
-    /**
-     * Overriding the parent table layout to include <tbody> tags
-     *
-     * @param array $additional_args
-     * @return string
-     */
-    public function layout_form_begin($additional_args = array())
-    {
-        $this->_form_section->set_html_class('form-table');
-        return parent::layout_form_begin($additional_args);
-    }
+	/**
+	 * Overriding the parent table layout to include <tbody> tags
+	 *
+	 * @param array $additional_args
+	 * @return string
+	 */
+	public function layout_form_begin($additional_args = array())
+	{
+		$this->_form_section->set_html_class('form-table');
+		return parent::layout_form_begin($additional_args);
+	}
 
 
 
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        if ($form_section instanceof EE_Form_Section_Proper) {
-            return EEH_HTML::no_row($form_section->get_html(), 2);
-        } elseif ($form_section instanceof EE_Form_Section_HTML) {
-            return EEH_HTML::no_row($form_section->get_html(), 2);
-        }
-        return '';
-    }
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		if ($form_section instanceof EE_Form_Section_Proper) {
+			return EEH_HTML::no_row($form_section->get_html(), 2);
+		} elseif ($form_section instanceof EE_Form_Section_HTML) {
+			return EEH_HTML::no_row($form_section->get_html(), 2);
+		}
+		return '';
+	}
 
 
 
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function layout_input($input)
-    {
-        if ($input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy
-            || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
-            || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
-        ) {
-            $input->set_html_class($input->html_class() . ' large-text');
-        }
-        if ($input instanceof EE_Text_Area_Input) {
-            $input->set_rows(4);
-            $input->set_cols(60);
-        }
-        $input_html = $input->get_html_for_input();
-        // maybe add errors and help text ?
-        $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : '';
-        $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
-        //overriding parent to add wp admin specific things.
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::no_row($input->get_html_for_input(), 2);
-        } else {
-            $html .= EEH_HTML::tr(
-                EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html)
-            );
-        }
-        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)
+	{
+		if ($input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy
+			|| $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
+			|| $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
+		) {
+			$input->set_html_class($input->html_class() . ' large-text');
+		}
+		if ($input instanceof EE_Text_Area_Input) {
+			$input->set_rows(4);
+			$input->set_cols(60);
+		}
+		$input_html = $input->get_html_for_input();
+		// maybe add errors and help text ?
+		$input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : '';
+		$input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
+		//overriding parent to add wp admin specific things.
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::no_row($input->get_html_for_input(), 2);
+		} else {
+			$html .= EEH_HTML::tr(
+				EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html)
+			);
+		}
+		return $html;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -53,7 +53,7 @@ 
             || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
             || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
         ) {
-            $input->set_html_class($input->html_class() . ' large-text');
+            $input->set_html_class($input->html_class().' large-text');
         }
         if ($input instanceof EE_Text_Area_Input) {
             $input->set_rows(4);
@@ -61,15 +61,15 @@ 
         }
         $input_html = $input->get_html_for_input();
         // maybe add errors and help text ?
-        $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : '';
-        $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
+        $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl().$input->get_html_for_errors() : '';
+        $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl().$input->get_html_for_help() : '';
         //overriding parent to add wp admin specific things.
         $html = '';
         if ($input instanceof EE_Hidden_Input) {
             $html .= EEH_HTML::no_row($input->get_html_for_input(), 2);
         } else {
             $html .= EEH_HTML::tr(
-                EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html)
+                EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"').EEH_HTML::td($input_html)
             );
         }
         return $html;

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

Indentation +104 added lines, -104 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,109 +16,109 @@ 
 class EE_Fieldset_Section_Layout extends EE_Div_Per_Section_Layout
 {
 
-    /**
-     * legend_class
-     *
-     * @var string
-     */
-    protected $_legend_class;
-
-    /**
-     * legend_text
-     *
-     * @var string
-     */
-    protected $_legend_text;
-
-
-
-    /**
-     *    construct
-     *
-     * @param array $options
-     */
-    public function __construct($options = array())
-    {
-        foreach ($options as $key => $value) {
-            $key = '_' . $key;
-            if (property_exists($this, $key)) {
-                $this->{$key} = $value;
-            }
-        }
-    }
-
-
-
-    /**
-     * opening div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        $html = EEH_HTML::nl(1)
-                . '<fieldset id="'
-                . $this->_form_section->html_id()
-                . '" class="'
-                . $this->_form_section->html_class()
-                . '" style="'
-                . $this->_form_section->html_style()
-                . '">';
-        $html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>';
-        return $html;
-    }
-
-
-
-    /**
-     * closing div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        return EEH_HTML::nl(-1) . '</fieldset>';
-    }
-
-
-
-    /**
-     * @param string $legend_class
-     */
-    public function set_legend_class($legend_class)
-    {
-        $this->_legend_class = $legend_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function legend_class()
-    {
-        return $this->_legend_class;
-    }
-
-
-
-    /**
-     * @param string $legend_text
-     */
-    public function set_legend_text($legend_text)
-    {
-        $this->_legend_text = $legend_text;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function legend_text()
-    {
-        return $this->_legend_text;
-    }
+	/**
+	 * legend_class
+	 *
+	 * @var string
+	 */
+	protected $_legend_class;
+
+	/**
+	 * legend_text
+	 *
+	 * @var string
+	 */
+	protected $_legend_text;
+
+
+
+	/**
+	 *    construct
+	 *
+	 * @param array $options
+	 */
+	public function __construct($options = array())
+	{
+		foreach ($options as $key => $value) {
+			$key = '_' . $key;
+			if (property_exists($this, $key)) {
+				$this->{$key} = $value;
+			}
+		}
+	}
+
+
+
+	/**
+	 * opening div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		$html = EEH_HTML::nl(1)
+				. '<fieldset id="'
+				. $this->_form_section->html_id()
+				. '" class="'
+				. $this->_form_section->html_class()
+				. '" style="'
+				. $this->_form_section->html_style()
+				. '">';
+		$html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>';
+		return $html;
+	}
+
+
+
+	/**
+	 * closing div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		return EEH_HTML::nl(-1) . '</fieldset>';
+	}
+
+
+
+	/**
+	 * @param string $legend_class
+	 */
+	public function set_legend_class($legend_class)
+	{
+		$this->_legend_class = $legend_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function legend_class()
+	{
+		return $this->_legend_class;
+	}
+
+
+
+	/**
+	 * @param string $legend_text
+	 */
+	public function set_legend_text($legend_text)
+	{
+		$this->_legend_text = $legend_text;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function legend_text()
+	{
+		return $this->_legend_text;
+	}
 
 
 

Spacing +4 added lines, -4 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -40,7 +40,7 @@ 
     public function __construct($options = array())
     {
         foreach ($options as $key => $value) {
-            $key = '_' . $key;
+            $key = '_'.$key;
             if (property_exists($this, $key)) {
                 $this->{$key} = $value;
             }
@@ -64,7 +64,7 @@ 
                 . '" style="'
                 . $this->_form_section->html_style()
                 . '">';
-        $html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>';
+        $html .= '<legend class="'.$this->legend_class().'">'.$this->legend_text().'</legend>';
         return $html;
     }
 
@@ -77,7 +77,7 @@ 
      */
     public function layout_form_end()
     {
-        return EEH_HTML::nl(-1) . '</fieldset>';
+        return EEH_HTML::nl(-1).'</fieldset>';
     }
 
 

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

Indentation +113 added lines, -113 removed lines

@@ -15,117 +15,117 @@
 {
 
 
-    /**
-     * This is a flag indicating whether to use '<br>' tags after each input in the layout
-     * strategy.
-     *
-     * @var bool
-     */
-    protected $_use_break_tags = true;
-
-
-
-    /**
-     * EE_No_Layout constructor.
-     *
-     * @param array $options  Currently if this has a 'use_break_tags' key that is used to set the _use_break_tags
-     *                        property on the class.
-     */
-    public function __construct($options = array())
-    {
-        $this->_use_break_tags = is_array($options) && isset($options['use_break_tags'])
-            ? filter_var($options['use_break_tags'], FILTER_VALIDATE_BOOLEAN)
-            : $this->_use_break_tags;
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Add line break at beginning of form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        return EEH_HTML::nl(1);
-    }
-
-
-
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws \EE_Error
-     */
-    public function layout_input($input)
-    {
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-        } elseif ($input instanceof EE_Submit_Input) {
-            $html .= $this->br();
-            $html .= $input->get_html_for_input();
-        } elseif ($input instanceof EE_Select_Input) {
-            $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
-            $html .= $this->br();
-        } elseif ($input instanceof EE_Form_Input_With_Options_Base) {
-            $html .= $this->br();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
-        } else {
-            $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
-        }
-        $html .= EEH_HTML::nl(-1);
-        return $html;
-    }
-
-
-
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
-    }
-
-
-
-    /**
-     * Add line break at end of form.
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        return EEH_HTML::nl(-1);
-    }
-
-
-
-    /**
-     * This returns a break tag or an empty string depending on the value of the `_use_break_tags` property.
-     *
-     * @return string
-     */
-    protected function br()
-    {
-        return $this->_use_break_tags ? EEH_HTML::br() : '';
-    }
+	/**
+	 * This is a flag indicating whether to use '<br>' tags after each input in the layout
+	 * strategy.
+	 *
+	 * @var bool
+	 */
+	protected $_use_break_tags = true;
+
+
+
+	/**
+	 * EE_No_Layout constructor.
+	 *
+	 * @param array $options  Currently if this has a 'use_break_tags' key that is used to set the _use_break_tags
+	 *                        property on the class.
+	 */
+	public function __construct($options = array())
+	{
+		$this->_use_break_tags = is_array($options) && isset($options['use_break_tags'])
+			? filter_var($options['use_break_tags'], FILTER_VALIDATE_BOOLEAN)
+			: $this->_use_break_tags;
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Add line break at beginning of form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		return EEH_HTML::nl(1);
+	}
+
+
+
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function layout_input($input)
+	{
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+		} elseif ($input instanceof EE_Submit_Input) {
+			$html .= $this->br();
+			$html .= $input->get_html_for_input();
+		} elseif ($input instanceof EE_Select_Input) {
+			$html .= $this->br();
+			$html .= EEH_HTML::nl(1) . $input->get_html_for_label();
+			$html .= EEH_HTML::nl() . $input->get_html_for_errors();
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+			$html .= EEH_HTML::nl() . $input->get_html_for_help();
+			$html .= $this->br();
+		} elseif ($input instanceof EE_Form_Input_With_Options_Base) {
+			$html .= $this->br();
+			$html .= EEH_HTML::nl() . $input->get_html_for_errors();
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+			$html .= EEH_HTML::nl() . $input->get_html_for_help();
+		} else {
+			$html .= $this->br();
+			$html .= EEH_HTML::nl(1) . $input->get_html_for_label();
+			$html .= EEH_HTML::nl() . $input->get_html_for_errors();
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+			$html .= EEH_HTML::nl() . $input->get_html_for_help();
+		}
+		$html .= EEH_HTML::nl(-1);
+		return $html;
+	}
+
+
+
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		//		d( $form_section );
+		return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+	}
+
+
+
+	/**
+	 * Add line break at end of form.
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		return EEH_HTML::nl(-1);
+	}
+
+
+
+	/**
+	 * This returns a break tag or an empty string depending on the value of the `_use_break_tags` property.
+	 *
+	 * @return string
+	 */
+	protected function br()
+	{
+		return $this->_use_break_tags ? EEH_HTML::br() : '';
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -64,28 +64,28 @@ 
     {
         $html = '';
         if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
         } elseif ($input instanceof EE_Submit_Input) {
             $html .= $this->br();
             $html .= $input->get_html_for_input();
         } elseif ($input instanceof EE_Select_Input) {
             $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
+            $html .= EEH_HTML::nl(1).$input->get_html_for_label();
+            $html .= EEH_HTML::nl().$input->get_html_for_errors();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_help();
             $html .= $this->br();
         } elseif ($input instanceof EE_Form_Input_With_Options_Base) {
             $html .= $this->br();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
+            $html .= EEH_HTML::nl().$input->get_html_for_errors();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_help();
         } else {
             $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
+            $html .= EEH_HTML::nl(1).$input->get_html_for_label();
+            $html .= EEH_HTML::nl().$input->get_html_for_errors();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_help();
         }
         $html .= EEH_HTML::nl(-1);
         return $html;
@@ -102,7 +102,7 @@ 
     public function layout_subsection($form_section)
     {
         //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+        return EEH_HTML::nl(1).$form_section->get_html().EEH_HTML::nl(-1);
     }