eventespresso / event-espresso-core

core/helpers/EEH_DTT_Helper.helper.php

Indentation +1027 added lines, -1027 removed lines

@@ -21,1031 +21,1031 @@
 {
 
 
-    /**
-     * return the timezone set for the WP install
-     *
-     * @return string valid timezone string for PHP DateTimeZone() class
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-     *
-     * @param string $timezone_string
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_valid_timezone_string($timezone_string = '')
-    {
-        return self::getHelperAdapter()->getValidTimezoneString($timezone_string);
-    }
-
-
-    /**
-     * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @static
-     * @param  string $timezone_string Timezone string to check
-     * @param bool    $throw_error
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function validate_timezone($timezone_string, $throw_error = true)
-    {
-        return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error);
-    }
-
-
-    /**
-     * This returns a string that can represent the provided gmt offset in format that can be passed into
-     * DateTimeZone.  This is NOT a string that can be passed as a value on the WordPress timezone_string option.
-     *
-     * @param float|string $gmt_offset
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
-    {
-        return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset);
-    }
-
-
-    /**
-     * 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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_site_timezone_gmt_offset()
-    {
-        return self::getHelperAdapter()->getSiteTimezoneGmtOffset();
-    }
-
-
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @deprecated 4.9.54.rc    Developers this was always meant to only be an internally used method.  This will be
-     *                          removed in a future version of EE.
-     * @param int $gmt_offset
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
-    {
-        return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset);
-    }
-
-
-    /**
-     * get_timezone_string_from_abbreviations_list
-     *
-     * @deprecated 4.9.54.rc  Developers, this was never intended to be public.  This is a soft deprecation for now.
-     *                        If you are using this, you'll want to work out an alternate way of getting the value.
-     * @param int  $gmt_offset
-     * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
-    {
-        $gmt_offset =  (int) $gmt_offset;
-        /** @var array[] $abbreviations */
-        $abbreviations = DateTimeZone::listAbbreviations();
-        foreach ($abbreviations as $abbreviation) {
-            foreach ($abbreviation as $timezone) {
-                if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
-                    try {
-                        $offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id']));
-                        if ($offset !== $gmt_offset) {
-                            continue;
-                        }
-                        return $timezone['timezone_id'];
-                    } catch (Exception $e) {
-                        continue;
-                    }
-                }
-            }
-        }
-        //if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
-        if ($coerce === true) {
-            $timezone_string = self::get_timezone_string_from_abbreviations_list(
-                self::adjust_invalid_gmt_offsets($gmt_offset),
-                false
-            );
-            if ($timezone_string) {
-                return $timezone_string;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    '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 / HOUR_IN_SECONDS,
-                '<a href="http://www.php.net/manual/en/timezones.php">',
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * Get Timezone Transitions
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
-    {
-        return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only);
-    }
-
-
-    /**
-     * Get Timezone Offset for given timezone object.
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null         $time
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
-    {
-        return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time);
-    }
-
-
-    /**
-     * Prints a select input for the given timezone string.
-     * @param string $timezone_string
-     * @deprecatd 4.9.54.rc   Soft deprecation.  Consider using \EEH_DTT_Helper::wp_timezone_choice instead.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function timezone_select_input($timezone_string = '')
-    {
-        self::getHelperAdapter()->timezoneSelectInput($timezone_string);
-    }
-
-
-    /**
-     * 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.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
-    {
-        return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string);
-    }
-
-
-    /**
-     *    _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
-     * @throws EE_Error
-     */
-    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)
-     * @throws EE_Error
-     * @throws Exception
-     */
-    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
-     * @throws EE_Error
-     * @throws Exception
-     */
-    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  int|string $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 Exception
-     * @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(
-                    esc_html__('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 int
-     * @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(
-                    esc_html__('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.
-     * @throws Exception
-     * @throws EE_Error
-     */
-    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
-            );
-        }
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
-            return EEH_DTT_Helper::_modify_timestamp(
-                $DateTime_or_timestamp,
-                $period,
-                $value,
-                $operand
-            );
-        }
-        //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 string $date_format_string
-     * @param string $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 = (string) get_option('date_format');
-        }
-        if ($time_format_string === null) {
-            $time_format_string = (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;
-        $format_string_length = strlen($format_string);
-        for ($i = 0; $i < $format_string_length; $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 (stripos($format_string, 'A') === false) {
-                    $error_msg[] = esc_html__(
-                        '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;
-    }
-
-
-    /**
-     * 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
-            : (float) 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');
-        $prefix     = (int) $gmt_offset >= 0 ? '+' : '';
-        $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
-        //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);
-    }
-
-
-    /**
-     * **
-     * 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;
-        }
-        $zone_data = array();
-        foreach (timezone_identifiers_list() as $zone) {
-            $zone = explode('/', $zone);
-            if (! in_array($zone[0], $continents, true)) {
-                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] && $zone[0] !== 'Etc';
-            $exists[4]   = $exists[1] && $exists[3];
-            $exists[5]   = $exists[2] && $exists[3];
-            $zone_data[] = 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($zone_data, '_wp_timezone_choice_usort_callback');
-        $structure = array();
-        if (empty($selected_zone)) {
-            $structure[] = '<option selected="selected" value="">' . __('Select a city') . '</option>';
-        }
-        foreach ($zone_data 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($zone_data[ $key - 1 ]) || $zone_data[ $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       = implode('/', $value);
-            $selected    = $value === $selected_zone ? ' selected="selected"' : '';
-            $structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>'
-                           . esc_html($display)
-                           . '</option>';
-            // Close continent optgroup
-            if (! empty($zone['city'])
-                && (
-                    ! isset($zone_data[ $key + 1 ])
-                    || (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent'])
-                )
-            ) {
-                $structure[] = '</optgroup>';
-            }
-        }
-        return implode("\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();
-    }
-
-
-    /**
-     * Return the appropriate helper adapter for DTT related things.
-     *
-     * @return HelperInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function getHelperAdapter() {
-        $dtt_helper_fqcn = PHP_VERSION_ID < 50600
-            ? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
-            : 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper';
-        return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn);
-    }
-
-
-    /**
-     * Helper function for setting the timezone on a DateTime object.
-     * This is implemented to standardize a workaround for a PHP bug outlined in
-     * https://events.codebasehq.com/projects/event-espresso/tickets/11407 and
-     * https://events.codebasehq.com/projects/event-espresso/tickets/11233
-     *
-     * @param DateTime     $datetime
-     * @param DateTimeZone $timezone
-     */
-    public static function setTimezone(DateTime $datetime, DateTimeZone $timezone)
-    {
-        $datetime->setTimezone($timezone);
-        $datetime->getTimestamp();
-    }
+	/**
+	 * return the timezone set for the WP install
+	 *
+	 * @return string valid timezone string for PHP DateTimeZone() class
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+	 *
+	 * @param string $timezone_string
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_valid_timezone_string($timezone_string = '')
+	{
+		return self::getHelperAdapter()->getValidTimezoneString($timezone_string);
+	}
+
+
+	/**
+	 * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @static
+	 * @param  string $timezone_string Timezone string to check
+	 * @param bool    $throw_error
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function validate_timezone($timezone_string, $throw_error = true)
+	{
+		return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error);
+	}
+
+
+	/**
+	 * This returns a string that can represent the provided gmt offset in format that can be passed into
+	 * DateTimeZone.  This is NOT a string that can be passed as a value on the WordPress timezone_string option.
+	 *
+	 * @param float|string $gmt_offset
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_string_from_gmt_offset($gmt_offset = '')
+	{
+		return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset);
+	}
+
+
+	/**
+	 * 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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_site_timezone_gmt_offset()
+	{
+		return self::getHelperAdapter()->getSiteTimezoneGmtOffset();
+	}
+
+
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @deprecated 4.9.54.rc    Developers this was always meant to only be an internally used method.  This will be
+	 *                          removed in a future version of EE.
+	 * @param int $gmt_offset
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function adjust_invalid_gmt_offsets($gmt_offset = 0)
+	{
+		return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset);
+	}
+
+
+	/**
+	 * get_timezone_string_from_abbreviations_list
+	 *
+	 * @deprecated 4.9.54.rc  Developers, this was never intended to be public.  This is a soft deprecation for now.
+	 *                        If you are using this, you'll want to work out an alternate way of getting the value.
+	 * @param int  $gmt_offset
+	 * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true)
+	{
+		$gmt_offset =  (int) $gmt_offset;
+		/** @var array[] $abbreviations */
+		$abbreviations = DateTimeZone::listAbbreviations();
+		foreach ($abbreviations as $abbreviation) {
+			foreach ($abbreviation as $timezone) {
+				if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
+					try {
+						$offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id']));
+						if ($offset !== $gmt_offset) {
+							continue;
+						}
+						return $timezone['timezone_id'];
+					} catch (Exception $e) {
+						continue;
+					}
+				}
+			}
+		}
+		//if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
+		if ($coerce === true) {
+			$timezone_string = self::get_timezone_string_from_abbreviations_list(
+				self::adjust_invalid_gmt_offsets($gmt_offset),
+				false
+			);
+			if ($timezone_string) {
+				return $timezone_string;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'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 / HOUR_IN_SECONDS,
+				'<a href="http://www.php.net/manual/en/timezones.php">',
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * Get Timezone Transitions
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
+	{
+		return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only);
+	}
+
+
+	/**
+	 * Get Timezone Offset for given timezone object.
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null         $time
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null)
+	{
+		return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time);
+	}
+
+
+	/**
+	 * Prints a select input for the given timezone string.
+	 * @param string $timezone_string
+	 * @deprecatd 4.9.54.rc   Soft deprecation.  Consider using \EEH_DTT_Helper::wp_timezone_choice instead.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function timezone_select_input($timezone_string = '')
+	{
+		self::getHelperAdapter()->timezoneSelectInput($timezone_string);
+	}
+
+
+	/**
+	 * 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.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '')
+	{
+		return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string);
+	}
+
+
+	/**
+	 *    _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
+	 * @throws EE_Error
+	 */
+	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)
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	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
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	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  int|string $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 Exception
+	 * @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(
+					esc_html__('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 int
+	 * @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(
+					esc_html__('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.
+	 * @throws Exception
+	 * @throws EE_Error
+	 */
+	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
+			);
+		}
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) {
+			return EEH_DTT_Helper::_modify_timestamp(
+				$DateTime_or_timestamp,
+				$period,
+				$value,
+				$operand
+			);
+		}
+		//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 string $date_format_string
+	 * @param string $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 = (string) get_option('date_format');
+		}
+		if ($time_format_string === null) {
+			$time_format_string = (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;
+		$format_string_length = strlen($format_string);
+		for ($i = 0; $i < $format_string_length; $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 (stripos($format_string, 'A') === false) {
+					$error_msg[] = esc_html__(
+						'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;
+	}
+
+
+	/**
+	 * 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
+			: (float) 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');
+		$prefix     = (int) $gmt_offset >= 0 ? '+' : '';
+		$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
+		//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);
+	}
+
+
+	/**
+	 * **
+	 * 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;
+		}
+		$zone_data = array();
+		foreach (timezone_identifiers_list() as $zone) {
+			$zone = explode('/', $zone);
+			if (! in_array($zone[0], $continents, true)) {
+				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] && $zone[0] !== 'Etc';
+			$exists[4]   = $exists[1] && $exists[3];
+			$exists[5]   = $exists[2] && $exists[3];
+			$zone_data[] = 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($zone_data, '_wp_timezone_choice_usort_callback');
+		$structure = array();
+		if (empty($selected_zone)) {
+			$structure[] = '<option selected="selected" value="">' . __('Select a city') . '</option>';
+		}
+		foreach ($zone_data 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($zone_data[ $key - 1 ]) || $zone_data[ $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       = implode('/', $value);
+			$selected    = $value === $selected_zone ? ' selected="selected"' : '';
+			$structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>'
+						   . esc_html($display)
+						   . '</option>';
+			// Close continent optgroup
+			if (! empty($zone['city'])
+				&& (
+					! isset($zone_data[ $key + 1 ])
+					|| (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent'])
+				)
+			) {
+				$structure[] = '</optgroup>';
+			}
+		}
+		return implode("\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();
+	}
+
+
+	/**
+	 * Return the appropriate helper adapter for DTT related things.
+	 *
+	 * @return HelperInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function getHelperAdapter() {
+		$dtt_helper_fqcn = PHP_VERSION_ID < 50600
+			? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
+			: 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper';
+		return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn);
+	}
+
+
+	/**
+	 * Helper function for setting the timezone on a DateTime object.
+	 * This is implemented to standardize a workaround for a PHP bug outlined in
+	 * https://events.codebasehq.com/projects/event-espresso/tickets/11407 and
+	 * https://events.codebasehq.com/projects/event-espresso/tickets/11233
+	 *
+	 * @param DateTime     $datetime
+	 * @param DateTimeZone $timezone
+	 */
+	public static function setTimezone(DateTime $datetime, DateTimeZone $timezone)
+	{
+		$datetime->setTimezone($timezone);
+		$datetime->getTimestamp();
+	}
 }
\ No newline at end of file

admin_pages/registrations/Registrations_Admin_Page.core.php

Indentation +3722 added lines, -3722 removed lines

@@ -30,2339 +30,2339 @@ 
 class Registrations_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * @var EE_Registration
-     */
-    private $_registration;
-
-    /**
-     * @var EE_Event
-     */
-    private $_reg_event;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    private static $_reg_status;
-
-    /**
-     * Form for displaying the custom questions for this registration.
-     * This gets used a few times throughout the request so its best to cache it
-     *
-     * @var EE_Registration_Custom_Questions_Form
-     */
-    protected $_reg_custom_questions_form = null;
-
-
-    /**
-     *        constructor
-     *
-     * @Constructor
-     * @access public
-     * @param bool $routing
-     * @return Registrations_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        add_action('wp_loaded', array($this, 'wp_loaded'));
-    }
-
-
-    public function wp_loaded()
-    {
-        // when adding a new registration...
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
-            EE_System::do_not_cache();
-            if (! isset($this->_req_data['processing_registration'])
-                 || absint($this->_req_data['processing_registration']) !== 1
-            ) {
-                // and it's NOT the attendee information reg step
-                // force cookie expiration by setting time to last week
-                setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
-                // and update the global
-                $_COOKIE['ee_registration_added'] = 0;
-            }
-        }
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REG_PG_SLUG;
-        $this->_admin_base_url  = REG_ADMIN_URL;
-        $this->_admin_base_path = REG_ADMIN;
-        $this->page_label       = esc_html__('Registrations', 'event_espresso');
-        $this->_cpt_routes      = array(
-            'add_new_attendee' => 'espresso_attendees',
-            'edit_attendee'    => 'espresso_attendees',
-            'insert_attendee'  => 'espresso_attendees',
-            'update_attendee'  => 'espresso_attendees',
-        );
-        $this->_cpt_model_names = array(
-            'add_new_attendee' => 'EEM_Attendee',
-            'edit_attendee'    => 'EEM_Attendee',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_attendees' => 'edit_attendee',
-        );
-        $this->_pagenow_map     = array(
-            'add_new_attendee' => 'post-new.php',
-            'edit_attendee'    => 'post.php',
-            'trash'            => 'post.php',
-        );
-        add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
-        //add filters so that the comment urls don't take users to a confusing 404 page
-        add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
-    }
-
-
-    public function clear_comment_link($link, $comment, $args)
-    {
-        //gotta make sure this only happens on this route
-        $post_type = get_post_type($comment->comment_post_ID);
-        if ($post_type === 'espresso_attendees') {
-            return '#commentsdiv';
-        }
-        return $link;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        //todo: all hooks for registrations ajax goes in here
-        add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons'                      => array(
-                'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
-                'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
-                'edit'                => esc_html__('Edit Contact', 'event_espresso'),
-                'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
-                'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
-                'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
-                'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
-                'contact_list_export' => esc_html__("Export Data", "event_espresso"),
-            ),
-            'publishbox'                   => array(
-                'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
-                'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
-            ),
-            'hide_add_button_on_cpt_route' => array(
-                'edit_attendee' => true,
-            ),
-        );
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     */
-    public function _set_page_routes()
-    {
-        $this->_get_registration_status_array();
-        $reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID'] : 0;
-        $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
-            ? $this->_req_data['reg_status_change_form']['REG_ID']
-            : $reg_id;
-        $att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
-            ? $this->_req_data['ATT_ID'] : 0;
-        $att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
-            ? $this->_req_data['post']
-            : $att_id;
-        $this->_page_routes = array(
-            'default'                            => array(
-                'func'       => '_registrations_overview_list_table',
-                'capability' => 'ee_read_registrations',
-            ),
-            'view_registration'                  => array(
-                'func'       => '_registration_details',
-                'capability' => 'ee_read_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'edit_registration'                  => array(
-                'func'               => '_update_attendee_registration_form',
-                'noheader'           => true,
-                'headers_sent_route' => 'view_registration',
-                'capability'         => 'ee_edit_registration',
-                'obj_id'             => $reg_id,
-                '_REG_ID'            => $reg_id,
-            ),
-            'trash_registrations'                => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'restore_registrations'              => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'delete_registrations'               => array(
-                'func'       => '_delete_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'new_registration'                   => array(
-                'func'       => 'new_registration',
-                'capability' => 'ee_edit_registrations',
-            ),
-            'process_reg_step'                   => array(
-                'func'       => 'process_reg_step',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'redirect_to_txn'                    => array(
-                'func'       => 'redirect_to_txn',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'change_reg_status'                  => array(
-                'func'       => '_change_reg_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_registration'               => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_and_notify_registration'    => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('approve')
-            ),
-            'approve_and_notify_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('approve', true)
-            ),
-            'decline_registration'               => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_and_notify_registration'    => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('decline')
-            ),
-            'decline_and_notify_registrations'    => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('decline', true)
-            ),
-            'pending_registration'               => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_and_notify_registration'    => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_registrations'               => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('pending')
-            ),
-            'pending_and_notify_registrations'    => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('pending', true)
-            ),
-            'no_approve_registration'            => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_and_notify_registration' => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_registrations'            => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('not_approve')
-            ),
-            'no_approve_and_notify_registrations' => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('not_approve', true)
-            ),
-            'cancel_registration'                => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_and_notify_registration'     => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_registrations'                => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('cancel')
-            ),
-            'cancel_and_notify_registrations'     => array(
-                'func'       => 'bulk_action_on_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-                'args' => array('cancel', true)
-            ),
-            'wait_list_registration' => array(
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'wait_list_and_notify_registration' => array(
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'contact_list'                       => array(
-                'func'       => '_attendee_contact_list_table',
-                'capability' => 'ee_read_contacts',
-            ),
-            'add_new_attendee'                   => array(
-                'func' => '_create_new_cpt_item',
-                'args' => array(
-                    'new_attendee' => true,
-                    'capability'   => 'ee_edit_contacts',
-                ),
-            ),
-            'edit_attendee'                      => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'duplicate_attendee'                 => array(
-                'func'       => '_duplicate_attendee',
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'insert_attendee'                    => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-            ),
-            'update_attendee'                    => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'trash_attendees' => array(
-                'func' => '_trash_or_restore_attendees',
-                'args' => array(
-                    'trash' => 'true'
-                ),
-                'noheader' => true,
-                'capability' => 'ee_delete_contacts'
-            ),
-            'trash_attendee'                    => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'restore_attendees'                  => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'resend_registration'                => array(
-                'func'       => '_resend_registration',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'registrations_report'               => array(
-                'func'       => '_registrations_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-            'contact_list_export'                => array(
-                'func'       => '_contact_list_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ),
-            'contact_list_report'                => array(
-                'func'       => '_contact_list_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_contacts',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'           => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 5,
-                ),
-                'help_tabs'     => array(
-                    'registrations_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Overview', 'event_espresso'),
-                        'filename' => 'registrations_overview',
-                    ),
-                    'registrations_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_overview_table_column_headings',
-                    ),
-                    'registrations_overview_filters_help_tab'               => array(
-                        'title'    => esc_html__('Registration Filters', 'event_espresso'),
-                        'filename' => 'registrations_overview_filters',
-                    ),
-                    'registrations_overview_views_help_tab'                 => array(
-                        'title'    => esc_html__('Registration Views', 'event_espresso'),
-                        'filename' => 'registrations_overview_views',
-                    ),
-                    'registrations_regoverview_other_help_tab'              => array(
-                        'title'    => esc_html__('Registrations Other', 'event_espresso'),
-                        'filename' => 'registrations_overview_other',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Overview_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Registrations_List_Table',
-                'require_nonce' => false,
-            ),
-            'view_registration' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('REG Details', 'event_espresso'),
-                    'order'      => 15,
-                    'url'        => isset($this->_req_data['_REG_ID'])
-                        ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'registrations_details_help_tab'                    => array(
-                        'title'    => esc_html__('Registration Details', 'event_espresso'),
-                        'filename' => 'registrations_details',
-                    ),
-                    'registrations_details_table_help_tab'              => array(
-                        'title'    => esc_html__('Registration Details Table', 'event_espresso'),
-                        'filename' => 'registrations_details_table',
-                    ),
-                    'registrations_details_form_answers_help_tab'       => array(
-                        'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
-                        'filename' => 'registrations_details_form_answers',
-                    ),
-                    'registrations_details_registrant_details_help_tab' => array(
-                        'title'    => esc_html__('Contact Details', 'event_espresso'),
-                        'filename' => 'registrations_details_registrant_details',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Details_Help_Tour'),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_registration_details_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'new_registration'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add New Registration', 'event_espresso'),
-                    'url'        => '#',
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'labels'        => array(
-                    'publishbox' => esc_html__('Save Registration', 'event_espresso'),
-                ),
-                'require_nonce' => false,
-            ),
-            'add_new_attendee'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_publish_post_box', 'attendee_editor_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'edit_attendee'     => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['ATT_ID'])
-                        ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('attendee_editor_metaboxes'),
-                'require_nonce' => false,
-            ),
-            'contact_list'      => array(
-                'nav'           => array(
-                    'label' => esc_html__('Contact List', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'EE_Attendee_Contact_List_Table',
-                'help_tabs'     => array(
-                    'registrations_contact_list_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
-                        'filename' => 'registrations_contact_list',
-                    ),
-                    'registrations_contact-list_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_table_column_headings',
-                    ),
-                    'registrations_contact_list_views_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Views', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_views',
-                    ),
-                    'registrations_contact_list_other_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Other', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_other',
-                    ),
-                ),
-                'help_tour'     => array('Contact_List_Help_Tour'),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            //override default cpt routes
-            'create_new'        => '',
-            'edit'              => '',
-        );
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
-            'click "Update Registration Questions" to save your changes',
-            'event_espresso'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     */
-    private function _get_registration_status_array()
-    {
-        self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_contact_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    public function load_scripts_styles()
-    {
-        //style
-        wp_register_style(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_reg');
-        //script
-        wp_register_script(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
-            array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_reg');
-    }
-
-
-    public function load_scripts_styles_edit_attendee()
-    {
-        //stuff to only show up on our attendee edit details page.
-        $attendee_details_translations = array(
-            'att_publish_text' => sprintf(
-                esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
-                $this->_cpt_model_obj->get_datetime('ATT_created')
-            ),
-        );
-        wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
-        wp_enqueue_script('jquery-validate');
-    }
-
-
-    public function load_scripts_styles_view_registration()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        //scripts
-        $this->_get_reg_custom_questions_form($this->_registration->ID());
-        $this->_reg_custom_questions_form->wp_enqueue_scripts(true);
-    }
-
-
-    public function load_scripts_styles_contact_list()
-    {
-        wp_dequeue_style('espresso_reg');
-        wp_register_style(
-            'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_att');
-    }
-
-
-    public function load_scripts_styles_new_registration()
-    {
-        wp_register_script(
-            'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
-            array('underscore', 'jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-spco-for-admin');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        EE_Form_Section_Proper::wp_enqueue_scripts();
-        EED_Ticket_Selector::load_tckt_slctr_assets();
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        //for notification related bulk actions we need to make sure only active messengers have an option.
-        EED_Messages::set_autoloaders();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts               = $message_resource_manager->list_of_active_message_types();
-        //key= bulk_action_slug, value= message type.
-        $match_array = array(
-            'approve_registrations'    => 'registration',
-            'decline_registrations'    => 'declined_registration',
-            'pending_registrations'    => 'pending_approval',
-            'no_approve_registrations' => 'not_approved_registration',
-            'cancel_registrations'     => 'cancelled_registration',
-        );
-        $can_send = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'batch_send_messages'
-        );
-        /** setup reg status bulk actions **/
-        $def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
-                    'Approve and Notify Registrations',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
-                    'Decline and Notify Registrations',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['pending_registrations'] = esc_html__(
-            'Set Registrations to Pending Payment',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
-                    'Set Registrations to Pending Payment and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['no_approve_registrations'] = esc_html__(
-            'Set Registrations to Not Approved',
-            'event_espresso'
-        );
-        if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
-                    'Set Registrations to Not Approved and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
-                $def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
-                    'Cancel Registrations and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
-            $def_reg_status_actions,
-            $active_mts,
-            $can_send
-        );
-
-        $this->_views = array(
-            'all'   => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Registrations', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-            'month' => array(
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-            'today' => array(
-                'slug'        => 'today',
-                'label'       => sprintf(
-                    esc_html__('Today - %s', 'event_espresso'),
-                    date('M d, Y', current_time('timestamp'))
-                ),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_registrations',
-            'espresso_registrations_delete_registration'
-        )) {
-            $this->_views['incomplete'] = array(
-                'slug'        => 'incomplete',
-                'label'       => esc_html__('Incomplete', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                ),
-            );
-            $this->_views['trash']      = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
-                    'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _set_list_table_views_contact_list()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => esc_html__('In Use', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
-            'espresso_registrations_trash_attendees')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _registration_legend_items()
-    {
-        $fc_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
-            ),
-            'view_details'     => array(
-                'class' => 'dashicons dashicons-clipboard',
-                'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-            ),
-            'edit_attendee'    => array(
-                'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
-                'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
-            ),
-            'view_transaction' => array(
-                'class' => 'dashicons dashicons-cart',
-                'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-            ),
-            'view_invoice'     => array(
-                'class' => 'dashicons dashicons-media-spreadsheet',
-                'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_registrations_resend_registration'
-        )) {
-            $fc_items['resend_registration'] = array(
-                'class' => 'dashicons dashicons-email-alt',
-                'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
-            );
-        } else {
-            $fc_items['blank'] = array('class' => 'blank', 'desc' => '');
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
-                $fc_items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-        $sc_items = array(
-            'approved_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'pending_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_pending_payment,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'wait_list'         => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_wait_list,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_incomplete,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'not_approved'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_not_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'declined_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_declined,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'cancelled_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_cancelled,
-                    false,
-                    'sentence'
-                ),
-            ),
-        );
-        return array_merge($fc_items, $sc_items);
-    }
-
-
-
-    /***************************************        REGISTRATION OVERVIEW        **************************************/
-    /**
-     * @throws \EE_Error
-     */
-    protected function _registrations_overview_list_table()
-    {
-        $this->_template_args['admin_page_header'] = '';
-        $EVT_ID                                    = ! empty($this->_req_data['event_id'])
-            ? absint($this->_req_data['event_id'])
-            : 0;
-        $ATT_ID = !empty($this->_req_data['ATT_ID'])
-            ? absint($this->_req_data['ATT_ID'])
-            : 0;
-        if ($ATT_ID) {
-            $attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID);
-            if ($attendee instanceof EE_Attendee) {
-                $this->_template_args['admin_page_header'] = sprintf(
-                    esc_html__(
-                        '%1$s Viewing registrations for %2$s%3$s',
-                        'event_espresso'
-                    ),
-                    '<h3 style="line-height:1.5em;">',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit_attendee',
-                            'post' => $ATT_ID
-                        ),
-                        REG_ADMIN_URL
-                    ) . '">' . $attendee->full_name() . '</a>',
-                    '</h3>'
-                );
-            }
-        }
-        if ($EVT_ID) {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $EVT_ID
-            )) {
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                    'new_registration',
-                    'add-registrant',
-                    array('event_id' => $EVT_ID),
-                    'add-new-h2'
-                );
-            }
-            $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-            if ($event instanceof EE_Event) {
-                $this->_template_args['admin_page_header'] = sprintf(
-                    esc_html__(
-                        '%s Viewing registrations for the event: %s%s',
-                        'event_espresso'
-                    ),
-                    '<h3 style="line-height:1.5em;">',
-                    '<br /><a href="'
-                        . EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action' => 'edit',
-                                'post'   => $event->ID(),
-                            ),
-                            EVENTS_ADMIN_URL
-                        )
-                        . '">&nbsp;'
-                        . $event->get('EVT_name')
-                        . '&nbsp;</a>&nbsp;',
-                    '</h3>'
-                );
-            }
-            $DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-            if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
-                $this->_template_args['admin_page_header'] = substr(
-                    $this->_template_args['admin_page_header'],
-                    0,
-                    -5
-                );
-                $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
-                $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
-                $this->_template_args['admin_page_header'] .= $datetime->name();
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
-                $this->_template_args['admin_page_header'] .= '</span></h3>';
-            }
-        }
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * This sets the _registration property for the registration details screen
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_registration_object()
-    {
-        //get out if we've already set the object
-        if ($this->_registration instanceof EE_Registration) {
-            return true;
-        }
-        $REG    = EEM_Registration::instance();
-        $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
-        if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
-            return true;
-        } else {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for Registration ID #%s could not be retrieved.',
-                    'event_espresso'
-                ),
-                $REG_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_registration = null;
-            return false;
-        }
-    }
-
-
-    /**
-     * Used to retrieve registrations for the list table.
-     *
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $this_month
-     * @param bool $today
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_registrations(
-        $per_page = 10,
-        $count = false,
-        $this_month = false,
-        $today = false
-    ) {
-        if ($this_month) {
-            $this->_req_data['status'] = 'month';
-        }
-        if ($today) {
-            $this->_req_data['status'] = 'today';
-        }
-        $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see EEM_Base::get_all()
-         */
-        $query_params['group_by'] = '';
-
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Retrieves the query parameters to be used by the Registration model for getting registrations.
-     * Note: this listens to values on the request for some of the query parameters.
-     *
-     * @param array $request
-     * @param int   $per_page
-     * @param bool  $count
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_registration_query_parameters(
-        $request = array(),
-        $per_page = 10,
-        $count = false
-    ) {
-
-        $query_params = array(
-            0                          => $this->_get_where_conditions_for_registrations_query(
-                $request
-            ),
-            'caps'                     => EEM_Registration::caps_read_admin,
-            'default_where_conditions' => 'this_model_only',
-        );
-        if (! $count) {
-            $query_params = array_merge(
-                $query_params,
-                $this->_get_orderby_for_registrations_query(),
-                $this->_get_limit($per_page)
-            );
-        }
-
-        return $query_params;
-    }
-
-
-    /**
-     * This will add ATT_ID to the provided $where array for EE model query parameters.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function addAttendeeIdToWhereConditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['ATT_ID'])) {
-            $where['ATT_ID'] = absint($request['ATT_ID']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * This will add EVT_ID to the provided $where array for EE model query parameters.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_event_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['event_id'])) {
-            $where['EVT_ID'] = absint($request['event_id']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_category_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
-            $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_datetime_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['datetime_id'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
-        }
-        if (! empty($request['DTT_ID'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the correct registration status to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_registration_status_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $registration_status = ! empty($request['_reg_status'])
-            ? sanitize_text_field($request['_reg_status'])
-            : '';
-
-        /*
+	/**
+	 * @var EE_Registration
+	 */
+	private $_registration;
+
+	/**
+	 * @var EE_Event
+	 */
+	private $_reg_event;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	private static $_reg_status;
+
+	/**
+	 * Form for displaying the custom questions for this registration.
+	 * This gets used a few times throughout the request so its best to cache it
+	 *
+	 * @var EE_Registration_Custom_Questions_Form
+	 */
+	protected $_reg_custom_questions_form = null;
+
+
+	/**
+	 *        constructor
+	 *
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing
+	 * @return Registrations_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		add_action('wp_loaded', array($this, 'wp_loaded'));
+	}
+
+
+	public function wp_loaded()
+	{
+		// when adding a new registration...
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
+			EE_System::do_not_cache();
+			if (! isset($this->_req_data['processing_registration'])
+				 || absint($this->_req_data['processing_registration']) !== 1
+			) {
+				// and it's NOT the attendee information reg step
+				// force cookie expiration by setting time to last week
+				setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
+				// and update the global
+				$_COOKIE['ee_registration_added'] = 0;
+			}
+		}
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REG_PG_SLUG;
+		$this->_admin_base_url  = REG_ADMIN_URL;
+		$this->_admin_base_path = REG_ADMIN;
+		$this->page_label       = esc_html__('Registrations', 'event_espresso');
+		$this->_cpt_routes      = array(
+			'add_new_attendee' => 'espresso_attendees',
+			'edit_attendee'    => 'espresso_attendees',
+			'insert_attendee'  => 'espresso_attendees',
+			'update_attendee'  => 'espresso_attendees',
+		);
+		$this->_cpt_model_names = array(
+			'add_new_attendee' => 'EEM_Attendee',
+			'edit_attendee'    => 'EEM_Attendee',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_attendees' => 'edit_attendee',
+		);
+		$this->_pagenow_map     = array(
+			'add_new_attendee' => 'post-new.php',
+			'edit_attendee'    => 'post.php',
+			'trash'            => 'post.php',
+		);
+		add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
+		//add filters so that the comment urls don't take users to a confusing 404 page
+		add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
+	}
+
+
+	public function clear_comment_link($link, $comment, $args)
+	{
+		//gotta make sure this only happens on this route
+		$post_type = get_post_type($comment->comment_post_ID);
+		if ($post_type === 'espresso_attendees') {
+			return '#commentsdiv';
+		}
+		return $link;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		//todo: all hooks for registrations ajax goes in here
+		add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons'                      => array(
+				'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
+				'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
+				'edit'                => esc_html__('Edit Contact', 'event_espresso'),
+				'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
+				'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
+				'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
+				'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
+				'contact_list_export' => esc_html__("Export Data", "event_espresso"),
+			),
+			'publishbox'                   => array(
+				'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
+				'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
+			),
+			'hide_add_button_on_cpt_route' => array(
+				'edit_attendee' => true,
+			),
+		);
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function _set_page_routes()
+	{
+		$this->_get_registration_status_array();
+		$reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID'] : 0;
+		$reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
+			? $this->_req_data['reg_status_change_form']['REG_ID']
+			: $reg_id;
+		$att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
+			? $this->_req_data['ATT_ID'] : 0;
+		$att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
+			? $this->_req_data['post']
+			: $att_id;
+		$this->_page_routes = array(
+			'default'                            => array(
+				'func'       => '_registrations_overview_list_table',
+				'capability' => 'ee_read_registrations',
+			),
+			'view_registration'                  => array(
+				'func'       => '_registration_details',
+				'capability' => 'ee_read_registration',
+				'obj_id'     => $reg_id,
+			),
+			'edit_registration'                  => array(
+				'func'               => '_update_attendee_registration_form',
+				'noheader'           => true,
+				'headers_sent_route' => 'view_registration',
+				'capability'         => 'ee_edit_registration',
+				'obj_id'             => $reg_id,
+				'_REG_ID'            => $reg_id,
+			),
+			'trash_registrations'                => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'restore_registrations'              => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'delete_registrations'               => array(
+				'func'       => '_delete_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'new_registration'                   => array(
+				'func'       => 'new_registration',
+				'capability' => 'ee_edit_registrations',
+			),
+			'process_reg_step'                   => array(
+				'func'       => 'process_reg_step',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'redirect_to_txn'                    => array(
+				'func'       => 'redirect_to_txn',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'change_reg_status'                  => array(
+				'func'       => '_change_reg_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_registration'               => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_and_notify_registration'    => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('approve')
+			),
+			'approve_and_notify_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('approve', true)
+			),
+			'decline_registration'               => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_and_notify_registration'    => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('decline')
+			),
+			'decline_and_notify_registrations'    => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('decline', true)
+			),
+			'pending_registration'               => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_and_notify_registration'    => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_registrations'               => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('pending')
+			),
+			'pending_and_notify_registrations'    => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('pending', true)
+			),
+			'no_approve_registration'            => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_and_notify_registration' => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_registrations'            => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('not_approve')
+			),
+			'no_approve_and_notify_registrations' => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('not_approve', true)
+			),
+			'cancel_registration'                => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_and_notify_registration'     => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_registrations'                => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('cancel')
+			),
+			'cancel_and_notify_registrations'     => array(
+				'func'       => 'bulk_action_on_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+				'args' => array('cancel', true)
+			),
+			'wait_list_registration' => array(
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'wait_list_and_notify_registration' => array(
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'contact_list'                       => array(
+				'func'       => '_attendee_contact_list_table',
+				'capability' => 'ee_read_contacts',
+			),
+			'add_new_attendee'                   => array(
+				'func' => '_create_new_cpt_item',
+				'args' => array(
+					'new_attendee' => true,
+					'capability'   => 'ee_edit_contacts',
+				),
+			),
+			'edit_attendee'                      => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'duplicate_attendee'                 => array(
+				'func'       => '_duplicate_attendee',
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'insert_attendee'                    => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+			),
+			'update_attendee'                    => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'trash_attendees' => array(
+				'func' => '_trash_or_restore_attendees',
+				'args' => array(
+					'trash' => 'true'
+				),
+				'noheader' => true,
+				'capability' => 'ee_delete_contacts'
+			),
+			'trash_attendee'                    => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'restore_attendees'                  => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'resend_registration'                => array(
+				'func'       => '_resend_registration',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'registrations_report'               => array(
+				'func'       => '_registrations_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+			'contact_list_export'                => array(
+				'func'       => '_contact_list_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			),
+			'contact_list_report'                => array(
+				'func'       => '_contact_list_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_contacts',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'           => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 5,
+				),
+				'help_tabs'     => array(
+					'registrations_overview_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Overview', 'event_espresso'),
+						'filename' => 'registrations_overview',
+					),
+					'registrations_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_overview_table_column_headings',
+					),
+					'registrations_overview_filters_help_tab'               => array(
+						'title'    => esc_html__('Registration Filters', 'event_espresso'),
+						'filename' => 'registrations_overview_filters',
+					),
+					'registrations_overview_views_help_tab'                 => array(
+						'title'    => esc_html__('Registration Views', 'event_espresso'),
+						'filename' => 'registrations_overview_views',
+					),
+					'registrations_regoverview_other_help_tab'              => array(
+						'title'    => esc_html__('Registrations Other', 'event_espresso'),
+						'filename' => 'registrations_overview_other',
+					),
+				),
+				'help_tour'     => array('Registration_Overview_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Registrations_List_Table',
+				'require_nonce' => false,
+			),
+			'view_registration' => array(
+				'nav'           => array(
+					'label'      => esc_html__('REG Details', 'event_espresso'),
+					'order'      => 15,
+					'url'        => isset($this->_req_data['_REG_ID'])
+						? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'registrations_details_help_tab'                    => array(
+						'title'    => esc_html__('Registration Details', 'event_espresso'),
+						'filename' => 'registrations_details',
+					),
+					'registrations_details_table_help_tab'              => array(
+						'title'    => esc_html__('Registration Details Table', 'event_espresso'),
+						'filename' => 'registrations_details_table',
+					),
+					'registrations_details_form_answers_help_tab'       => array(
+						'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
+						'filename' => 'registrations_details_form_answers',
+					),
+					'registrations_details_registrant_details_help_tab' => array(
+						'title'    => esc_html__('Contact Details', 'event_espresso'),
+						'filename' => 'registrations_details_registrant_details',
+					),
+				),
+				'help_tour'     => array('Registration_Details_Help_Tour'),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_registration_details_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'new_registration'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add New Registration', 'event_espresso'),
+					'url'        => '#',
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'labels'        => array(
+					'publishbox' => esc_html__('Save Registration', 'event_espresso'),
+				),
+				'require_nonce' => false,
+			),
+			'add_new_attendee'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_publish_post_box', 'attendee_editor_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'edit_attendee'     => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['ATT_ID'])
+						? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				),
+				'metaboxes'     => array('attendee_editor_metaboxes'),
+				'require_nonce' => false,
+			),
+			'contact_list'      => array(
+				'nav'           => array(
+					'label' => esc_html__('Contact List', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'EE_Attendee_Contact_List_Table',
+				'help_tabs'     => array(
+					'registrations_contact_list_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
+						'filename' => 'registrations_contact_list',
+					),
+					'registrations_contact-list_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_contact_list_table_column_headings',
+					),
+					'registrations_contact_list_views_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Views', 'event_espresso'),
+						'filename' => 'registrations_contact_list_views',
+					),
+					'registrations_contact_list_other_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Other', 'event_espresso'),
+						'filename' => 'registrations_contact_list_other',
+					),
+				),
+				'help_tour'     => array('Contact_List_Help_Tour'),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			//override default cpt routes
+			'create_new'        => '',
+			'edit'              => '',
+		);
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
+			'click "Update Registration Questions" to save your changes',
+			'event_espresso'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _get_registration_status_array()
+	{
+		self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_contact_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	public function load_scripts_styles()
+	{
+		//style
+		wp_register_style(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_reg');
+		//script
+		wp_register_script(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.js',
+			array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_reg');
+	}
+
+
+	public function load_scripts_styles_edit_attendee()
+	{
+		//stuff to only show up on our attendee edit details page.
+		$attendee_details_translations = array(
+			'att_publish_text' => sprintf(
+				esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
+				$this->_cpt_model_obj->get_datetime('ATT_created')
+			),
+		);
+		wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
+		wp_enqueue_script('jquery-validate');
+	}
+
+
+	public function load_scripts_styles_view_registration()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		//scripts
+		$this->_get_reg_custom_questions_form($this->_registration->ID());
+		$this->_reg_custom_questions_form->wp_enqueue_scripts(true);
+	}
+
+
+	public function load_scripts_styles_contact_list()
+	{
+		wp_dequeue_style('espresso_reg');
+		wp_register_style(
+			'espresso_att',
+			REG_ASSETS_URL . 'espresso_attendees_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_att');
+	}
+
+
+	public function load_scripts_styles_new_registration()
+	{
+		wp_register_script(
+			'ee-spco-for-admin',
+			REG_ASSETS_URL . 'spco_for_admin.js',
+			array('underscore', 'jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-spco-for-admin');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		EE_Form_Section_Proper::wp_enqueue_scripts();
+		EED_Ticket_Selector::load_tckt_slctr_assets();
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		//for notification related bulk actions we need to make sure only active messengers have an option.
+		EED_Messages::set_autoloaders();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts               = $message_resource_manager->list_of_active_message_types();
+		//key= bulk_action_slug, value= message type.
+		$match_array = array(
+			'approve_registrations'    => 'registration',
+			'decline_registrations'    => 'declined_registration',
+			'pending_registrations'    => 'pending_approval',
+			'no_approve_registrations' => 'not_approved_registration',
+			'cancel_registrations'     => 'cancelled_registration',
+		);
+		$can_send = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'batch_send_messages'
+		);
+		/** setup reg status bulk actions **/
+		$def_reg_status_actions['approve_registrations'] = esc_html__('Approve Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['approve_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['approve_and_notify_registrations'] = esc_html__(
+					'Approve and Notify Registrations',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['decline_registrations'] = esc_html__('Decline Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['decline_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['decline_and_notify_registrations'] = esc_html__(
+					'Decline and Notify Registrations',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['pending_registrations'] = esc_html__(
+			'Set Registrations to Pending Payment',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['pending_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['pending_and_notify_registrations'] = esc_html__(
+					'Set Registrations to Pending Payment and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['no_approve_registrations'] = esc_html__(
+			'Set Registrations to Not Approved',
+			'event_espresso'
+		);
+		if ($can_send && in_array($match_array['no_approve_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['no_approve_and_notify_registrations'] = esc_html__(
+					'Set Registrations to Not Approved and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['cancel_registrations'] = esc_html__('Cancel Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['cancel_registrations'], $active_mts, true)) {
+				$def_reg_status_actions['cancel_and_notify_registrations'] = esc_html__(
+					'Cancel Registrations and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
+			$def_reg_status_actions,
+			$active_mts,
+			$can_send
+		);
+
+		$this->_views = array(
+			'all'   => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Registrations', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+			'month' => array(
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+			'today' => array(
+				'slug'        => 'today',
+				'label'       => sprintf(
+					esc_html__('Today - %s', 'event_espresso'),
+					date('M d, Y', current_time('timestamp'))
+				),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_registrations',
+			'espresso_registrations_delete_registration'
+		)) {
+			$this->_views['incomplete'] = array(
+				'slug'        => 'incomplete',
+				'label'       => esc_html__('Incomplete', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				),
+			);
+			$this->_views['trash']      = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
+					'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _set_list_table_views_contact_list()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'        => 'in_use',
+				'label'       => esc_html__('In Use', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
+			'espresso_registrations_trash_attendees')
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _registration_legend_items()
+	{
+		$fc_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
+			),
+			'view_details'     => array(
+				'class' => 'dashicons dashicons-clipboard',
+				'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+			),
+			'edit_attendee'    => array(
+				'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
+				'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
+			),
+			'view_transaction' => array(
+				'class' => 'dashicons dashicons-cart',
+				'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+			),
+			'view_invoice'     => array(
+				'class' => 'dashicons dashicons-media-spreadsheet',
+				'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_registrations_resend_registration'
+		)) {
+			$fc_items['resend_registration'] = array(
+				'class' => 'dashicons dashicons-email-alt',
+				'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
+			);
+		} else {
+			$fc_items['blank'] = array('class' => 'blank', 'desc' => '');
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
+				$fc_items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+		$sc_items = array(
+			'approved_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_approved,
+					false,
+					'sentence'
+				),
+			),
+			'pending_status'    => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_pending_payment,
+					false,
+					'sentence'
+				),
+			),
+			'wait_list'         => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_wait_list,
+					false,
+					'sentence'
+				),
+			),
+			'incomplete_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_incomplete,
+					false,
+					'sentence'
+				),
+			),
+			'not_approved'      => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_not_approved,
+					false,
+					'sentence'
+				),
+			),
+			'declined_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_declined,
+					false,
+					'sentence'
+				),
+			),
+			'cancelled_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_cancelled,
+					false,
+					'sentence'
+				),
+			),
+		);
+		return array_merge($fc_items, $sc_items);
+	}
+
+
+
+	/***************************************        REGISTRATION OVERVIEW        **************************************/
+	/**
+	 * @throws \EE_Error
+	 */
+	protected function _registrations_overview_list_table()
+	{
+		$this->_template_args['admin_page_header'] = '';
+		$EVT_ID                                    = ! empty($this->_req_data['event_id'])
+			? absint($this->_req_data['event_id'])
+			: 0;
+		$ATT_ID = !empty($this->_req_data['ATT_ID'])
+			? absint($this->_req_data['ATT_ID'])
+			: 0;
+		if ($ATT_ID) {
+			$attendee = EEM_Attendee::instance()->get_one_by_ID($ATT_ID);
+			if ($attendee instanceof EE_Attendee) {
+				$this->_template_args['admin_page_header'] = sprintf(
+					esc_html__(
+						'%1$s Viewing registrations for %2$s%3$s',
+						'event_espresso'
+					),
+					'<h3 style="line-height:1.5em;">',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit_attendee',
+							'post' => $ATT_ID
+						),
+						REG_ADMIN_URL
+					) . '">' . $attendee->full_name() . '</a>',
+					'</h3>'
+				);
+			}
+		}
+		if ($EVT_ID) {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$EVT_ID
+			)) {
+				$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+					'new_registration',
+					'add-registrant',
+					array('event_id' => $EVT_ID),
+					'add-new-h2'
+				);
+			}
+			$event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+			if ($event instanceof EE_Event) {
+				$this->_template_args['admin_page_header'] = sprintf(
+					esc_html__(
+						'%s Viewing registrations for the event: %s%s',
+						'event_espresso'
+					),
+					'<h3 style="line-height:1.5em;">',
+					'<br /><a href="'
+						. EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action' => 'edit',
+								'post'   => $event->ID(),
+							),
+							EVENTS_ADMIN_URL
+						)
+						. '">&nbsp;'
+						. $event->get('EVT_name')
+						. '&nbsp;</a>&nbsp;',
+					'</h3>'
+				);
+			}
+			$DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+			if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
+				$this->_template_args['admin_page_header'] = substr(
+					$this->_template_args['admin_page_header'],
+					0,
+					-5
+				);
+				$this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
+				$this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
+				$this->_template_args['admin_page_header'] .= $datetime->name();
+				$this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
+				$this->_template_args['admin_page_header'] .= '</span></h3>';
+			}
+		}
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * This sets the _registration property for the registration details screen
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_registration_object()
+	{
+		//get out if we've already set the object
+		if ($this->_registration instanceof EE_Registration) {
+			return true;
+		}
+		$REG    = EEM_Registration::instance();
+		$REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
+		if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
+			return true;
+		} else {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for Registration ID #%s could not be retrieved.',
+					'event_espresso'
+				),
+				$REG_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_registration = null;
+			return false;
+		}
+	}
+
+
+	/**
+	 * Used to retrieve registrations for the list table.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $this_month
+	 * @param bool $today
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_registrations(
+		$per_page = 10,
+		$count = false,
+		$this_month = false,
+		$today = false
+	) {
+		if ($this_month) {
+			$this->_req_data['status'] = 'month';
+		}
+		if ($today) {
+			$this->_req_data['status'] = 'today';
+		}
+		$query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see EEM_Base::get_all()
+		 */
+		$query_params['group_by'] = '';
+
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Retrieves the query parameters to be used by the Registration model for getting registrations.
+	 * Note: this listens to values on the request for some of the query parameters.
+	 *
+	 * @param array $request
+	 * @param int   $per_page
+	 * @param bool  $count
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_registration_query_parameters(
+		$request = array(),
+		$per_page = 10,
+		$count = false
+	) {
+
+		$query_params = array(
+			0                          => $this->_get_where_conditions_for_registrations_query(
+				$request
+			),
+			'caps'                     => EEM_Registration::caps_read_admin,
+			'default_where_conditions' => 'this_model_only',
+		);
+		if (! $count) {
+			$query_params = array_merge(
+				$query_params,
+				$this->_get_orderby_for_registrations_query(),
+				$this->_get_limit($per_page)
+			);
+		}
+
+		return $query_params;
+	}
+
+
+	/**
+	 * This will add ATT_ID to the provided $where array for EE model query parameters.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function addAttendeeIdToWhereConditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['ATT_ID'])) {
+			$where['ATT_ID'] = absint($request['ATT_ID']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * This will add EVT_ID to the provided $where array for EE model query parameters.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_event_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['event_id'])) {
+			$where['EVT_ID'] = absint($request['event_id']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_category_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
+			$where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_datetime_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['datetime_id'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
+		}
+		if (! empty($request['DTT_ID'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the correct registration status to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_registration_status_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$registration_status = ! empty($request['_reg_status'])
+			? sanitize_text_field($request['_reg_status'])
+			: '';
+
+		/*
          * If filtering by registration status, then we show registrations matching that status.
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
          * UNLESS viewing trashed registrations.
          */
-        if (! empty($registration_status)) {
-            $where['STS_ID'] = $registration_status;
-        } else {
-            //make sure we exclude incomplete registrations, but only if not trashed.
-            if ($view === 'trash') {
-                $where['REG_deleted'] = true;
-            } elseif ($view === 'incomplete') {
-                $where['STS_ID'] = EEM_Registration::status_id_incomplete;
-            } else {
-                $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided date restraints to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_date_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $month_range             = ! empty($request['month_range'])
-            ? sanitize_text_field($request['month_range'])
-            : '';
-        $retrieve_for_today      = $view === 'today';
-        $retrieve_for_this_month = $view === 'month';
-
-        if ($retrieve_for_today) {
-            $now               = date('Y-m-d', current_time('timestamp'));
-            $where['REG_date'] = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($retrieve_for_this_month) {
-            $current_year_and_month = date('Y-m', current_time('timestamp'));
-            $days_this_month        = date('t', current_time('timestamp'));
-            $where['REG_date']      = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($month_range) {
-            $pieces          = explode(' ', $month_range, 3);
-            $month_requested = ! empty($pieces[0])
-                ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
-                : '';
-            $year_requested  = ! empty($pieces[1])
-                ? $pieces[1]
-                : '';
-            //if there is not a month or year then we can't go further
-            if ($month_requested && $year_requested) {
-                $days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
-                $where['REG_date'] = array(
-                    'BETWEEN',
-                    array(
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
-                            'Y-m-d H:i:s'
-                        ),
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
-                            'Y-m-d H:i:s'
-                        ),
-                    ),
-                );
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided search restraints to the where conditions for the registrations query
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_search_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['s'])) {
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
-            $where['OR*search_conditions'] = array(
-                'Event.EVT_name'                          => array('LIKE', $search_string),
-                'Event.EVT_desc'                          => array('LIKE', $search_string),
-                'Event.EVT_short_desc'                    => array('LIKE', $search_string),
-                'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
-                'Attendee.ATT_fname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_lname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
-                'Attendee.ATT_email'                      => array('LIKE', $search_string),
-                'Attendee.ATT_address'                    => array('LIKE', $search_string),
-                'Attendee.ATT_address2'                   => array('LIKE', $search_string),
-                'Attendee.ATT_city'                       => array('LIKE', $search_string),
-                'REG_final_price'                         => array('LIKE', $search_string),
-                'REG_code'                                => array('LIKE', $search_string),
-                'REG_count'                               => array('LIKE', $search_string),
-                'REG_group_size'                          => array('LIKE', $search_string),
-                'Ticket.TKT_name'                         => array('LIKE', $search_string),
-                'Ticket.TKT_description'                  => array('LIKE', $search_string),
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
-            );
-        }
-        return $where;
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @param array $request
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_where_conditions_for_registrations_query($request)
-    {
-        return apply_filters(
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
-            array_merge(
-                $this->addAttendeeIdToWhereConditions($request),
-                $this->_add_event_id_to_where_conditions($request),
-                $this->_add_category_id_to_where_conditions($request),
-                $this->_add_datetime_id_to_where_conditions($request),
-                $this->_add_registration_status_to_where_conditions($request),
-                $this->_add_date_to_where_conditions($request),
-                $this->_add_search_to_where_conditions($request)
-            ),
-            $request
-        );
-    }
-
-
-    /**
-     * Sets up the orderby for the registrations query.
-     *
-     * @return array
-     */
-    protected function _get_orderby_for_registrations_query()
-    {
-        $orderby_field = ! empty($this->_req_data['orderby'])
-            ? sanitize_text_field($this->_req_data['orderby'])
-            : '';
-        switch ($orderby_field) {
-            case '_REG_ID':
-                $orderby = array('REG_ID');
-                break;
-            case '_Reg_status':
-                $orderby = array('STS_ID');
-                break;
-            case 'ATT_fname':
-                $orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
-                break;
-            case 'ATT_lname':
-                $orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
-                break;
-            case 'event_name':
-                $orderby = array('Event.EVT_name');
-                break;
-            case 'DTT_EVT_start':
-                $orderby = array('Event.Datetime.DTT_EVT_start');
-                break;
-            default: //'REG_date'
-                $orderby = array('REG_date');
-        }
-
-        //order
-        $order = ! empty($this->_req_data['order'])
-            ? sanitize_text_field($this->_req_data['order'])
-            : 'DESC';
-        $orderby = array_combine(
-            $orderby,
-            array_fill(0, count($orderby), $order)
-        );
-        //because there are many registrations with the same date, define
-        //a secondary way to order them, otherwise MySQL seems to be a bit random
-        if (empty($orderby['REG_ID'])) {
-            $orderby['REG_ID'] = $order;
-        }
-        return array('order_by' => $orderby);
-    }
-
-
-    /**
-     * Sets up the limit for the registrations query.
-     *
-     * @param $per_page
-     * @return array
-     */
-    protected function _get_limit($per_page)
-    {
-        $current_page = ! empty($this->_req_data['paged'])
-            ? absint($this->_req_data['paged'])
-            : 1;
-        $per_page     = ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-
-        //-1 means return all results so get out if that's set.
-        if ((int)$per_page === -1) {
-            return array();
-        }
-        $per_page = absint($per_page);
-        $offset   = ($current_page - 1) * $per_page;
-        return array('limit' => array($offset, $per_page));
-    }
-
-
-    public function get_registration_status_array()
-    {
-        return self::$_reg_status;
-    }
-
-
-
-
-    /***************************************        REGISTRATION DETAILS        ***************************************/
-    /**
-     *        generates HTML for the View Registration Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EntityNotFoundException
-     */
-    protected function _registration_details()
-    {
-        $this->_template_args = array();
-        $this->_set_registration_object();
-        if (is_object($this->_registration)) {
-            $transaction                                   = $this->_registration->transaction()
-                ? $this->_registration->transaction()
-                : EE_Transaction::new_instance();
-            $this->_session                                = $transaction->session_data();
-            $event_id                                      = $this->_registration->event_ID();
-            $this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
-            $this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
-            $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
-            $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
-            $this->_template_args['grand_total']           = $transaction->total();
-            $this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
-            // link back to overview
-            $this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
-            $this->_template_args['registration']                = $this->_registration;
-            $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'default',
-                    'event_id' => $event_id,
-                ),
-                REG_ADMIN_URL
-            );
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'default',
-                    'EVT_ID' => $event_id,
-                    'page'   => 'espresso_transactions',
-                ),
-                admin_url('admin.php')
-            );
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'   => 'espresso_events',
-                    'action' => 'edit',
-                    'post'   => $event_id,
-                ),
-                admin_url('admin.php')
-            );
-            //next and previous links
-            $next_reg                                      = $this->_registration->next(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['next_registration']     = $next_reg
-                ? $this->_next_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $next_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-right ee-icon-size-22'
-                )
-                : '';
-            $previous_reg                                  = $this->_registration->previous(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['previous_registration'] = $previous_reg
-                ? $this->_previous_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $previous_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-left ee-icon-size-22'
-                )
-                : '';
-            // grab header
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
-            $this->_template_args['REG_ID']            = $this->_registration->ID();
-            $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-            );
-        } else {
-            $this->_template_args['admin_page_header'] = $this->display_espresso_notices();
-        }
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _registration_details_metaboxes()
-    {
-        do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
-        $this->_set_registration_object();
-        $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
-        add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
-            array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
-        add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
-            array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registration',
-                'edit-reg-questions-mbox',
-                $this->_registration->ID()
-            )
-        ) {
-            add_meta_box(
-                'edit-reg-questions-mbox',
-                esc_html__('Registration Form Answers', 'event_espresso'),
-                array($this, '_reg_questions_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-        add_meta_box(
-            'edit-reg-registrant-mbox',
-            esc_html__('Contact Details', 'event_espresso'),
-            array($this, '_reg_registrant_side_meta_box'),
-            $this->wp_page_slug,
-            'side',
-            'high'
-        );
-        if ($this->_registration->group_size() > 1) {
-            add_meta_box(
-                'edit-reg-attendees-mbox',
-                esc_html__('Other Registrations in this Transaction', 'event_espresso'),
-                array($this, '_reg_attendees_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-    }
-
-
-    /**
-     * set_reg_status_buttons_metabox
-     *
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    public function set_reg_status_buttons_metabox()
-    {
-        $this->_set_registration_object();
-        $change_reg_status_form = $this->_generate_reg_status_change_form();
-        echo $change_reg_status_form->form_open(
-            self::add_query_args_and_nonce(
-                array(
-                    'action' => 'change_reg_status',
-                ),
-                REG_ADMIN_URL
-            )
-        );
-        echo $change_reg_status_form->get_html();
-        echo $change_reg_status_form->form_close();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _generate_reg_status_change_form()
-    {
-        return new EE_Form_Section_Proper(array(
-            'name'            => 'reg_status_change_form',
-            'html_id'         => 'reg-status-change-form',
-            'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-            'subsections'     => array(
-                'return'             => new EE_Hidden_Input(array(
-                    'name'    => 'return',
-                    'default' => 'view_registration',
-                )),
-                'REG_ID'             => new EE_Hidden_Input(array(
-                    'name'    => 'REG_ID',
-                    'default' => $this->_registration->ID(),
-                )),
-                'current_status'     => new EE_Form_Section_HTML(
-                    EEH_HTML::tr(
-                        EEH_HTML::th(
-                            EEH_HTML::label(
-                                EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
-                                )
-                            )
-                        )
-                        . EEH_HTML::td(
-                            EEH_HTML::strong(
-                                $this->_registration->pretty_status(),
-                                '',
-                                'status-' . $this->_registration->status_ID(),
-                                'line-height: 1em; font-size: 1.5em; font-weight: bold;'
-                            )
-                        )
-                    )
-                ),
-                'reg_status'         => new EE_Select_Input(
-                    $this->_get_reg_statuses(),
-                    array(
-                        'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
-                        'default'         => $this->_registration->status_ID(),
-                    )
-                ),
-                'send_notifications' => new EE_Yes_No_Input(
-                    array(
-                        'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
-                        'default'         => false,
-                        'html_help_text'  => esc_html__(
-                            'If set to "Yes", then the related messages will be sent to the registrant.',
-                            'event_espresso'
-                        ),
-                    )
-                ),
-                'submit'             => new EE_Submit_Input(
-                    array(
-                        'html_class'      => 'button-primary',
-                        'html_label_text' => '&nbsp;',
-                        'default'         => esc_html__('Update Registration Status', 'event_espresso'),
-                    )
-                ),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns an array of all the buttons for the various statuses and switch status actions
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EntityNotFoundException
-     */
-    protected function _get_reg_statuses()
-    {
-        $reg_status_array = EEM_Registration::instance()->reg_status_array();
-        unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
-        // get current reg status
-        $current_status = $this->_registration->status_ID();
-        // is registration for free event? This will determine whether to display the pending payment option
-        if (
-            $current_status !== EEM_Registration::status_id_pending_payment
-            && EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
-        ) {
-            unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
-        }
-        return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
-    }
-
-
-    /**
-     * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
-     *
-     * @param bool $status REG status given for changing registrations to.
-     * @param bool $notify Whether to send messages notifications or not.
-     * @return array (array with reg_id(s) updated and whether update was successful.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     */
-    protected function _set_registration_status_from_request($status = false, $notify = false)
-    {
-        if (isset($this->_req_data['reg_status_change_form'])) {
-            $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID']
-                : array();
-        } else {
-            $REG_IDs = isset($this->_req_data['_REG_ID'])
-                ? (array)$this->_req_data['_REG_ID']
-                : array();
-        }
-        // sanitize $REG_IDs
-        $REG_IDs = array_map('absint', $REG_IDs);
-        // and remove empty entries
-        $REG_IDs = array_filter($REG_IDs);
-
-        $result = $this->_set_registration_status($REG_IDs, $status, $notify);
-
-        /**
-         * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
-         * Currently this value is used downstream by the _process_resend_registration method.
-         *
-         * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
-         * @param bool                     $status           The status registrations were changed to.
-         * @param bool                     $success          If the status was changed successfully for all registrations.
-         * @param Registrations_Admin_Page $admin_page_object
-         */
-        $this->_req_data['_REG_ID'] = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
-            $result['REG_ID'],
-            $status,
-            $result['success'],
-            $this
-        );
-
-        //notify?
-        if ($notify
-            && $result['success']
-            && ! empty($this->_req_data['_REG_ID'])
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_process_resend_registration();
-        }
-        return $result;
-    }
-
-
-    /**
-     * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
-     * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
-     *
-     * @param array  $REG_IDs
-     * @param string $status
-     * @param bool   $notify  Used to indicate whether notification was requested or not.  This determines the context
-     *                        slug sent with setting the registration status.
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     */
-    protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false)
-    {
-        $success = false;
-        // typecast $REG_IDs
-        $REG_IDs = (array)$REG_IDs;
-        if ( ! empty($REG_IDs)) {
-            $success = true;
-            // set default status if none is passed
-            $status = $status ? $status : EEM_Registration::status_id_pending_payment;
-            $status_context = $notify
-                ? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-                : Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
-            //loop through REG_ID's and change status
-            foreach ($REG_IDs as $REG_ID) {
-                $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_status(
-                        $status,
-                        false,
-                        new Context(
-                            $status_context,
-                            esc_html__(
-                                'Manually triggered status change on a Registration Admin Page route.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    $result = $registration->save();
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
-                    $success = $result !== false ? $success : false;
-                }
-            }
-        }
-
-        //return $success and processed registrations
-        return array('REG_ID' => $REG_IDs, 'success' => $success);
-    }
-
-
-    /**
-     * Common logic for setting up success message and redirecting to appropriate route
-     *
-     * @param  string $STS_ID status id for the registration changed to
-     * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _reg_status_change_return($STS_ID, $notify = false)
-    {
-        $result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
-            : array('success' => false);
-        $success = isset($result['success']) && $result['success'];
-        //setup success message
-        if ($success) {
-            if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
-                $msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
-            } else {
-                $msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
-            }
-            EE_Error::add_success($msg);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong, and the status was not changed',
-                    'event_espresso'
-                ), __FILE__, __LINE__, __FUNCTION__
-            );
-        }
-        if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
-            $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
-        } else {
-            $route = array('action' => 'default');
-        }
-        //unset nonces
-        foreach ($this->_req_data as $ref => $value) {
-            if (strpos($ref, 'nonce') !== false) {
-                unset($this->_req_data[$ref]);
-                continue;
-            }
-            $value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
-            $this->_req_data[$ref] = $value;
-        }
-        //merge request vars so that the reloaded list table contains any existing filter query params
-        $route = array_merge($this->_req_data, $route);
-        $this->_redirect_after_action($success, '', '', $route, true);
-    }
-
-
-    /**
-     * incoming reg status change from reg details page.
-     *
-     * @return void
-     */
-    protected function _change_reg_status()
-    {
-        $this->_req_data['return'] = 'view_registration';
-        //set notify based on whether the send notifications toggle is set or not
-        $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
-        //$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
-        $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
-            ? $this->_req_data['reg_status_change_form']['reg_status'] : '';
-        switch ($this->_req_data['reg_status_change_form']['reg_status']) {
-            case EEM_Registration::status_id_approved :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
-                $this->approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_pending_payment :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
-                $this->pending_registration($notify);
-                break;
-            case EEM_Registration::status_id_not_approved :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
-                $this->not_approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_declined :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
-                $this->decline_registration($notify);
-                break;
-            case EEM_Registration::status_id_cancelled :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
-                $this->cancel_registration($notify);
-                break;
-            case EEM_Registration::status_id_wait_list :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
-                $this->wait_list_registration($notify);
-                break;
-            case EEM_Registration::status_id_incomplete :
-            default :
-                $result['success'] = false;
-                unset($this->_req_data['return']);
-                $this->_reg_status_change_return('', false);
-                break;
-        }
-    }
-
-
-    /**
-     * Callback for bulk action routes.
-     * Note: although we could just register the singular route callbacks for each bulk action route as well, this
-     * method was chosen so there is one central place all the registration status bulk actions are going through.
-     * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
-     * when an action is happening on just a single registration).
-     * @param      $action
-     * @param bool $notify
-     */
-    protected function bulk_action_on_registrations($action, $notify = false) {
-        do_action(
-            'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
-            $this,
-            $action,
-            $notify
-        );
-        $method = $action . '_registration';
-        if (method_exists($this, $method)) {
-            $this->$method($notify);
-        }
-    }
-
-
-    /**
-     * approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their approval.
-     * @return void
-     */
-    protected function approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function decline_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
-    }
-
-
-    /**
-     *        cancel_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function cancel_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
-    }
-
-
-    /**
-     *        not_approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function not_approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function pending_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
-    }
-
-
-    /**
-     * waitlist_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function wait_list_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     */
-    public function _reg_details_meta_box()
-    {
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        EEH_Autoloader::register_line_item_filter_autoloaders();
-        EE_Registry::instance()->load_helper('Line_Item');
-        $transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
-            : EE_Transaction::new_instance();
-        $this->_session = $transaction->session_data();
-        $filters        = new EE_Line_Item_Filter_Collection();
-        //$filters->add( new EE_Non_Zero_Line_Item_Filter() );
-        $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
-        $line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
-            $transaction->total_line_item());
-        $filtered_line_item_tree                 = $line_item_filter_processor->process();
-        $line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
-            'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
-        $this->_template_args['line_item_table'] = $line_item_display->display_line_item(
-            $filtered_line_item_tree,
-            array('EE_Registration' => $this->_registration)
-        );
-        $attendee                                = $this->_registration->attendee();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_transaction',
-            'espresso_transactions_view_transaction'
-        )) {
-            $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'view_transaction',
-                        'TXN_ID' => $transaction->ID(),
-                    ),
-                    TXN_ADMIN_URL
-                ),
-                esc_html__(' View Transaction', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-cart'
-            );
-        } else {
-            $this->_template_args['view_transaction_button'] = '';
-        }
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'      => 'resend_registration',
-                        '_REG_ID'     => $this->_registration->ID(),
-                        'redirect_to' => 'view_registration',
-                    ),
-                    REG_ADMIN_URL
-                ),
-                esc_html__(' Resend Registration', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-email-alt'
-            );
-        } else {
-            $this->_template_args['resend_registration_button'] = '';
-        }
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        $payment                               = $transaction->get_first_related('Payment');
-        $payment                               = ! $payment instanceof EE_Payment
-            ? EE_Payment::new_instance()
-            : $payment;
-        $payment_method                        = $payment->get_first_related('Payment_Method');
-        $payment_method                        = ! $payment_method instanceof EE_Payment_Method
-            ? EE_Payment_Method::new_instance()
-            : $payment_method;
-        $reg_details                           = array(
-            'payment_method'       => $payment_method->name(),
-            'response_msg'         => $payment->gateway_response(),
-            'registration_id'      => $this->_registration->get('REG_code'),
-            'registration_session' => $this->_registration->session_ID(),
-            'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
-            'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
-        );
-        if (isset($reg_details['registration_id'])) {
-            $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
-            $this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
-                'Registration ID',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
-        }
-        if (isset($reg_details['payment_method'])) {
-            $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
-            $this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
-                'Most Recent Payment Method',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
-            $this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
-            $this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
-                'Payment method response',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
-        }
-        $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
-        $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
-        $this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
-        $this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
-            'Registration placed from IP',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
-        $this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
-        $this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
-            'event_espresso');
-        $this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
-        $this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'   => 'default',
-                'event_id' => $this->_registration->event_ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $this->_template_args['REG_ID']                                       = $this->_registration->ID();
-        $this->_template_args['event_id']                                     = $this->_registration->event_ID();
-        $template_path                                                        =
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * generates HTML for the Registration Questions meta box.
-     * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
-     * otherwise uses new forms system
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_questions_meta_box()
-    {
-        //allow someone to override this method entirely
-        if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
-            $this->_registration)) {
-            $form                                              = $this->_get_reg_custom_questions_form(
-                $this->_registration->ID()
-            );
-            $this->_template_args['att_questions']             = count($form->subforms()) > 0
-                ? $form->get_html_and_js()
-                : '';
-            $this->_template_args['reg_questions_form_action'] = 'edit_registration';
-            $this->_template_args['REG_ID']                    = $this->_registration->ID();
-            $template_path                                     =
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-            echo EEH_Template::display_template($template_path, $this->_template_args, true);
-        }
-    }
-
-
-    /**
-     * form_before_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_before_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+		if (! empty($registration_status)) {
+			$where['STS_ID'] = $registration_status;
+		} else {
+			//make sure we exclude incomplete registrations, but only if not trashed.
+			if ($view === 'trash') {
+				$where['REG_deleted'] = true;
+			} elseif ($view === 'incomplete') {
+				$where['STS_ID'] = EEM_Registration::status_id_incomplete;
+			} else {
+				$where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided date restraints to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_date_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$month_range             = ! empty($request['month_range'])
+			? sanitize_text_field($request['month_range'])
+			: '';
+		$retrieve_for_today      = $view === 'today';
+		$retrieve_for_this_month = $view === 'month';
+
+		if ($retrieve_for_today) {
+			$now               = date('Y-m-d', current_time('timestamp'));
+			$where['REG_date'] = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($retrieve_for_this_month) {
+			$current_year_and_month = date('Y-m', current_time('timestamp'));
+			$days_this_month        = date('t', current_time('timestamp'));
+			$where['REG_date']      = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-01 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($month_range) {
+			$pieces          = explode(' ', $month_range, 3);
+			$month_requested = ! empty($pieces[0])
+				? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
+				: '';
+			$year_requested  = ! empty($pieces[1])
+				? $pieces[1]
+				: '';
+			//if there is not a month or year then we can't go further
+			if ($month_requested && $year_requested) {
+				$days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+				$where['REG_date'] = array(
+					'BETWEEN',
+					array(
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
+							'Y-m-d H:i:s'
+						),
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+							'Y-m-d H:i:s'
+						),
+					),
+				);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided search restraints to the where conditions for the registrations query
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_search_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['s'])) {
+			$search_string = '%' . sanitize_text_field($request['s']) . '%';
+			$where['OR*search_conditions'] = array(
+				'Event.EVT_name'                          => array('LIKE', $search_string),
+				'Event.EVT_desc'                          => array('LIKE', $search_string),
+				'Event.EVT_short_desc'                    => array('LIKE', $search_string),
+				'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
+				'Attendee.ATT_fname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_lname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
+				'Attendee.ATT_email'                      => array('LIKE', $search_string),
+				'Attendee.ATT_address'                    => array('LIKE', $search_string),
+				'Attendee.ATT_address2'                   => array('LIKE', $search_string),
+				'Attendee.ATT_city'                       => array('LIKE', $search_string),
+				'REG_final_price'                         => array('LIKE', $search_string),
+				'REG_code'                                => array('LIKE', $search_string),
+				'REG_count'                               => array('LIKE', $search_string),
+				'REG_group_size'                          => array('LIKE', $search_string),
+				'Ticket.TKT_name'                         => array('LIKE', $search_string),
+				'Ticket.TKT_description'                  => array('LIKE', $search_string),
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
+			);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @param array $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_where_conditions_for_registrations_query($request)
+	{
+		return apply_filters(
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
+			array_merge(
+				$this->addAttendeeIdToWhereConditions($request),
+				$this->_add_event_id_to_where_conditions($request),
+				$this->_add_category_id_to_where_conditions($request),
+				$this->_add_datetime_id_to_where_conditions($request),
+				$this->_add_registration_status_to_where_conditions($request),
+				$this->_add_date_to_where_conditions($request),
+				$this->_add_search_to_where_conditions($request)
+			),
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets up the orderby for the registrations query.
+	 *
+	 * @return array
+	 */
+	protected function _get_orderby_for_registrations_query()
+	{
+		$orderby_field = ! empty($this->_req_data['orderby'])
+			? sanitize_text_field($this->_req_data['orderby'])
+			: '';
+		switch ($orderby_field) {
+			case '_REG_ID':
+				$orderby = array('REG_ID');
+				break;
+			case '_Reg_status':
+				$orderby = array('STS_ID');
+				break;
+			case 'ATT_fname':
+				$orderby = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
+				break;
+			case 'ATT_lname':
+				$orderby = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
+				break;
+			case 'event_name':
+				$orderby = array('Event.EVT_name');
+				break;
+			case 'DTT_EVT_start':
+				$orderby = array('Event.Datetime.DTT_EVT_start');
+				break;
+			default: //'REG_date'
+				$orderby = array('REG_date');
+		}
+
+		//order
+		$order = ! empty($this->_req_data['order'])
+			? sanitize_text_field($this->_req_data['order'])
+			: 'DESC';
+		$orderby = array_combine(
+			$orderby,
+			array_fill(0, count($orderby), $order)
+		);
+		//because there are many registrations with the same date, define
+		//a secondary way to order them, otherwise MySQL seems to be a bit random
+		if (empty($orderby['REG_ID'])) {
+			$orderby['REG_ID'] = $order;
+		}
+		return array('order_by' => $orderby);
+	}
+
+
+	/**
+	 * Sets up the limit for the registrations query.
+	 *
+	 * @param $per_page
+	 * @return array
+	 */
+	protected function _get_limit($per_page)
+	{
+		$current_page = ! empty($this->_req_data['paged'])
+			? absint($this->_req_data['paged'])
+			: 1;
+		$per_page     = ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+
+		//-1 means return all results so get out if that's set.
+		if ((int)$per_page === -1) {
+			return array();
+		}
+		$per_page = absint($per_page);
+		$offset   = ($current_page - 1) * $per_page;
+		return array('limit' => array($offset, $per_page));
+	}
+
+
+	public function get_registration_status_array()
+	{
+		return self::$_reg_status;
+	}
+
+
+
+
+	/***************************************        REGISTRATION DETAILS        ***************************************/
+	/**
+	 *        generates HTML for the View Registration Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _registration_details()
+	{
+		$this->_template_args = array();
+		$this->_set_registration_object();
+		if (is_object($this->_registration)) {
+			$transaction                                   = $this->_registration->transaction()
+				? $this->_registration->transaction()
+				: EE_Transaction::new_instance();
+			$this->_session                                = $transaction->session_data();
+			$event_id                                      = $this->_registration->event_ID();
+			$this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
+			$this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
+			$this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
+			$this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
+			$this->_template_args['grand_total']           = $transaction->total();
+			$this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
+			// link back to overview
+			$this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
+			$this->_template_args['registration']                = $this->_registration;
+			$this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'default',
+					'event_id' => $event_id,
+				),
+				REG_ADMIN_URL
+			);
+			$this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'default',
+					'EVT_ID' => $event_id,
+					'page'   => 'espresso_transactions',
+				),
+				admin_url('admin.php')
+			);
+			$this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'   => 'espresso_events',
+					'action' => 'edit',
+					'post'   => $event_id,
+				),
+				admin_url('admin.php')
+			);
+			//next and previous links
+			$next_reg                                      = $this->_registration->next(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['next_registration']     = $next_reg
+				? $this->_next_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $next_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-right ee-icon-size-22'
+				)
+				: '';
+			$previous_reg                                  = $this->_registration->previous(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['previous_registration'] = $previous_reg
+				? $this->_previous_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $previous_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-left ee-icon-size-22'
+				)
+				: '';
+			// grab header
+			$template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+			$this->_template_args['REG_ID']            = $this->_registration->ID();
+			$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+			);
+		} else {
+			$this->_template_args['admin_page_header'] = $this->display_espresso_notices();
+		}
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _registration_details_metaboxes()
+	{
+		do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
+		$this->_set_registration_object();
+		$attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
+		add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
+			array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
+		add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
+			array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registration',
+				'edit-reg-questions-mbox',
+				$this->_registration->ID()
+			)
+		) {
+			add_meta_box(
+				'edit-reg-questions-mbox',
+				esc_html__('Registration Form Answers', 'event_espresso'),
+				array($this, '_reg_questions_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+		add_meta_box(
+			'edit-reg-registrant-mbox',
+			esc_html__('Contact Details', 'event_espresso'),
+			array($this, '_reg_registrant_side_meta_box'),
+			$this->wp_page_slug,
+			'side',
+			'high'
+		);
+		if ($this->_registration->group_size() > 1) {
+			add_meta_box(
+				'edit-reg-attendees-mbox',
+				esc_html__('Other Registrations in this Transaction', 'event_espresso'),
+				array($this, '_reg_attendees_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+	}
+
+
+	/**
+	 * set_reg_status_buttons_metabox
+	 *
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function set_reg_status_buttons_metabox()
+	{
+		$this->_set_registration_object();
+		$change_reg_status_form = $this->_generate_reg_status_change_form();
+		echo $change_reg_status_form->form_open(
+			self::add_query_args_and_nonce(
+				array(
+					'action' => 'change_reg_status',
+				),
+				REG_ADMIN_URL
+			)
+		);
+		echo $change_reg_status_form->get_html();
+		echo $change_reg_status_form->form_close();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _generate_reg_status_change_form()
+	{
+		return new EE_Form_Section_Proper(array(
+			'name'            => 'reg_status_change_form',
+			'html_id'         => 'reg-status-change-form',
+			'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+			'subsections'     => array(
+				'return'             => new EE_Hidden_Input(array(
+					'name'    => 'return',
+					'default' => 'view_registration',
+				)),
+				'REG_ID'             => new EE_Hidden_Input(array(
+					'name'    => 'REG_ID',
+					'default' => $this->_registration->ID(),
+				)),
+				'current_status'     => new EE_Form_Section_HTML(
+					EEH_HTML::tr(
+						EEH_HTML::th(
+							EEH_HTML::label(
+								EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
+								)
+							)
+						)
+						. EEH_HTML::td(
+							EEH_HTML::strong(
+								$this->_registration->pretty_status(),
+								'',
+								'status-' . $this->_registration->status_ID(),
+								'line-height: 1em; font-size: 1.5em; font-weight: bold;'
+							)
+						)
+					)
+				),
+				'reg_status'         => new EE_Select_Input(
+					$this->_get_reg_statuses(),
+					array(
+						'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
+						'default'         => $this->_registration->status_ID(),
+					)
+				),
+				'send_notifications' => new EE_Yes_No_Input(
+					array(
+						'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
+						'default'         => false,
+						'html_help_text'  => esc_html__(
+							'If set to "Yes", then the related messages will be sent to the registrant.',
+							'event_espresso'
+						),
+					)
+				),
+				'submit'             => new EE_Submit_Input(
+					array(
+						'html_class'      => 'button-primary',
+						'html_label_text' => '&nbsp;',
+						'default'         => esc_html__('Update Registration Status', 'event_espresso'),
+					)
+				),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns an array of all the buttons for the various statuses and switch status actions
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _get_reg_statuses()
+	{
+		$reg_status_array = EEM_Registration::instance()->reg_status_array();
+		unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
+		// get current reg status
+		$current_status = $this->_registration->status_ID();
+		// is registration for free event? This will determine whether to display the pending payment option
+		if (
+			$current_status !== EEM_Registration::status_id_pending_payment
+			&& EEH_Money::compare_floats($this->_registration->ticket()->price(), 0.00)
+		) {
+			unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
+		}
+		return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
+	}
+
+
+	/**
+	 * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
+	 *
+	 * @param bool $status REG status given for changing registrations to.
+	 * @param bool $notify Whether to send messages notifications or not.
+	 * @return array (array with reg_id(s) updated and whether update was successful.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _set_registration_status_from_request($status = false, $notify = false)
+	{
+		if (isset($this->_req_data['reg_status_change_form'])) {
+			$REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
+				? (array)$this->_req_data['reg_status_change_form']['REG_ID']
+				: array();
+		} else {
+			$REG_IDs = isset($this->_req_data['_REG_ID'])
+				? (array)$this->_req_data['_REG_ID']
+				: array();
+		}
+		// sanitize $REG_IDs
+		$REG_IDs = array_map('absint', $REG_IDs);
+		// and remove empty entries
+		$REG_IDs = array_filter($REG_IDs);
+
+		$result = $this->_set_registration_status($REG_IDs, $status, $notify);
+
+		/**
+		 * Set and filter $_req_data['_REG_ID'] for any potential future messages notifications.
+		 * Currently this value is used downstream by the _process_resend_registration method.
+		 *
+		 * @param int|array                $registration_ids The registration ids that have had their status changed successfully.
+		 * @param bool                     $status           The status registrations were changed to.
+		 * @param bool                     $success          If the status was changed successfully for all registrations.
+		 * @param Registrations_Admin_Page $admin_page_object
+		 */
+		$this->_req_data['_REG_ID'] = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_registration_status_from_request__REG_IDs',
+			$result['REG_ID'],
+			$status,
+			$result['success'],
+			$this
+		);
+
+		//notify?
+		if ($notify
+			&& $result['success']
+			&& ! empty($this->_req_data['_REG_ID'])
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_process_resend_registration();
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
+	 * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
+	 *
+	 * @param array  $REG_IDs
+	 * @param string $status
+	 * @param bool   $notify  Used to indicate whether notification was requested or not.  This determines the context
+	 *                        slug sent with setting the registration status.
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _set_registration_status($REG_IDs = array(), $status = '', $notify = false)
+	{
+		$success = false;
+		// typecast $REG_IDs
+		$REG_IDs = (array)$REG_IDs;
+		if ( ! empty($REG_IDs)) {
+			$success = true;
+			// set default status if none is passed
+			$status = $status ? $status : EEM_Registration::status_id_pending_payment;
+			$status_context = $notify
+				? Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+				: Domain::CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN;
+			//loop through REG_ID's and change status
+			foreach ($REG_IDs as $REG_ID) {
+				$registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+				if ($registration instanceof EE_Registration) {
+					$registration->set_status(
+						$status,
+						false,
+						new Context(
+							$status_context,
+							esc_html__(
+								'Manually triggered status change on a Registration Admin Page route.',
+								'event_espresso'
+							)
+						)
+					);
+					$result = $registration->save();
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
+					$success = $result !== false ? $success : false;
+				}
+			}
+		}
+
+		//return $success and processed registrations
+		return array('REG_ID' => $REG_IDs, 'success' => $success);
+	}
+
+
+	/**
+	 * Common logic for setting up success message and redirecting to appropriate route
+	 *
+	 * @param  string $STS_ID status id for the registration changed to
+	 * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _reg_status_change_return($STS_ID, $notify = false)
+	{
+		$result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
+			: array('success' => false);
+		$success = isset($result['success']) && $result['success'];
+		//setup success message
+		if ($success) {
+			if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
+				$msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
+			} else {
+				$msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
+			}
+			EE_Error::add_success($msg);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong, and the status was not changed',
+					'event_espresso'
+				), __FILE__, __LINE__, __FUNCTION__
+			);
+		}
+		if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
+			$route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
+		} else {
+			$route = array('action' => 'default');
+		}
+		//unset nonces
+		foreach ($this->_req_data as $ref => $value) {
+			if (strpos($ref, 'nonce') !== false) {
+				unset($this->_req_data[$ref]);
+				continue;
+			}
+			$value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
+			$this->_req_data[$ref] = $value;
+		}
+		//merge request vars so that the reloaded list table contains any existing filter query params
+		$route = array_merge($this->_req_data, $route);
+		$this->_redirect_after_action($success, '', '', $route, true);
+	}
+
+
+	/**
+	 * incoming reg status change from reg details page.
+	 *
+	 * @return void
+	 */
+	protected function _change_reg_status()
+	{
+		$this->_req_data['return'] = 'view_registration';
+		//set notify based on whether the send notifications toggle is set or not
+		$notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
+		//$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
+		$this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
+			? $this->_req_data['reg_status_change_form']['reg_status'] : '';
+		switch ($this->_req_data['reg_status_change_form']['reg_status']) {
+			case EEM_Registration::status_id_approved :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
+				$this->approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_pending_payment :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
+				$this->pending_registration($notify);
+				break;
+			case EEM_Registration::status_id_not_approved :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
+				$this->not_approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_declined :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
+				$this->decline_registration($notify);
+				break;
+			case EEM_Registration::status_id_cancelled :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
+				$this->cancel_registration($notify);
+				break;
+			case EEM_Registration::status_id_wait_list :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
+				$this->wait_list_registration($notify);
+				break;
+			case EEM_Registration::status_id_incomplete :
+			default :
+				$result['success'] = false;
+				unset($this->_req_data['return']);
+				$this->_reg_status_change_return('', false);
+				break;
+		}
+	}
+
+
+	/**
+	 * Callback for bulk action routes.
+	 * Note: although we could just register the singular route callbacks for each bulk action route as well, this
+	 * method was chosen so there is one central place all the registration status bulk actions are going through.
+	 * Potentially, this provides an easier place to locate logic that is specific to these bulk actions (as opposed to
+	 * when an action is happening on just a single registration).
+	 * @param      $action
+	 * @param bool $notify
+	 */
+	protected function bulk_action_on_registrations($action, $notify = false) {
+		do_action(
+			'AHEE__Registrations_Admin_Page__bulk_action_on_registrations__before_execution',
+			$this,
+			$action,
+			$notify
+		);
+		$method = $action . '_registration';
+		if (method_exists($this, $method)) {
+			$this->$method($notify);
+		}
+	}
+
+
+	/**
+	 * approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their approval.
+	 * @return void
+	 */
+	protected function approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function decline_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
+	}
+
+
+	/**
+	 *        cancel_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function cancel_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
+	}
+
+
+	/**
+	 *        not_approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function not_approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function pending_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
+	}
+
+
+	/**
+	 * waitlist_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function wait_list_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 */
+	public function _reg_details_meta_box()
+	{
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		EEH_Autoloader::register_line_item_filter_autoloaders();
+		EE_Registry::instance()->load_helper('Line_Item');
+		$transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
+			: EE_Transaction::new_instance();
+		$this->_session = $transaction->session_data();
+		$filters        = new EE_Line_Item_Filter_Collection();
+		//$filters->add( new EE_Non_Zero_Line_Item_Filter() );
+		$filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
+		$line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
+			$transaction->total_line_item());
+		$filtered_line_item_tree                 = $line_item_filter_processor->process();
+		$line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
+			'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
+		$this->_template_args['line_item_table'] = $line_item_display->display_line_item(
+			$filtered_line_item_tree,
+			array('EE_Registration' => $this->_registration)
+		);
+		$attendee                                = $this->_registration->attendee();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_transaction',
+			'espresso_transactions_view_transaction'
+		)) {
+			$this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'view_transaction',
+						'TXN_ID' => $transaction->ID(),
+					),
+					TXN_ADMIN_URL
+				),
+				esc_html__(' View Transaction', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-cart'
+			);
+		} else {
+			$this->_template_args['view_transaction_button'] = '';
+		}
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'      => 'resend_registration',
+						'_REG_ID'     => $this->_registration->ID(),
+						'redirect_to' => 'view_registration',
+					),
+					REG_ADMIN_URL
+				),
+				esc_html__(' Resend Registration', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-email-alt'
+			);
+		} else {
+			$this->_template_args['resend_registration_button'] = '';
+		}
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		$payment                               = $transaction->get_first_related('Payment');
+		$payment                               = ! $payment instanceof EE_Payment
+			? EE_Payment::new_instance()
+			: $payment;
+		$payment_method                        = $payment->get_first_related('Payment_Method');
+		$payment_method                        = ! $payment_method instanceof EE_Payment_Method
+			? EE_Payment_Method::new_instance()
+			: $payment_method;
+		$reg_details                           = array(
+			'payment_method'       => $payment_method->name(),
+			'response_msg'         => $payment->gateway_response(),
+			'registration_id'      => $this->_registration->get('REG_code'),
+			'registration_session' => $this->_registration->session_ID(),
+			'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
+			'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
+		);
+		if (isset($reg_details['registration_id'])) {
+			$this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
+			$this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
+				'Registration ID',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
+		}
+		if (isset($reg_details['payment_method'])) {
+			$this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
+			$this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
+				'Most Recent Payment Method',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
+			$this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
+			$this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
+				'Payment method response',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
+		}
+		$this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
+		$this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
+		$this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
+		$this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
+			'Registration placed from IP',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
+		$this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
+		$this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
+			'event_espresso');
+		$this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
+		$this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'   => 'default',
+				'event_id' => $this->_registration->event_ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$this->_template_args['REG_ID']                                       = $this->_registration->ID();
+		$this->_template_args['event_id']                                     = $this->_registration->event_ID();
+		$template_path                                                        =
+			REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * generates HTML for the Registration Questions meta box.
+	 * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
+	 * otherwise uses new forms system
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_questions_meta_box()
+	{
+		//allow someone to override this method entirely
+		if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
+			$this->_registration)) {
+			$form                                              = $this->_get_reg_custom_questions_form(
+				$this->_registration->ID()
+			);
+			$this->_template_args['att_questions']             = count($form->subforms()) > 0
+				? $form->get_html_and_js()
+				: '';
+			$this->_template_args['reg_questions_form_action'] = 'edit_registration';
+			$this->_template_args['REG_ID']                    = $this->_registration->ID();
+			$template_path                                     =
+				REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+			echo EEH_Template::display_template($template_path, $this->_template_args, true);
+		}
+	}
+
+
+	/**
+	 * form_before_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_before_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 	<table class="form-table ee-width-100">
 		<tbody>
 			';
-    }
-
-
-    /**
-     * form_after_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_after_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_after_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_after_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr class="hide-if-no-js">
 				<th> </th>
 				<td class="reg-admin-edit-attendee-question-td">
 					<a class="reg-admin-edit-attendee-question-lnk" href="#" title="'
-               . esc_attr__('click to edit question', 'event_espresso')
-               . '">
+			   . esc_attr__('click to edit question', 'event_espresso')
+			   . '">
 						<span class="reg-admin-edit-question-group-spn lt-grey-txt">'
-               . esc_html__('edit the above question group', 'event_espresso')
-               . '</span>
+			   . esc_html__('edit the above question group', 'event_espresso')
+			   . '</span>
 						<div class="dashicons dashicons-edit"></div>
 					</a>
 				</td>
@@ -2370,579 +2370,579 @@ 
 		</tbody>
 	</table>
 ';
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $label
-     * @return        string
-     */
-    public function form_form_field_label_wrap($label)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $label
+	 * @return        string
+	 */
+	public function form_form_field_label_wrap($label)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $input
-     * @return        string
-     */
-    public function form_form_field_input__wrap($input)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $input
+	 * @return        string
+	 */
+	public function form_form_field_input__wrap($input)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     * Updates the registration's custom questions according to the form info, if the form is submitted.
-     * If it's not a post, the "view_registrations" route will be called next on the SAME request
-     * to display the page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_attendee_registration_form()
-    {
-        do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            $REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
-            $success = $this->_save_reg_custom_questions_form($REG_ID);
-            if ($success) {
-                $what  = esc_html__('Registration Form', 'event_espresso');
-                $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
-                    : array('action' => 'default');
-                $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
-            }
-        }
-    }
-
-
-    /**
-     * Gets the form for saving registrations custom questions (if done
-     * previously retrieves the cached form object, which may have validation errors in it)
-     *
-     * @param int $REG_ID
-     * @return EE_Registration_Custom_Questions_Form
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_reg_custom_questions_form($REG_ID)
-    {
-        if ( ! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
-            $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
-                EEM_Registration::instance()->get_one_by_ID($REG_ID)
-            );
-            $this->_reg_custom_questions_form->_construct_finalize(null, null);
-        }
-        return $this->_reg_custom_questions_form;
-    }
-
-
-    /**
-     * Saves
-     *
-     * @access private
-     * @param bool $REG_ID
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _save_reg_custom_questions_form($REG_ID = false)
-    {
-        if ( ! $REG_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No registration ID was received.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $form = $this->_get_reg_custom_questions_form($REG_ID);
-        $form->receive_form_submission($this->_req_data);
-        $success = false;
-        if ($form->is_valid()) {
-            foreach ($form->subforms() as $question_group_id => $question_group_form) {
-                foreach ($question_group_form->inputs() as $question_id => $input) {
-                    $where_conditions    = array(
-                        'QST_ID' => $question_id,
-                        'REG_ID' => $REG_ID,
-                    );
-                    $possibly_new_values = array(
-                        'ANS_value' => $input->normalized_value(),
-                    );
-                    $answer              = EEM_Answer::instance()->get_one(array($where_conditions));
-                    if ($answer instanceof EE_Answer) {
-                        $success = $answer->save($possibly_new_values);
-                    } else {
-                        //insert it then
-                        $cols_n_vals = array_merge($where_conditions, $possibly_new_values);
-                        $answer      = EE_Answer::new_instance($cols_n_vals);
-                        $success     = $answer->save();
-                    }
-                }
-            }
-        } else {
-            EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $success;
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _reg_attendees_meta_box()
-    {
-        $REG = EEM_Registration::instance();
-        //get all other registrations on this transaction, and cache
-        //the attendees for them so we don't have to run another query using force_join
-        $registrations                           = $REG->get_all(array(
-            array(
-                'TXN_ID' => $this->_registration->transaction_ID(),
-                'REG_ID' => array('!=', $this->_registration->ID()),
-            ),
-            'force_join' => array('Attendee'),
-        ));
-        $this->_template_args['attendees']       = array();
-        $this->_template_args['attendee_notice'] = '';
-        if (empty($registrations)
-            || (is_array($registrations)
-                && ! EEH_Array::get_one_item_from_array($registrations))
-        ) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There are no records attached to this registration. Something may have gone wrong with the registration',
-                    'event_espresso'
-                ), __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_template_args['attendee_notice'] = EE_Error::get_notices();
-        } else {
-            $att_nmbr = 1;
-            foreach ($registrations as $registration) {
-                /* @var $registration EE_Registration */
-                $attendee                                                    = $registration->attendee()
-                    ? $registration->attendee()
-                    : EEM_Attendee::instance()
-                                  ->create_default_object();
-                $this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
-                $this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
-                $this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
-                $this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
-                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
-                $this->_template_args['attendees'][$att_nmbr]['address']     = implode(
-                    ', ',
-                    $attendee->full_address_as_array()
-                );
-                $this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
-                    array(
-                        'action' => 'edit_attendee',
-                        'post'   => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
-                $att_nmbr++;
-            }
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Edit Registration side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _reg_registrant_side_meta_box()
-    {
-        /*@var $attendee EE_Attendee */
-        $att_check = $this->_registration->attendee();
-        $attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
-        //now let's determine if this is not the primary registration.  If it isn't then we set the
-        //primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
-        //primary registration object (that way we know if we need to show create button or not)
-        if ( ! $this->_registration->is_primary_registrant()) {
-            $primary_registration = $this->_registration->get_primary_registration();
-            $primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
-                : null;
-            if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
-                //in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
-                //custom attendee object so let's not worry about the primary reg.
-                $primary_registration = null;
-            }
-        } else {
-            $primary_registration = null;
-        }
-        $this->_template_args['ATT_ID']            = $attendee->ID();
-        $this->_template_args['fname']             = $attendee->fname();
-        $this->_template_args['lname']             = $attendee->lname();
-        $this->_template_args['email']             = $attendee->email();
-        $this->_template_args['phone']             = $attendee->phone();
-        $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
-        //edit link
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'edit_attendee',
-            'post'   => $attendee->ID(),
-        ), REG_ADMIN_URL);
-        $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
-        //create link
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(array(
-                'action'  => 'duplicate_attendee',
-                '_REG_ID' => $this->_registration->ID(),
-            ), REG_ADMIN_URL) : '';
-        $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
-        $this->_template_args['att_check']    = $att_check;
-        $template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * trash or restore registrations
-     *
-     * @param  boolean $trash whether to archive or restore
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @access protected
-     */
-    protected function _trash_or_restore_registrations($trash = true)
-    {
-        //if empty _REG_ID then get out because there's nothing to do
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
-                        'event_espresso'
-                    ),
-                    $trash ? 'trash' : 'restore'
-                ),
-                __FILE__, __LINE__, __FUNCTION__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-        $success = 0;
-        $overwrite_msgs = false;
-        //Checkboxes
-        if ( ! is_array($this->_req_data['_REG_ID'])) {
-            $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
-        }
-        $reg_count = count($this->_req_data['_REG_ID']);
-        // cycle thru checkboxes
-        foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
-            /** @var EE_Registration $REG */
-            $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-            $payments = $REG->registration_payments();
-            if (! empty($payments)) {
-                $name = $REG->attendee() instanceof EE_Attendee
-                    ? $REG->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $overwrite_msgs = true;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
-                            'event_espresso'
-                        ),
-                        $name
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                //can't trash this registration because it has payments.
-                continue;
-            }
-            $updated = $trash ? $REG->delete() : $REG->restore();
-            if ($updated) {
-                $success++;
-            }
-        }
-        $this->_redirect_after_action(
-            $success === $reg_count, // were ALL registrations affected?
-            $success > 1
-                ? esc_html__('Registrations', 'event_espresso')
-                : esc_html__('Registration', 'event_espresso'),
-            $trash
-                ? esc_html__('moved to the trash', 'event_espresso')
-                : esc_html__('restored', 'event_espresso'),
-            array('action' => 'default'),
-            $overwrite_msgs
-        );
-    }
-
-
-    /**
-     * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
-     * registration but also.
-     * 1. Removing relations to EE_Attendee
-     * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
-     * ALSO trashed.
-     * 3. Deleting permanently any related Line items but only if the above conditions are met.
-     * 4. Removing relationships between all tickets and the related registrations
-     * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
-     * 6. Deleting permanently any related Checkins.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_registrations()
-    {
-        $REG_MDL = EEM_Registration::instance();
-        $success = 1;
-        //Checkboxes
-        if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
-                $REG = $REG_MDL->get_one_by_ID($REG_ID);
-                if ( ! $REG instanceof EE_Registration) {
-                    continue;
-                }
-                $deleted = $this->_delete_registration($REG);
-                if ( ! $deleted) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $REG_ID  = $this->_req_data['_REG_ID'];
-            $REG     = $REG_MDL->get_one_by_ID($REG_ID);
-            $deleted = $this->_delete_registration($REG);
-            if ( ! $deleted) {
-                $success = 0;
-            }
-        }
-        $what        = $success > 1
-            ? esc_html__('Registrations', 'event_espresso')
-            : esc_html__('Registration', 'event_espresso');
-        $action_desc = esc_html__('permanently deleted.', 'event_espresso');
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            $action_desc,
-            array('action' => 'default'),
-            true
-        );
-    }
-
-
-    /**
-     * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
-     * models get affected.
-     *
-     * @param  EE_Registration $REG registration to be deleted permenantly
-     * @return bool true = successful deletion, false = fail.
-     * @throws EE_Error
-     */
-    protected function _delete_registration(EE_Registration $REG)
-    {
-        //first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
-        //registrations on the transaction that are NOT trashed.
-        $TXN         = $REG->get_first_related('Transaction');
-        $REGS        = $TXN->get_many_related('Registration');
-        $all_trashed = true;
-        foreach ($REGS as $registration) {
-            if ( ! $registration->get('REG_deleted')) {
-                $all_trashed = false;
-            }
-        }
-        if ( ! $all_trashed) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        //k made it here so that means we can delete all the related transactions and their answers (but let's do them
-        //separately from THIS one).
-        foreach ($REGS as $registration) {
-            //delete related answers
-            $registration->delete_related_permanently('Answer');
-            //remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
-            $attendee = $registration->get_first_related('Attendee');
-            if ($attendee instanceof EE_Attendee) {
-                $registration->_remove_relation_to($attendee, 'Attendee');
-            }
-            //now remove relationships to tickets on this registration.
-            $registration->_remove_relations('Ticket');
-            //now delete permanently the checkins related to this registration.
-            $registration->delete_related_permanently('Checkin');
-            if ($registration->ID() === $REG->ID()) {
-                continue;
-            } //we don't want to delete permanently the existing registration just yet.
-            //remove relation to transaction for these registrations if NOT the existing registrations
-            $registration->_remove_relations('Transaction');
-            //delete permanently any related messages.
-            $registration->delete_related_permanently('Message');
-            //now delete this registration permanently
-            $registration->delete_permanently();
-        }
-        //now all related registrations on the transaction are handled.  So let's just handle this registration itself
-        // (the transaction and line items should be all that's left).
-        // delete the line items related to the transaction for this registration.
-        $TXN->delete_related_permanently('Line_Item');
-        //we need to remove all the relationships on the transaction
-        $TXN->delete_related_permanently('Payment');
-        $TXN->delete_related_permanently('Extra_Meta');
-        $TXN->delete_related_permanently('Message');
-        //now we can delete this REG permanently (and the transaction of course)
-        $REG->delete_related_permanently('Transaction');
-        return $REG->delete_permanently();
-    }
-
-
-    /**
-     *    generates HTML for the Register New Attendee Admin page
-     *
-     * @access private
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function new_registration()
-    {
-        if ( ! $this->_set_reg_event()) {
-            throw new EE_Error(
-                esc_html__(
-                    'Unable to continue with registering because there is no Event ID in the request',
-                    'event_espresso'
-                )
-            );
-        }
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        // gotta start with a clean slate if we're not coming here via ajax
-        if ( ! defined('DOING_AJAX')
-             && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
-        ) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        $this->_template_args['event_name'] = '';
-        // event name
-        if ($this->_reg_event) {
-            $this->_template_args['event_name'] = $this->_reg_event->name();
-            $edit_event_url                     = self::add_query_args_and_nonce(array(
-                'action' => 'edit',
-                'post'   => $this->_reg_event->ID(),
-            ), EVENTS_ADMIN_URL);
-            $edit_event_lnk                     = '<a href="'
-                                                  . $edit_event_url
-                                                  . '" title="'
-                                                  . esc_attr__('Edit ', 'event_espresso')
-                                                  . $this->_reg_event->name()
-                                                  . '">'
-                                                  . esc_html__('Edit Event', 'event_espresso')
-                                                  . '</a>';
-            $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
-                                                   . $edit_event_lnk
-                                                   . '</span>';
-        }
-        $this->_template_args['step_content'] = $this->_get_registration_step_content();
-        if (defined('DOING_AJAX')) {
-            $this->_return_json();
-        }
-        // grab header
-        $template_path                              =
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
-            $this->_template_args, true);
-        //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This returns the content for a registration step
-     *
-     * @access protected
-     * @return string html
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_registration_step_content()
-    {
-        if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
-            $warning_msg = sprintf(
-                esc_html__(
-                    '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                '<h3 class="important-notice">',
-                '</h3>',
-                '<div class="float-right">',
-                '<span id="redirect_timer" class="important-notice">30</span>',
-                '</div>',
-                '<b>',
-                '</b>'
-            );
-            return '
+	}
+
+
+	/**
+	 * Updates the registration's custom questions according to the form info, if the form is submitted.
+	 * If it's not a post, the "view_registrations" route will be called next on the SAME request
+	 * to display the page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_attendee_registration_form()
+	{
+		do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			$REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
+			$success = $this->_save_reg_custom_questions_form($REG_ID);
+			if ($success) {
+				$what  = esc_html__('Registration Form', 'event_espresso');
+				$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
+					: array('action' => 'default');
+				$this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the form for saving registrations custom questions (if done
+	 * previously retrieves the cached form object, which may have validation errors in it)
+	 *
+	 * @param int $REG_ID
+	 * @return EE_Registration_Custom_Questions_Form
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_reg_custom_questions_form($REG_ID)
+	{
+		if ( ! $this->_reg_custom_questions_form) {
+			require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
+			$this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
+				EEM_Registration::instance()->get_one_by_ID($REG_ID)
+			);
+			$this->_reg_custom_questions_form->_construct_finalize(null, null);
+		}
+		return $this->_reg_custom_questions_form;
+	}
+
+
+	/**
+	 * Saves
+	 *
+	 * @access private
+	 * @param bool $REG_ID
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _save_reg_custom_questions_form($REG_ID = false)
+	{
+		if ( ! $REG_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No registration ID was received.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$form = $this->_get_reg_custom_questions_form($REG_ID);
+		$form->receive_form_submission($this->_req_data);
+		$success = false;
+		if ($form->is_valid()) {
+			foreach ($form->subforms() as $question_group_id => $question_group_form) {
+				foreach ($question_group_form->inputs() as $question_id => $input) {
+					$where_conditions    = array(
+						'QST_ID' => $question_id,
+						'REG_ID' => $REG_ID,
+					);
+					$possibly_new_values = array(
+						'ANS_value' => $input->normalized_value(),
+					);
+					$answer              = EEM_Answer::instance()->get_one(array($where_conditions));
+					if ($answer instanceof EE_Answer) {
+						$success = $answer->save($possibly_new_values);
+					} else {
+						//insert it then
+						$cols_n_vals = array_merge($where_conditions, $possibly_new_values);
+						$answer      = EE_Answer::new_instance($cols_n_vals);
+						$success     = $answer->save();
+					}
+				}
+			}
+		} else {
+			EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _reg_attendees_meta_box()
+	{
+		$REG = EEM_Registration::instance();
+		//get all other registrations on this transaction, and cache
+		//the attendees for them so we don't have to run another query using force_join
+		$registrations                           = $REG->get_all(array(
+			array(
+				'TXN_ID' => $this->_registration->transaction_ID(),
+				'REG_ID' => array('!=', $this->_registration->ID()),
+			),
+			'force_join' => array('Attendee'),
+		));
+		$this->_template_args['attendees']       = array();
+		$this->_template_args['attendee_notice'] = '';
+		if (empty($registrations)
+			|| (is_array($registrations)
+				&& ! EEH_Array::get_one_item_from_array($registrations))
+		) {
+			EE_Error::add_error(
+				esc_html__(
+					'There are no records attached to this registration. Something may have gone wrong with the registration',
+					'event_espresso'
+				), __FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_template_args['attendee_notice'] = EE_Error::get_notices();
+		} else {
+			$att_nmbr = 1;
+			foreach ($registrations as $registration) {
+				/* @var $registration EE_Registration */
+				$attendee                                                    = $registration->attendee()
+					? $registration->attendee()
+					: EEM_Attendee::instance()
+								  ->create_default_object();
+				$this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
+				$this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
+				$this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
+				$this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
+				$this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
+				$this->_template_args['attendees'][$att_nmbr]['address']     = implode(
+					', ',
+					$attendee->full_address_as_array()
+				);
+				$this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
+					array(
+						'action' => 'edit_attendee',
+						'post'   => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
+				$att_nmbr++;
+			}
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		}
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Edit Registration side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _reg_registrant_side_meta_box()
+	{
+		/*@var $attendee EE_Attendee */
+		$att_check = $this->_registration->attendee();
+		$attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
+		//now let's determine if this is not the primary registration.  If it isn't then we set the
+		//primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
+		//primary registration object (that way we know if we need to show create button or not)
+		if ( ! $this->_registration->is_primary_registrant()) {
+			$primary_registration = $this->_registration->get_primary_registration();
+			$primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
+				: null;
+			if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
+				//in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
+				//custom attendee object so let's not worry about the primary reg.
+				$primary_registration = null;
+			}
+		} else {
+			$primary_registration = null;
+		}
+		$this->_template_args['ATT_ID']            = $attendee->ID();
+		$this->_template_args['fname']             = $attendee->fname();
+		$this->_template_args['lname']             = $attendee->lname();
+		$this->_template_args['email']             = $attendee->email();
+		$this->_template_args['phone']             = $attendee->phone();
+		$this->_template_args['formatted_address'] = EEH_Address::format($attendee);
+		//edit link
+		$this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'edit_attendee',
+			'post'   => $attendee->ID(),
+		), REG_ADMIN_URL);
+		$this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
+		//create link
+		$this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(array(
+				'action'  => 'duplicate_attendee',
+				'_REG_ID' => $this->_registration->ID(),
+			), REG_ADMIN_URL) : '';
+		$this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
+		$this->_template_args['att_check']    = $att_check;
+		$template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * trash or restore registrations
+	 *
+	 * @param  boolean $trash whether to archive or restore
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @access protected
+	 */
+	protected function _trash_or_restore_registrations($trash = true)
+	{
+		//if empty _REG_ID then get out because there's nothing to do
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
+						'event_espresso'
+					),
+					$trash ? 'trash' : 'restore'
+				),
+				__FILE__, __LINE__, __FUNCTION__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+		$success = 0;
+		$overwrite_msgs = false;
+		//Checkboxes
+		if ( ! is_array($this->_req_data['_REG_ID'])) {
+			$this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
+		}
+		$reg_count = count($this->_req_data['_REG_ID']);
+		// cycle thru checkboxes
+		foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
+			/** @var EE_Registration $REG */
+			$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+			$payments = $REG->registration_payments();
+			if (! empty($payments)) {
+				$name = $REG->attendee() instanceof EE_Attendee
+					? $REG->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$overwrite_msgs = true;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
+							'event_espresso'
+						),
+						$name
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				//can't trash this registration because it has payments.
+				continue;
+			}
+			$updated = $trash ? $REG->delete() : $REG->restore();
+			if ($updated) {
+				$success++;
+			}
+		}
+		$this->_redirect_after_action(
+			$success === $reg_count, // were ALL registrations affected?
+			$success > 1
+				? esc_html__('Registrations', 'event_espresso')
+				: esc_html__('Registration', 'event_espresso'),
+			$trash
+				? esc_html__('moved to the trash', 'event_espresso')
+				: esc_html__('restored', 'event_espresso'),
+			array('action' => 'default'),
+			$overwrite_msgs
+		);
+	}
+
+
+	/**
+	 * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
+	 * registration but also.
+	 * 1. Removing relations to EE_Attendee
+	 * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
+	 * ALSO trashed.
+	 * 3. Deleting permanently any related Line items but only if the above conditions are met.
+	 * 4. Removing relationships between all tickets and the related registrations
+	 * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
+	 * 6. Deleting permanently any related Checkins.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_registrations()
+	{
+		$REG_MDL = EEM_Registration::instance();
+		$success = 1;
+		//Checkboxes
+		if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
+				$REG = $REG_MDL->get_one_by_ID($REG_ID);
+				if ( ! $REG instanceof EE_Registration) {
+					continue;
+				}
+				$deleted = $this->_delete_registration($REG);
+				if ( ! $deleted) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$REG_ID  = $this->_req_data['_REG_ID'];
+			$REG     = $REG_MDL->get_one_by_ID($REG_ID);
+			$deleted = $this->_delete_registration($REG);
+			if ( ! $deleted) {
+				$success = 0;
+			}
+		}
+		$what        = $success > 1
+			? esc_html__('Registrations', 'event_espresso')
+			: esc_html__('Registration', 'event_espresso');
+		$action_desc = esc_html__('permanently deleted.', 'event_espresso');
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			array('action' => 'default'),
+			true
+		);
+	}
+
+
+	/**
+	 * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
+	 * models get affected.
+	 *
+	 * @param  EE_Registration $REG registration to be deleted permenantly
+	 * @return bool true = successful deletion, false = fail.
+	 * @throws EE_Error
+	 */
+	protected function _delete_registration(EE_Registration $REG)
+	{
+		//first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
+		//registrations on the transaction that are NOT trashed.
+		$TXN         = $REG->get_first_related('Transaction');
+		$REGS        = $TXN->get_many_related('Registration');
+		$all_trashed = true;
+		foreach ($REGS as $registration) {
+			if ( ! $registration->get('REG_deleted')) {
+				$all_trashed = false;
+			}
+		}
+		if ( ! $all_trashed) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		//k made it here so that means we can delete all the related transactions and their answers (but let's do them
+		//separately from THIS one).
+		foreach ($REGS as $registration) {
+			//delete related answers
+			$registration->delete_related_permanently('Answer');
+			//remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
+			$attendee = $registration->get_first_related('Attendee');
+			if ($attendee instanceof EE_Attendee) {
+				$registration->_remove_relation_to($attendee, 'Attendee');
+			}
+			//now remove relationships to tickets on this registration.
+			$registration->_remove_relations('Ticket');
+			//now delete permanently the checkins related to this registration.
+			$registration->delete_related_permanently('Checkin');
+			if ($registration->ID() === $REG->ID()) {
+				continue;
+			} //we don't want to delete permanently the existing registration just yet.
+			//remove relation to transaction for these registrations if NOT the existing registrations
+			$registration->_remove_relations('Transaction');
+			//delete permanently any related messages.
+			$registration->delete_related_permanently('Message');
+			//now delete this registration permanently
+			$registration->delete_permanently();
+		}
+		//now all related registrations on the transaction are handled.  So let's just handle this registration itself
+		// (the transaction and line items should be all that's left).
+		// delete the line items related to the transaction for this registration.
+		$TXN->delete_related_permanently('Line_Item');
+		//we need to remove all the relationships on the transaction
+		$TXN->delete_related_permanently('Payment');
+		$TXN->delete_related_permanently('Extra_Meta');
+		$TXN->delete_related_permanently('Message');
+		//now we can delete this REG permanently (and the transaction of course)
+		$REG->delete_related_permanently('Transaction');
+		return $REG->delete_permanently();
+	}
+
+
+	/**
+	 *    generates HTML for the Register New Attendee Admin page
+	 *
+	 * @access private
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function new_registration()
+	{
+		if ( ! $this->_set_reg_event()) {
+			throw new EE_Error(
+				esc_html__(
+					'Unable to continue with registering because there is no Event ID in the request',
+					'event_espresso'
+				)
+			);
+		}
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		// gotta start with a clean slate if we're not coming here via ajax
+		if ( ! defined('DOING_AJAX')
+			 && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
+		) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		$this->_template_args['event_name'] = '';
+		// event name
+		if ($this->_reg_event) {
+			$this->_template_args['event_name'] = $this->_reg_event->name();
+			$edit_event_url                     = self::add_query_args_and_nonce(array(
+				'action' => 'edit',
+				'post'   => $this->_reg_event->ID(),
+			), EVENTS_ADMIN_URL);
+			$edit_event_lnk                     = '<a href="'
+												  . $edit_event_url
+												  . '" title="'
+												  . esc_attr__('Edit ', 'event_espresso')
+												  . $this->_reg_event->name()
+												  . '">'
+												  . esc_html__('Edit Event', 'event_espresso')
+												  . '</a>';
+			$this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
+												   . $edit_event_lnk
+												   . '</span>';
+		}
+		$this->_template_args['step_content'] = $this->_get_registration_step_content();
+		if (defined('DOING_AJAX')) {
+			$this->_return_json();
+		}
+		// grab header
+		$template_path                              =
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
+			$this->_template_args, true);
+		//$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This returns the content for a registration step
+	 *
+	 * @access protected
+	 * @return string html
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_registration_step_content()
+	{
+		if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
+			$warning_msg = sprintf(
+				esc_html__(
+					'%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
+					'event_espresso'
+				),
+				'<br />',
+				'<h3 class="important-notice">',
+				'</h3>',
+				'<div class="float-right">',
+				'<span id="redirect_timer" class="important-notice">30</span>',
+				'</div>',
+				'<b>',
+				'</b>'
+			);
+			return '
 	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
@@ -2955,841 +2955,841 @@ 
 	        }
 	    }, 800 );
 	</script >';
-        }
-        $template_args = array(
-            'title'                    => '',
-            'content'                  => '',
-            'step_button_text'         => '',
-            'show_notification_toggle' => false,
-        );
-        //to indicate we're processing a new registration
-        $hidden_fields = array(
-            'processing_registration' => array(
-                'type'  => 'hidden',
-                'value' => 0,
-            ),
-            'event_id'                => array(
-                'type'  => 'hidden',
-                'value' => $this->_reg_event->ID(),
-            ),
-        );
-        //if the cart is empty then we know we're at step one so we'll display ticket selector
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        switch ($step) {
-            case 'ticket' :
-                $hidden_fields['processing_registration']['value'] = 1;
-                $template_args['title']                            = esc_html__(
-                    'Step One: Select the Ticket for this registration',
-                    'event_espresso'
-                );
-                $template_args['content']                          =
-                    EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
-                $template_args['step_button_text']                 = esc_html__(
-                    'Add Tickets and Continue to Registrant Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle']         = false;
-                break;
-            case 'questions' :
-                $hidden_fields['processing_registration']['value'] = 2;
-                $template_args['title']                            = esc_html__(
-                    'Step Two: Add Registrant Details for this Registration',
-                    'event_espresso'
-                );
-                //in theory we should be able to run EED_SPCO at this point because the cart should have been setup
-                // properly by the first process_reg_step run.
-                $template_args['content']                  =
-                    EED_Single_Page_Checkout::registration_checkout_for_admin();
-                $template_args['step_button_text']         = esc_html__(
-                    'Save Registration and Continue to Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle'] = true;
-                break;
-        }
-        //we come back to the process_registration_step route.
-        $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
-        return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     *        set_reg_event
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_reg_event()
-    {
-        if (is_object($this->_reg_event)) {
-            return true;
-        }
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
-        if ( ! $EVT_ID) {
-            return false;
-        }
-        $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        return true;
-    }
-
-
-    /**
-     * process_reg_step
-     *
-     * @access        public
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function process_reg_step()
-    {
-        EE_System::do_not_cache();
-        $this->_set_reg_event();
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        EE_Registry::instance()->REQ->set('uts', time());
-        //what step are we on?
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        //if doing ajax then we need to verify the nonce
-        if (defined('DOING_AJAX')) {
-            $nonce = isset($this->_req_data[$this->_req_nonce])
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        switch ($step) {
-            case 'ticket' :
-                //process ticket selection
-                $success = EED_Ticket_Selector::instance()->process_ticket_selections();
-                if ($success) {
-                    EE_Error::add_success(
-                        esc_html__(
-                            'Tickets Selected. Now complete the registration.',
-                            'event_espresso'
-                        )
-                    );
-                } else {
-                    $query_args['step_error'] = $this->_req_data['step_error'] = true;
-                }
-                if (defined('DOING_AJAX')) {
-                    $this->new_registration(); //display next step
-                } else {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 1,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    $this->_redirect_after_action(
-                        false,
-                        '',
-                        '',
-                        $query_args,
-                        true
-                    );
-                }
-                break;
-            case 'questions' :
-                if (! isset(
-                    $this->_req_data['txn_reg_status_change'],
-                    $this->_req_data['txn_reg_status_change']['send_notifications'])
-                ) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
-                }
-                //process registration
-                $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
-                if ($cart instanceof EE_Cart) {
-                    $grand_total = $cart->get_cart_grand_total();
-                    if ($grand_total instanceof EE_Line_Item) {
-                        $grand_total->save_this_and_descendants_to_txn();
-                    }
-                }
-                if ( ! $transaction instanceof EE_Transaction) {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 2,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    if (defined('DOING_AJAX')) {
-                        //display registration form again because there are errors (maybe validation?)
-                        $this->new_registration();
-                        return;
-                    } else {
-                        $this->_redirect_after_action(
-                            false,
-                            '',
-                            '',
-                            $query_args,
-                            true
-                        );
-                        return;
-                    }
-                }
-                // maybe update status, and make sure to save transaction if not done already
-                if ( ! $transaction->update_status_based_on_total_paid()) {
-                    $transaction->save();
-                }
-                EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                $this->_req_data = array();
-                $query_args      = array(
-                    'action'        => 'redirect_to_txn',
-                    'TXN_ID'        => $transaction->ID(),
-                    'EVT_ID'        => $this->_reg_event->ID(),
-                    'event_name'    => urlencode($this->_reg_event->name()),
-                    'redirect_from' => 'new_registration',
-                );
-                $this->_redirect_after_action(false, '', '', $query_args, true);
-                break;
-        }
-        //what are you looking here for?  Should be nothing to do at this point.
-    }
-
-
-    /**
-     * redirect_to_txn
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function redirect_to_txn()
-    {
-        EE_System::do_not_cache();
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        $query_args = array(
-            'action' => 'view_transaction',
-            'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
-            'page'   => 'espresso_transactions',
-        );
-        if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
-            $query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
-            $query_args['event_name']    = urlencode($this->_req_data['event_name']);
-            $query_args['redirect_from'] = $this->_req_data['redirect_from'];
-        }
-        EE_Error::add_success(
-            esc_html__(
-                'Registration Created.  Please review the transaction and add any payments as necessary',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Attendee Contact List
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _attendee_contact_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *        get_attendees
-     *
-     * @param      $per_page
-     * @param bool $count whether to return count or data.
-     * @param bool $trash
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @access public
-     */
-    public function get_attendees($per_page, $count = false, $trash = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
-        $ATT_MDL                    = EEM_Attendee::instance();
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-        switch ($this->_req_data['orderby']) {
-            case 'ATT_ID':
-                $orderby = 'ATT_ID';
-                break;
-            case 'ATT_fname':
-                $orderby = 'ATT_fname';
-                break;
-            case 'ATT_email':
-                $orderby = 'ATT_email';
-                break;
-            case 'ATT_city':
-                $orderby = 'ATT_city';
-                break;
-            case 'STA_ID':
-                $orderby = 'STA_ID';
-                break;
-            case 'CNT_ID':
-                $orderby = 'CNT_ID';
-                break;
-            case 'Registration_Count':
-                $orderby = 'Registration_Count';
-                break;
-            default:
-                $orderby = 'ATT_lname';
-        }
-        $sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-            ? $this->_req_data['order']
-            : 'ASC';
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-        $_where       = array();
-        if ( ! empty($this->_req_data['s'])) {
-            $sstr         = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'Registration.Event.EVT_name'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
-                'ATT_fname'                         => array('LIKE', $sstr),
-                'ATT_lname'                         => array('LIKE', $sstr),
-                'ATT_short_bio'                     => array('LIKE', $sstr),
-                'ATT_email'                         => array('LIKE', $sstr),
-                'ATT_address'                       => array('LIKE', $sstr),
-                'ATT_address2'                      => array('LIKE', $sstr),
-                'ATT_city'                          => array('LIKE', $sstr),
-                'Country.CNT_name'                  => array('LIKE', $sstr),
-                'State.STA_name'                    => array('LIKE', $sstr),
-                'ATT_phone'                         => array('LIKE', $sstr),
-                'Registration.REG_final_price'      => array('LIKE', $sstr),
-                'Registration.REG_code'             => array('LIKE', $sstr),
-                'Registration.REG_group_size'       => array('LIKE', $sstr),
-            );
-        }
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $count ? null : array($offset, $per_page);
-        $query_args = array(
-            $_where,
-            'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')),
-            'limit' => $limit
-        );
-        if (! $count) {
-            $query_args['order_by'] = array($orderby => $sort);
-        }
-        if ($trash) {
-            $query_args[0]['status'] = array('!=', 'publish');
-            $all_attendees    = $count
-                ? $ATT_MDL->count($query_args, 'ATT_ID', true)
-                : $ATT_MDL->get_all($query_args);
-        } else {
-            $query_args[0]['status'] = array('IN', array('publish'));
-            $all_attendees    = $count
-                ? $ATT_MDL->count($query_args, 'ATT_ID', true)
-                : $ATT_MDL->get_all($query_args);
-        }
-        return $all_attendees;
-    }
-
-
-    /**
-     * This is just taking care of resending the registration confirmation
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _resend_registration()
-    {
-        $this->_process_resend_registration();
-        $query_args = isset($this->_req_data['redirect_to'])
-            ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
-            : array('action' => 'default');
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-    /**
-     * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
-     * to use when selecting registrations
-     * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
-     *                                                     the query parameters from the request
-     * @return void ends the request with a redirect or download
-     */
-    public function _registrations_report_base( $method_name_for_getting_query_params )
-    {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'        => 'espresso_batch',
-                    'batch'       => 'file',
-                    'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-                    'filters'     => urlencode(
-                        serialize(
-                            call_user_func(
-                                array( $this, $method_name_for_getting_query_params ),
-                                EEH_Array::is_set(
-                                    $this->_req_data,
-                                    'filters',
-                                    array()
-                                )
-                            )
-                        )
-                ),
-                'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
-                'return_url'  => urlencode($this->_req_data['return_url']),
-            )));
-        } else {
-            $new_request_args = array(
-                'export' => 'report',
-                'action' => 'registrations_report_for_event',
-                'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-            );
-            $this->_req_data = array_merge($this->_req_data, $new_request_args);
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($this->_req_data);
-                $EE_Export->export();
-            }
-        }
-    }
-
-
-
-    /**
-     * Creates a registration report using only query parameters in the request
-     * @return void
-     */
-    public function _registrations_report()
-    {
-        $this->_registrations_report_base('_get_registration_query_parameters');
-    }
-
-
-    public function _contact_list_export()
-    {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export_attendees();
-        }
-    }
-
-
-    public function _contact_list_report()
-    {
-        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
-                'page'        => 'espresso_batch',
-                'batch'       => 'file',
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
-                'return_url'  => urlencode($this->_req_data['return_url']),
-            )));
-        } else {
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($this->_req_data);
-                $EE_Export->report_attendees();
-            }
-        }
-    }
-
-
-
-
-
-    /***************************************        ATTENDEE DETAILS        ***************************************/
-    /**
-     * This duplicates the attendee object for the given incoming registration id and attendee_id.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _duplicate_attendee()
-    {
-        $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
-        //verify we have necessary info
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
-                    'event_espresso'
-                ), __FILE__, __LINE__, __FUNCTION__
-            );
-            $query_args = array('action' => $action);
-            $this->_redirect_after_action('', '', '', $query_args, true);
-        }
-        //okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
-        $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
-        $attendee     = $registration->attendee();
-        //remove relation of existing attendee on registration
-        $registration->_remove_relation_to($attendee, 'Attendee');
-        //new attendee
-        $new_attendee = clone $attendee;
-        $new_attendee->set('ATT_ID', 0);
-        $new_attendee->save();
-        //add new attendee to reg
-        $registration->_add_relation_to($new_attendee, 'Attendee');
-        EE_Error::add_success(
-            esc_html__(
-                'New Contact record created.  Now make any edits you wish to make for this contact.',
-                'event_espresso'
-            )
-        );
-        //redirect to edit page for attendee
-        $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
-        $this->_redirect_after_action('', '', '', $query_args, true);
-    }
-
-
-    /**
-     * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook.
-     * @param int      $post_id
-     * @param WP_POST $post
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        $success  = true;
-        $attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees'
-            ? EEM_Attendee::instance()->get_one_by_ID($post_id)
-            : null;
-        //for attendee updates
-        if ($attendee instanceof EE_Attendee) {
-            //note we should only be UPDATING attendees at this point.
-            $updated_fields = array(
-                'ATT_fname'     => $this->_req_data['ATT_fname'],
-                'ATT_lname'     => $this->_req_data['ATT_lname'],
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
-                'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
-                'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
-                'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
-                'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
-                'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
-                'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
-            );
-            foreach ($updated_fields as $field => $value) {
-                $attendee->set($field, $value);
-            }
-
-            //process contact details metabox form handler (which will also save the attendee)
-            $contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee);
-            $success = $contact_details_form->process($this->_req_data);
-
-            $attendee_update_callbacks = apply_filters(
-                'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
-                array()
-            );
-            foreach ($attendee_update_callbacks as $a_callback) {
-                if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
-                                'event_espresso'
-                            ),
-                            $a_callback
-                        )
-                    );
-                }
-            }
-        }
-
-        if ($success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with updating the meta table data for the registration.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-    public function trash_cpt_item($post_id)
-    {
-    }
-
-
-    public function delete_cpt_item($post_id)
-    {
-    }
-
-
-    public function restore_cpt_item($post_id)
-    {
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-    }
-
-
-    public function attendee_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-        remove_meta_box(
-            'postexcerpt',
-            esc_html__('Excerpt', 'event_espresso'),
-            'post_excerpt_meta_box',
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'core'
-        );
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
-        if (post_type_supports('espresso_attendees', 'excerpt')) {
-            add_meta_box(
-                'postexcerpt',
-                esc_html__('Short Biography', 'event_espresso'),
-                'post_excerpt_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'normal'
-            );
-        }
-        if (post_type_supports('espresso_attendees', 'comments')) {
-            add_meta_box(
-                'commentsdiv',
-                esc_html__('Notes on the Contact', 'event_espresso'),
-                'post_comment_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'normal',
-                'core'
-            );
-        }
-        add_meta_box(
-            'attendee_contact_info',
-            esc_html__('Contact Info', 'event_espresso'),
-            array($this, 'attendee_contact_info'),
-            $this->_cpt_routes[$this->_req_action],
-            'side',
-            'core'
-        );
-        add_meta_box(
-            'attendee_details_address',
-            esc_html__('Address Details', 'event_espresso'),
-            array($this, 'attendee_address_details'),
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'core'
-        );
-        add_meta_box(
-            'attendee_registrations',
-            esc_html__('Registrations for this Contact', 'event_espresso'),
-            array($this, 'attendee_registrations_meta_box'),
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'high'
-        );
-    }
-
-
-    /**
-     * Metabox for attendee contact info
-     *
-     * @param  WP_Post $post wp post object
-     * @return string attendee contact info ( and form )
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     * @throws DomainException
-     */
-    public function attendee_contact_info($post)
-    {
-        //get attendee object ( should already have it )
-        $form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj);
-        $form->enqueueStylesAndScripts();
-        echo $form->display();
-    }
-
-
-    /**
-     * Return form handler for the contact details metabox
-     *
-     * @param EE_Attendee $attendee
-     * @return AttendeeContactDetailsMetaboxFormHandler
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee)
-    {
-        return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance());
-    }
-
-
-    /**
-     * Metabox for attendee details
-     *
-     * @param  WP_Post $post wp post object
-     * @throws DomainException
-     */
-    public function attendee_address_details($post)
-    {
-        //get attendee object (should already have it)
-        $this->_template_args['attendee']     = $this->_cpt_model_obj;
-        $this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
-                        'QST_system'       => 'admin-state',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->state_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'STA_ID',
-                    'input_name'     => 'STA_ID',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('Country', 'event_espresso'),
-                        'QST_system'       => 'admin-country',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->country_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'CNT_ISO',
-                    'input_name'     => 'CNT_ISO',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $template                             =
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     *        _attendee_details
-     *
-     * @access protected
-     * @param $post
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function attendee_registrations_meta_box($post)
-    {
-        $this->_template_args['attendee']      = $this->_cpt_model_obj;
-        $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
-        $template                              =
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * add in the form fields for the attendee edit
-     *
-     * @param  WP_Post $post wp post object
-     * @return string html for new form.
-     * @throws DomainException
-     */
-    public function after_title_form_fields($post)
-    {
-        if ($post->post_type == 'espresso_attendees') {
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
-            $template_args['attendee'] = $this->_cpt_model_obj;
-            EEH_Template::display_template($template, $template_args);
-        }
-    }
-
-
-    /**
-     *        _trash_or_restore_attendee
-     *
-     * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @access protected
-     */
-    protected function _trash_or_restore_attendees($trash = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ATT_MDL = EEM_Attendee::instance();
-        $success = 1;
-        //Checkboxes
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
-                $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
-                    : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
-                if ( ! $updated) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $ATT_ID = absint($this->_req_data['ATT_ID']);
-            //get attendee
-            $att     = $ATT_MDL->get_one_by_ID($ATT_ID);
-            $updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
-            $updated = $att->save();
-            if ( ! $updated) {
-                $success = 0;
-            }
-        }
-        $what        = $success > 1
-            ? esc_html__('Contacts', 'event_espresso')
-            : esc_html__('Contact', 'event_espresso');
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
-    }
+		}
+		$template_args = array(
+			'title'                    => '',
+			'content'                  => '',
+			'step_button_text'         => '',
+			'show_notification_toggle' => false,
+		);
+		//to indicate we're processing a new registration
+		$hidden_fields = array(
+			'processing_registration' => array(
+				'type'  => 'hidden',
+				'value' => 0,
+			),
+			'event_id'                => array(
+				'type'  => 'hidden',
+				'value' => $this->_reg_event->ID(),
+			),
+		);
+		//if the cart is empty then we know we're at step one so we'll display ticket selector
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		switch ($step) {
+			case 'ticket' :
+				$hidden_fields['processing_registration']['value'] = 1;
+				$template_args['title']                            = esc_html__(
+					'Step One: Select the Ticket for this registration',
+					'event_espresso'
+				);
+				$template_args['content']                          =
+					EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
+				$template_args['step_button_text']                 = esc_html__(
+					'Add Tickets and Continue to Registrant Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle']         = false;
+				break;
+			case 'questions' :
+				$hidden_fields['processing_registration']['value'] = 2;
+				$template_args['title']                            = esc_html__(
+					'Step Two: Add Registrant Details for this Registration',
+					'event_espresso'
+				);
+				//in theory we should be able to run EED_SPCO at this point because the cart should have been setup
+				// properly by the first process_reg_step run.
+				$template_args['content']                  =
+					EED_Single_Page_Checkout::registration_checkout_for_admin();
+				$template_args['step_button_text']         = esc_html__(
+					'Save Registration and Continue to Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle'] = true;
+				break;
+		}
+		//we come back to the process_registration_step route.
+		$this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
+		return EEH_Template::display_template(
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 *        set_reg_event
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_reg_event()
+	{
+		if (is_object($this->_reg_event)) {
+			return true;
+		}
+		$EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
+		if ( ! $EVT_ID) {
+			return false;
+		}
+		$this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		return true;
+	}
+
+
+	/**
+	 * process_reg_step
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function process_reg_step()
+	{
+		EE_System::do_not_cache();
+		$this->_set_reg_event();
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		EE_Registry::instance()->REQ->set('uts', time());
+		//what step are we on?
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		//if doing ajax then we need to verify the nonce
+		if (defined('DOING_AJAX')) {
+			$nonce = isset($this->_req_data[$this->_req_nonce])
+				? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		switch ($step) {
+			case 'ticket' :
+				//process ticket selection
+				$success = EED_Ticket_Selector::instance()->process_ticket_selections();
+				if ($success) {
+					EE_Error::add_success(
+						esc_html__(
+							'Tickets Selected. Now complete the registration.',
+							'event_espresso'
+						)
+					);
+				} else {
+					$query_args['step_error'] = $this->_req_data['step_error'] = true;
+				}
+				if (defined('DOING_AJAX')) {
+					$this->new_registration(); //display next step
+				} else {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 1,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					$this->_redirect_after_action(
+						false,
+						'',
+						'',
+						$query_args,
+						true
+					);
+				}
+				break;
+			case 'questions' :
+				if (! isset(
+					$this->_req_data['txn_reg_status_change'],
+					$this->_req_data['txn_reg_status_change']['send_notifications'])
+				) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
+				}
+				//process registration
+				$transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
+				if ($cart instanceof EE_Cart) {
+					$grand_total = $cart->get_cart_grand_total();
+					if ($grand_total instanceof EE_Line_Item) {
+						$grand_total->save_this_and_descendants_to_txn();
+					}
+				}
+				if ( ! $transaction instanceof EE_Transaction) {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 2,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					if (defined('DOING_AJAX')) {
+						//display registration form again because there are errors (maybe validation?)
+						$this->new_registration();
+						return;
+					} else {
+						$this->_redirect_after_action(
+							false,
+							'',
+							'',
+							$query_args,
+							true
+						);
+						return;
+					}
+				}
+				// maybe update status, and make sure to save transaction if not done already
+				if ( ! $transaction->update_status_based_on_total_paid()) {
+					$transaction->save();
+				}
+				EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+				$this->_req_data = array();
+				$query_args      = array(
+					'action'        => 'redirect_to_txn',
+					'TXN_ID'        => $transaction->ID(),
+					'EVT_ID'        => $this->_reg_event->ID(),
+					'event_name'    => urlencode($this->_reg_event->name()),
+					'redirect_from' => 'new_registration',
+				);
+				$this->_redirect_after_action(false, '', '', $query_args, true);
+				break;
+		}
+		//what are you looking here for?  Should be nothing to do at this point.
+	}
+
+
+	/**
+	 * redirect_to_txn
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function redirect_to_txn()
+	{
+		EE_System::do_not_cache();
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		$query_args = array(
+			'action' => 'view_transaction',
+			'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
+			'page'   => 'espresso_transactions',
+		);
+		if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
+			$query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
+			$query_args['event_name']    = urlencode($this->_req_data['event_name']);
+			$query_args['redirect_from'] = $this->_req_data['redirect_from'];
+		}
+		EE_Error::add_success(
+			esc_html__(
+				'Registration Created.  Please review the transaction and add any payments as necessary',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Attendee Contact List
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _attendee_contact_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *        get_attendees
+	 *
+	 * @param      $per_page
+	 * @param bool $count whether to return count or data.
+	 * @param bool $trash
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @access public
+	 */
+	public function get_attendees($per_page, $count = false, $trash = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+		$ATT_MDL                    = EEM_Attendee::instance();
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+		switch ($this->_req_data['orderby']) {
+			case 'ATT_ID':
+				$orderby = 'ATT_ID';
+				break;
+			case 'ATT_fname':
+				$orderby = 'ATT_fname';
+				break;
+			case 'ATT_email':
+				$orderby = 'ATT_email';
+				break;
+			case 'ATT_city':
+				$orderby = 'ATT_city';
+				break;
+			case 'STA_ID':
+				$orderby = 'STA_ID';
+				break;
+			case 'CNT_ID':
+				$orderby = 'CNT_ID';
+				break;
+			case 'Registration_Count':
+				$orderby = 'Registration_Count';
+				break;
+			default:
+				$orderby = 'ATT_lname';
+		}
+		$sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+			? $this->_req_data['order']
+			: 'ASC';
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+		$_where       = array();
+		if ( ! empty($this->_req_data['s'])) {
+			$sstr         = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'Registration.Event.EVT_name'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
+				'ATT_fname'                         => array('LIKE', $sstr),
+				'ATT_lname'                         => array('LIKE', $sstr),
+				'ATT_short_bio'                     => array('LIKE', $sstr),
+				'ATT_email'                         => array('LIKE', $sstr),
+				'ATT_address'                       => array('LIKE', $sstr),
+				'ATT_address2'                      => array('LIKE', $sstr),
+				'ATT_city'                          => array('LIKE', $sstr),
+				'Country.CNT_name'                  => array('LIKE', $sstr),
+				'State.STA_name'                    => array('LIKE', $sstr),
+				'ATT_phone'                         => array('LIKE', $sstr),
+				'Registration.REG_final_price'      => array('LIKE', $sstr),
+				'Registration.REG_code'             => array('LIKE', $sstr),
+				'Registration.REG_group_size'       => array('LIKE', $sstr),
+			);
+		}
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $count ? null : array($offset, $per_page);
+		$query_args = array(
+			$_where,
+			'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')),
+			'limit' => $limit
+		);
+		if (! $count) {
+			$query_args['order_by'] = array($orderby => $sort);
+		}
+		if ($trash) {
+			$query_args[0]['status'] = array('!=', 'publish');
+			$all_attendees    = $count
+				? $ATT_MDL->count($query_args, 'ATT_ID', true)
+				: $ATT_MDL->get_all($query_args);
+		} else {
+			$query_args[0]['status'] = array('IN', array('publish'));
+			$all_attendees    = $count
+				? $ATT_MDL->count($query_args, 'ATT_ID', true)
+				: $ATT_MDL->get_all($query_args);
+		}
+		return $all_attendees;
+	}
+
+
+	/**
+	 * This is just taking care of resending the registration confirmation
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _resend_registration()
+	{
+		$this->_process_resend_registration();
+		$query_args = isset($this->_req_data['redirect_to'])
+			? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
+			: array('action' => 'default');
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+	/**
+	 * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
+	 * to use when selecting registrations
+	 * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
+	 *                                                     the query parameters from the request
+	 * @return void ends the request with a redirect or download
+	 */
+	public function _registrations_report_base( $method_name_for_getting_query_params )
+	{
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'        => 'espresso_batch',
+					'batch'       => 'file',
+					'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+					'filters'     => urlencode(
+						serialize(
+							call_user_func(
+								array( $this, $method_name_for_getting_query_params ),
+								EEH_Array::is_set(
+									$this->_req_data,
+									'filters',
+									array()
+								)
+							)
+						)
+				),
+				'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
+				'return_url'  => urlencode($this->_req_data['return_url']),
+			)));
+		} else {
+			$new_request_args = array(
+				'export' => 'report',
+				'action' => 'registrations_report_for_event',
+				'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+			);
+			$this->_req_data = array_merge($this->_req_data, $new_request_args);
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($this->_req_data);
+				$EE_Export->export();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Creates a registration report using only query parameters in the request
+	 * @return void
+	 */
+	public function _registrations_report()
+	{
+		$this->_registrations_report_base('_get_registration_query_parameters');
+	}
+
+
+	public function _contact_list_export()
+	{
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export_attendees();
+		}
+	}
+
+
+	public function _contact_list_report()
+	{
+		if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
+				'page'        => 'espresso_batch',
+				'batch'       => 'file',
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
+				'return_url'  => urlencode($this->_req_data['return_url']),
+			)));
+		} else {
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($this->_req_data);
+				$EE_Export->report_attendees();
+			}
+		}
+	}
+
+
+
+
+
+	/***************************************        ATTENDEE DETAILS        ***************************************/
+	/**
+	 * This duplicates the attendee object for the given incoming registration id and attendee_id.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _duplicate_attendee()
+	{
+		$action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
+		//verify we have necessary info
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
+					'event_espresso'
+				), __FILE__, __LINE__, __FUNCTION__
+			);
+			$query_args = array('action' => $action);
+			$this->_redirect_after_action('', '', '', $query_args, true);
+		}
+		//okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
+		$registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
+		$attendee     = $registration->attendee();
+		//remove relation of existing attendee on registration
+		$registration->_remove_relation_to($attendee, 'Attendee');
+		//new attendee
+		$new_attendee = clone $attendee;
+		$new_attendee->set('ATT_ID', 0);
+		$new_attendee->save();
+		//add new attendee to reg
+		$registration->_add_relation_to($new_attendee, 'Attendee');
+		EE_Error::add_success(
+			esc_html__(
+				'New Contact record created.  Now make any edits you wish to make for this contact.',
+				'event_espresso'
+			)
+		);
+		//redirect to edit page for attendee
+		$query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
+		$this->_redirect_after_action('', '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Callback invoked by parent EE_Admin_CPT class hooked in on `save_post` wp hook.
+	 * @param int      $post_id
+	 * @param WP_POST $post
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		$success  = true;
+		$attendee = $post instanceof WP_Post && $post->post_type === 'espresso_attendees'
+			? EEM_Attendee::instance()->get_one_by_ID($post_id)
+			: null;
+		//for attendee updates
+		if ($attendee instanceof EE_Attendee) {
+			//note we should only be UPDATING attendees at this point.
+			$updated_fields = array(
+				'ATT_fname'     => $this->_req_data['ATT_fname'],
+				'ATT_lname'     => $this->_req_data['ATT_lname'],
+				'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
+				'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
+				'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
+				'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
+				'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
+				'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
+				'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
+			);
+			foreach ($updated_fields as $field => $value) {
+				$attendee->set($field, $value);
+			}
+
+			//process contact details metabox form handler (which will also save the attendee)
+			$contact_details_form = $this->getAttendeeContactDetailsMetaboxFormHandler($attendee);
+			$success = $contact_details_form->process($this->_req_data);
+
+			$attendee_update_callbacks = apply_filters(
+				'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
+				array()
+			);
+			foreach ($attendee_update_callbacks as $a_callback) {
+				if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
+								'event_espresso'
+							),
+							$a_callback
+						)
+					);
+				}
+			}
+		}
+
+		if ($success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with updating the meta table data for the registration.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+	public function trash_cpt_item($post_id)
+	{
+	}
+
+
+	public function delete_cpt_item($post_id)
+	{
+	}
+
+
+	public function restore_cpt_item($post_id)
+	{
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+	}
+
+
+	public function attendee_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+		remove_meta_box(
+			'postexcerpt',
+			esc_html__('Excerpt', 'event_espresso'),
+			'post_excerpt_meta_box',
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'core'
+		);
+		remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
+		if (post_type_supports('espresso_attendees', 'excerpt')) {
+			add_meta_box(
+				'postexcerpt',
+				esc_html__('Short Biography', 'event_espresso'),
+				'post_excerpt_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'normal'
+			);
+		}
+		if (post_type_supports('espresso_attendees', 'comments')) {
+			add_meta_box(
+				'commentsdiv',
+				esc_html__('Notes on the Contact', 'event_espresso'),
+				'post_comment_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'normal',
+				'core'
+			);
+		}
+		add_meta_box(
+			'attendee_contact_info',
+			esc_html__('Contact Info', 'event_espresso'),
+			array($this, 'attendee_contact_info'),
+			$this->_cpt_routes[$this->_req_action],
+			'side',
+			'core'
+		);
+		add_meta_box(
+			'attendee_details_address',
+			esc_html__('Address Details', 'event_espresso'),
+			array($this, 'attendee_address_details'),
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'core'
+		);
+		add_meta_box(
+			'attendee_registrations',
+			esc_html__('Registrations for this Contact', 'event_espresso'),
+			array($this, 'attendee_registrations_meta_box'),
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'high'
+		);
+	}
+
+
+	/**
+	 * Metabox for attendee contact info
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string attendee contact info ( and form )
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 * @throws DomainException
+	 */
+	public function attendee_contact_info($post)
+	{
+		//get attendee object ( should already have it )
+		$form = $this->getAttendeeContactDetailsMetaboxFormHandler($this->_cpt_model_obj);
+		$form->enqueueStylesAndScripts();
+		echo $form->display();
+	}
+
+
+	/**
+	 * Return form handler for the contact details metabox
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return AttendeeContactDetailsMetaboxFormHandler
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getAttendeeContactDetailsMetaboxFormHandler(EE_Attendee $attendee)
+	{
+		return new AttendeeContactDetailsMetaboxFormHandler($attendee, EE_Registry::instance());
+	}
+
+
+	/**
+	 * Metabox for attendee details
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @throws DomainException
+	 */
+	public function attendee_address_details($post)
+	{
+		//get attendee object (should already have it)
+		$this->_template_args['attendee']     = $this->_cpt_model_obj;
+		$this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
+						'QST_system'       => 'admin-state',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->state_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'STA_ID',
+					'input_name'     => 'STA_ID',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('Country', 'event_espresso'),
+						'QST_system'       => 'admin-country',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->country_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'CNT_ISO',
+					'input_name'     => 'CNT_ISO',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$template                             =
+			REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 *        _attendee_details
+	 *
+	 * @access protected
+	 * @param $post
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function attendee_registrations_meta_box($post)
+	{
+		$this->_template_args['attendee']      = $this->_cpt_model_obj;
+		$this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
+		$template                              =
+			REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * add in the form fields for the attendee edit
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string html for new form.
+	 * @throws DomainException
+	 */
+	public function after_title_form_fields($post)
+	{
+		if ($post->post_type == 'espresso_attendees') {
+			$template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+			$template_args['attendee'] = $this->_cpt_model_obj;
+			EEH_Template::display_template($template, $template_args);
+		}
+	}
+
+
+	/**
+	 *        _trash_or_restore_attendee
+	 *
+	 * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @access protected
+	 */
+	protected function _trash_or_restore_attendees($trash = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ATT_MDL = EEM_Attendee::instance();
+		$success = 1;
+		//Checkboxes
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
+				$updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
+					: $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
+				if ( ! $updated) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$ATT_ID = absint($this->_req_data['ATT_ID']);
+			//get attendee
+			$att     = $ATT_MDL->get_one_by_ID($ATT_ID);
+			$updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
+			$updated = $att->save();
+			if ( ! $updated) {
+				$success = 0;
+			}
+		}
+		$what        = $success > 1
+			? esc_html__('Contacts', 'event_espresso')
+			: esc_html__('Contact', 'event_espresso');
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
+	}
 
 }

Spacing +93 added lines, -93 removed lines

@@ -76,7 +76,7 @@ 
         // when adding a new registration...
         if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
             EE_System::do_not_cache();
-            if (! isset($this->_req_data['processing_registration'])
+            if ( ! isset($this->_req_data['processing_registration'])
                  || absint($this->_req_data['processing_registration']) !== 1
             ) {
                 // and it's NOT the attendee information reg step
@@ -171,7 +171,7 @@ 
     public function _set_page_routes()
     {
         $this->_get_registration_status_array();
-        $reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
             ? $this->_req_data['_REG_ID'] : 0;
         $reg_id = empty($reg_id) && ! empty($this->_req_data['reg_status_change_form']['REG_ID'])
             ? $this->_req_data['reg_status_change_form']['REG_ID']
@@ -669,7 +669,7 @@ 
         //style
         wp_register_style(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
+            REG_ASSETS_URL.'espresso_registrations_admin.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -677,7 +677,7 @@ 
         //script
         wp_register_script(
             'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
+            REG_ASSETS_URL.'espresso_registrations_admin.js',
             array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -715,7 +715,7 @@ 
         wp_dequeue_style('espresso_reg');
         wp_register_style(
             'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
+            REG_ASSETS_URL.'espresso_attendees_admin.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -727,7 +727,7 @@ 
     {
         wp_register_script(
             'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
+            REG_ASSETS_URL.'spco_for_admin.js',
             array('underscore', 'jquery'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -861,7 +861,7 @@ 
                     'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
                 ),
             );
-            $this->_views['trash']      = array(
+            $this->_views['trash'] = array(
                 'slug'        => 'trash',
                 'label'       => esc_html__('Trash', 'event_espresso'),
                 'count'       => 0,
@@ -950,7 +950,7 @@ 
         }
         $sc_items = array(
             'approved_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_approved,
                     false,
@@ -958,7 +958,7 @@ 
                 ),
             ),
             'pending_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_pending_payment,
                     false,
@@ -966,7 +966,7 @@ 
                 ),
             ),
             'wait_list'         => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_wait_list,
                     false,
@@ -974,7 +974,7 @@ 
                 ),
             ),
             'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_incomplete,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_incomplete,
                     false,
@@ -982,7 +982,7 @@ 
                 ),
             ),
             'not_approved'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_not_approved,
                     false,
@@ -990,7 +990,7 @@ 
                 ),
             ),
             'declined_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_declined,
                     false,
@@ -998,7 +998,7 @@ 
                 ),
             ),
             'cancelled_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(
                     EEM_Registration::status_id_cancelled,
                     false,
@@ -1021,7 +1021,7 @@ 
         $EVT_ID                                    = ! empty($this->_req_data['event_id'])
             ? absint($this->_req_data['event_id'])
             : 0;
-        $ATT_ID = !empty($this->_req_data['ATT_ID'])
+        $ATT_ID = ! empty($this->_req_data['ATT_ID'])
             ? absint($this->_req_data['ATT_ID'])
             : 0;
         if ($ATT_ID) {
@@ -1033,13 +1033,13 @@ 
                         'event_espresso'
                     ),
                     '<h3 style="line-height:1.5em;">',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+                    '<a href="'.EE_Admin_Page::add_query_args_and_nonce(
                         array(
                             'action' => 'edit_attendee',
                             'post' => $ATT_ID
                         ),
                         REG_ADMIN_URL
-                    ) . '">' . $attendee->full_name() . '</a>',
+                    ).'">'.$attendee->full_name().'</a>',
                     '</h3>'
                 );
             }
@@ -1050,7 +1050,7 @@ 
                 'espresso_registrations_new_registration',
                 $EVT_ID
             )) {
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+                $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                     'new_registration',
                     'add-registrant',
                     array('event_id' => $EVT_ID),
@@ -1090,7 +1090,7 @@ 
                 $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
                 $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
                 $this->_template_args['admin_page_header'] .= $datetime->name();
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
+                $this->_template_args['admin_page_header'] .= ' ( '.$datetime->start_date().' )';
                 $this->_template_args['admin_page_header'] .= '</span></h3>';
             }
         }
@@ -1197,7 +1197,7 @@ 
             'caps'                     => EEM_Registration::caps_read_admin,
             'default_where_conditions' => 'this_model_only',
         );
-        if (! $count) {
+        if ( ! $count) {
             $query_params = array_merge(
                 $query_params,
                 $this->_get_orderby_for_registrations_query(),
@@ -1218,7 +1218,7 @@ 
     protected function addAttendeeIdToWhereConditions(array $request)
     {
         $where = array();
-        if (! empty($request['ATT_ID'])) {
+        if ( ! empty($request['ATT_ID'])) {
             $where['ATT_ID'] = absint($request['ATT_ID']);
         }
         return $where;
@@ -1234,7 +1234,7 @@ 
     protected function _add_event_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['event_id'])) {
+        if ( ! empty($request['event_id'])) {
             $where['EVT_ID'] = absint($request['event_id']);
         }
         return $where;
@@ -1250,7 +1250,7 @@ 
     protected function _add_category_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
+        if ( ! empty($request['EVT_CAT']) && (int) $request['EVT_CAT'] !== -1) {
             $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
         }
         return $where;
@@ -1266,10 +1266,10 @@ 
     protected function _add_datetime_id_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['datetime_id'])) {
+        if ( ! empty($request['datetime_id'])) {
             $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
         }
-        if (! empty($request['DTT_ID'])) {
+        if ( ! empty($request['DTT_ID'])) {
             $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
         }
         return $where;
@@ -1295,7 +1295,7 @@ 
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
          * UNLESS viewing trashed registrations.
          */
-        if (! empty($registration_status)) {
+        if ( ! empty($registration_status)) {
             $where['STS_ID'] = $registration_status;
         } else {
             //make sure we exclude incomplete registrations, but only if not trashed.
@@ -1338,12 +1338,12 @@ 
                 array(
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 00:00:00',
+                        $now.' 00:00:00',
                         'Y-m-d H:i:s'
                     ),
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $now . ' 23:59:59',
+                        $now.' 23:59:59',
                         'Y-m-d H:i:s'
                     ),
                 ),
@@ -1356,12 +1356,12 @@ 
                 array(
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
+                        $current_year_and_month.'-01 00:00:00',
                         'Y-m-d H:i:s'
                     ),
                     EEM_Registration::instance()->convert_datetime_for_query(
                         'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+                        $current_year_and_month.'-'.$days_this_month.' 23:59:59',
                         'Y-m-d H:i:s'
                     ),
                 ),
@@ -1376,18 +1376,18 @@ 
                 : '';
             //if there is not a month or year then we can't go further
             if ($month_requested && $year_requested) {
-                $days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+                $days_in_month     = date('t', strtotime($year_requested.'-'.$month_requested.'-'.'01'));
                 $where['REG_date'] = array(
                     'BETWEEN',
                     array(
                         EEM_Registration::instance()->convert_datetime_for_query(
                             'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
+                            $year_requested.'-'.$month_requested.'-01 00:00:00',
                             'Y-m-d H:i:s'
                         ),
                         EEM_Registration::instance()->convert_datetime_for_query(
                             'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+                            $year_requested.'-'.$month_requested.'-'.$days_in_month.' 23:59:59',
                             'Y-m-d H:i:s'
                         ),
                     ),
@@ -1407,8 +1407,8 @@ 
     protected function _add_search_to_where_conditions(array $request)
     {
         $where = array();
-        if (! empty($request['s'])) {
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
+        if ( ! empty($request['s'])) {
+            $search_string = '%'.sanitize_text_field($request['s']).'%';
             $where['OR*search_conditions'] = array(
                 'Event.EVT_name'                          => array('LIKE', $search_string),
                 'Event.EVT_desc'                          => array('LIKE', $search_string),
@@ -1525,7 +1525,7 @@ 
             : $per_page;
 
         //-1 means return all results so get out if that's set.
-        if ((int)$per_page === -1) {
+        if ((int) $per_page === -1) {
             return array();
         }
         $per_page = absint($per_page);
@@ -1581,7 +1581,7 @@ 
                 ),
                 REG_ADMIN_URL
             );
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
+            $this->_template_args['filtered_transactions_link'] = EE_Admin_Page::add_query_args_and_nonce(
                 array(
                     'action' => 'default',
                     'EVT_ID' => $event_id,
@@ -1589,7 +1589,7 @@ 
                 ),
                 admin_url('admin.php')
             );
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
+            $this->_template_args['event_link'] = EE_Admin_Page::add_query_args_and_nonce(
                 array(
                     'page'   => 'espresso_events',
                     'action' => 'edit',
@@ -1598,12 +1598,12 @@ 
                 admin_url('admin.php')
             );
             //next and previous links
-            $next_reg                                      = $this->_registration->next(
+            $next_reg = $this->_registration->next(
                 null,
                 array(),
                 'REG_ID'
             );
-            $this->_template_args['next_registration']     = $next_reg
+            $this->_template_args['next_registration'] = $next_reg
                 ? $this->_next_link(
                     EE_Admin_Page::add_query_args_and_nonce(
                         array(
@@ -1615,7 +1615,7 @@ 
                     'dashicons dashicons-arrow-right ee-icon-size-22'
                 )
                 : '';
-            $previous_reg                                  = $this->_registration->previous(
+            $previous_reg = $this->_registration->previous(
                 null,
                 array(),
                 'REG_ID'
@@ -1633,7 +1633,7 @@ 
                 )
                 : '';
             // grab header
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+            $template_path                             = REG_TEMPLATE_PATH.'reg_admin_details_header.template.php';
             $this->_template_args['REG_ID']            = $this->_registration->ID();
             $this->_template_args['admin_page_header'] = EEH_Template::display_template(
                 $template_path,
@@ -1753,7 +1753,7 @@ 
                             EEH_HTML::strong(
                                 $this->_registration->pretty_status(),
                                 '',
-                                'status-' . $this->_registration->status_ID(),
+                                'status-'.$this->_registration->status_ID(),
                                 'line-height: 1em; font-size: 1.5em; font-weight: bold;'
                             )
                         )
@@ -1833,11 +1833,11 @@ 
     {
         if (isset($this->_req_data['reg_status_change_form'])) {
             $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID']
+                ? (array) $this->_req_data['reg_status_change_form']['REG_ID']
                 : array();
         } else {
             $REG_IDs = isset($this->_req_data['_REG_ID'])
-                ? (array)$this->_req_data['_REG_ID']
+                ? (array) $this->_req_data['_REG_ID']
                 : array();
         }
         // sanitize $REG_IDs
@@ -1900,7 +1900,7 @@ 
     {
         $success = false;
         // typecast $REG_IDs
-        $REG_IDs = (array)$REG_IDs;
+        $REG_IDs = (array) $REG_IDs;
         if ( ! empty($REG_IDs)) {
             $success = true;
             // set default status if none is passed
@@ -2050,7 +2050,7 @@ 
             $action,
             $notify
         );
-        $method = $action . '_registration';
+        $method = $action.'_registration';
         if (method_exists($this, $method)) {
             $this->$method($notify);
         }
@@ -2168,7 +2168,7 @@ 
             $filtered_line_item_tree,
             array('EE_Registration' => $this->_registration)
         );
-        $attendee                                = $this->_registration->attendee();
+        $attendee = $this->_registration->attendee();
         if (EE_Registry::instance()->CAP->current_user_can(
             'ee_read_transaction',
             'espresso_transactions_view_transaction'
@@ -2247,7 +2247,7 @@ 
                 'Payment method response',
                 'event_espresso'
             );
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
+            $this->_template_args['reg_details']['response_msg']['class'] = 'regular-text';
         }
         $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
         $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
@@ -2275,7 +2275,7 @@ 
         $this->_template_args['REG_ID']                                       = $this->_registration->ID();
         $this->_template_args['event_id']                                     = $this->_registration->event_ID();
         $template_path                                                        =
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+            REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_details.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2304,7 +2304,7 @@ 
             $this->_template_args['reg_questions_form_action'] = 'edit_registration';
             $this->_template_args['REG_ID']                    = $this->_registration->ID();
             $template_path                                     =
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+                REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
             echo EEH_Template::display_template($template_path, $this->_template_args, true);
         }
     }
@@ -2321,7 +2321,7 @@ 
     public function form_before_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2346,7 +2346,7 @@ 
     public function form_after_question_group($output)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2384,7 +2384,7 @@ 
     public function form_form_field_label_wrap($label)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2394,7 +2394,7 @@ 
         return '
 			<tr>
 				<th>
-					' . $label . '
+					' . $label.'
 				</th>';
     }
 
@@ -2410,7 +2410,7 @@ 
     public function form_form_field_input__wrap($input)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             esc_html__(
                 'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
                 'event_espresso'
@@ -2419,7 +2419,7 @@ 
         );
         return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
-					' . $input . '
+					' . $input.'
 				</td>
 			</tr>';
     }
@@ -2464,7 +2464,7 @@ 
     protected function _get_reg_custom_questions_form($REG_ID)
     {
         if ( ! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
+            require_once(REG_ADMIN.'form_sections'.DS.'EE_Registration_Custom_Questions_Form.form.php');
             $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
                 EEM_Registration::instance()->get_one_by_ID($REG_ID)
             );
@@ -2500,7 +2500,7 @@ 
         if ($form->is_valid()) {
             foreach ($form->subforms() as $question_group_id => $question_group_form) {
                 foreach ($question_group_form->inputs() as $question_id => $input) {
-                    $where_conditions    = array(
+                    $where_conditions = array(
                         'QST_ID' => $question_id,
                         'REG_ID' => $REG_ID,
                     );
@@ -2541,7 +2541,7 @@ 
         $REG = EEM_Registration::instance();
         //get all other registrations on this transaction, and cache
         //the attendees for them so we don't have to run another query using force_join
-        $registrations                           = $REG->get_all(array(
+        $registrations = $REG->get_all(array(
             array(
                 'TXN_ID' => $this->_registration->transaction_ID(),
                 'REG_ID' => array('!=', $this->_registration->ID()),
@@ -2565,7 +2565,7 @@ 
             $att_nmbr = 1;
             foreach ($registrations as $registration) {
                 /* @var $registration EE_Registration */
-                $attendee                                                    = $registration->attendee()
+                $attendee = $registration->attendee()
                     ? $registration->attendee()
                     : EEM_Attendee::instance()
                                   ->create_default_object();
@@ -2578,19 +2578,19 @@ 
                     ', ',
                     $attendee->full_address_as_array()
                 );
-                $this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
+                $this->_template_args['attendees'][$att_nmbr]['att_link'] = self::add_query_args_and_nonce(
                     array(
                         'action' => 'edit_attendee',
                         'post'   => $attendee->ID(),
                     ),
                     REG_ADMIN_URL
                 );
-                $this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
+                $this->_template_args['attendees'][$att_nmbr]['event_name'] = $registration->event_obj()->name();
                 $att_nmbr++;
             }
             $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
         }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+        $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_attendees.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2633,20 +2633,20 @@ 
         $this->_template_args['phone']             = $attendee->phone();
         $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
         //edit link
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
+        $this->_template_args['att_edit_link'] = EE_Admin_Page::add_query_args_and_nonce(array(
             'action' => 'edit_attendee',
             'post'   => $attendee->ID(),
         ), REG_ADMIN_URL);
         $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
         //create link
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
+        $this->_template_args['create_link'] = $primary_registration instanceof EE_Registration
             ? EE_Admin_Page::add_query_args_and_nonce(array(
                 'action'  => 'duplicate_attendee',
                 '_REG_ID' => $this->_registration->ID(),
             ), REG_ADMIN_URL) : '';
         $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
         $this->_template_args['att_check']    = $att_check;
-        $template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+        $template_path                        = REG_TEMPLATE_PATH.'reg_admin_details_side_meta_box_registrant.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -2691,7 +2691,7 @@ 
             /** @var EE_Registration $REG */
             $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
             $payments = $REG->registration_payments();
-            if (! empty($payments)) {
+            if ( ! empty($payments)) {
                 $name = $REG->attendee() instanceof EE_Attendee
                     ? $REG->attendee()->full_name()
                     : esc_html__('Unknown Attendee', 'event_espresso');
@@ -2887,7 +2887,7 @@ 
                 'action' => 'edit',
                 'post'   => $this->_reg_event->ID(),
             ), EVENTS_ADMIN_URL);
-            $edit_event_lnk                     = '<a href="'
+            $edit_event_lnk = '<a href="'
                                                   . $edit_event_url
                                                   . '" title="'
                                                   . esc_attr__('Edit ', 'event_espresso')
@@ -2905,7 +2905,7 @@ 
         }
         // grab header
         $template_path                              =
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
             $this->_template_args, true);
         //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
@@ -2943,7 +2943,7 @@ 
                 '</b>'
             );
             return '
-	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
+	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg.'</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
 		// after just adding a new registration... we gotta try to put a stop to that !!!
@@ -3011,7 +3011,7 @@ 
         //we come back to the process_registration_step route.
         $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
         return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+            REG_TEMPLATE_PATH.'reg_admin_register_new_attendee_step_content.template.php',
             $template_args,
             true
         );
@@ -3033,7 +3033,7 @@ 
         if (is_object($this->_reg_event)) {
             return true;
         }
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
+        $EVT_ID = ( ! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
         if ( ! $EVT_ID) {
             return false;
         }
@@ -3103,7 +3103,7 @@ 
                 }
                 break;
             case 'questions' :
-                if (! isset(
+                if ( ! isset(
                     $this->_req_data['txn_reg_status_change'],
                     $this->_req_data['txn_reg_status_change']['send_notifications'])
                 ) {
@@ -3223,7 +3223,7 @@ 
     public function get_attendees($per_page, $count = false, $trash = false)
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+        require_once(REG_ADMIN.'EE_Attendee_Contact_List_Table.class.php');
         $ATT_MDL                    = EEM_Attendee::instance();
         $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
         switch ($this->_req_data['orderby']) {
@@ -3263,7 +3263,7 @@ 
             : $per_page;
         $_where       = array();
         if ( ! empty($this->_req_data['s'])) {
-            $sstr         = '%' . $this->_req_data['s'] . '%';
+            $sstr         = '%'.$this->_req_data['s'].'%';
             $_where['OR'] = array(
                 'Registration.Event.EVT_name'       => array('LIKE', $sstr),
                 'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
@@ -3290,17 +3290,17 @@ 
             'extra_selects' => array('Registration_Count' => array('Registration.REG_ID', 'count', '%d')),
             'limit' => $limit
         );
-        if (! $count) {
+        if ( ! $count) {
             $query_args['order_by'] = array($orderby => $sort);
         }
         if ($trash) {
             $query_args[0]['status'] = array('!=', 'publish');
-            $all_attendees    = $count
+            $all_attendees = $count
                 ? $ATT_MDL->count($query_args, 'ATT_ID', true)
                 : $ATT_MDL->get_all($query_args);
         } else {
             $query_args[0]['status'] = array('IN', array('publish'));
-            $all_attendees    = $count
+            $all_attendees = $count
                 ? $ATT_MDL->count($query_args, 'ATT_ID', true)
                 : $ATT_MDL->get_all($query_args);
         }
@@ -3330,9 +3330,9 @@ 
      *                                                     the query parameters from the request
      * @return void ends the request with a redirect or download
      */
-    public function _registrations_report_base( $method_name_for_getting_query_params )
+    public function _registrations_report_base($method_name_for_getting_query_params)
     {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
             wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
                 array(
                     'page'        => 'espresso_batch',
@@ -3341,7 +3341,7 @@ 
                     'filters'     => urlencode(
                         serialize(
                             call_user_func(
-                                array( $this, $method_name_for_getting_query_params ),
+                                array($this, $method_name_for_getting_query_params),
                                 EEH_Array::is_set(
                                     $this->_req_data,
                                     'filters',
@@ -3361,8 +3361,8 @@ 
                 'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
             );
             $this->_req_data = array_merge($this->_req_data, $new_request_args);
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+                require_once(EE_CLASSES.'EE_Export.class.php');
                 $EE_Export = EE_Export::instance($this->_req_data);
                 $EE_Export->export();
             }
@@ -3383,8 +3383,8 @@ 
 
     public function _contact_list_export()
     {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->_req_data);
             $EE_Export->export_attendees();
         }
@@ -3401,8 +3401,8 @@ 
                 'return_url'  => urlencode($this->_req_data['return_url']),
             )));
         } else {
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
+            if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+                require_once(EE_CLASSES.'EE_Export.class.php');
                 $EE_Export = EE_Export::instance($this->_req_data);
                 $EE_Export->report_attendees();
             }
@@ -3484,7 +3484,7 @@ 
             $updated_fields = array(
                 'ATT_fname'     => $this->_req_data['ATT_fname'],
                 'ATT_lname'     => $this->_req_data['ATT_lname'],
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
+                'ATT_full_name' => $this->_req_data['ATT_fname'].' '.$this->_req_data['ATT_lname'],
                 'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
                 'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
                 'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
@@ -3702,8 +3702,8 @@ 
                 )
             )
         );
-        $template                             =
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+        $template =
+            REG_TEMPLATE_PATH.'attendee_address_details_metabox_content.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3722,7 +3722,7 @@ 
         $this->_template_args['attendee']      = $this->_cpt_model_obj;
         $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
         $template                              =
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+            REG_TEMPLATE_PATH.'attendee_registrations_main_meta_box.template.php';
         EEH_Template::display_template($template, $this->_template_args);
     }
 
@@ -3737,7 +3737,7 @@ 
     public function after_title_form_fields($post)
     {
         if ($post->post_type == 'espresso_attendees') {
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+            $template                  = REG_TEMPLATE_PATH.'attendee_details_after_title_form_fields.template.php';
             $template_args['attendee'] = $this->_cpt_model_obj;
             EEH_Template::display_template($template, $template_args);
         }

admin_pages/transactions/templates/txn_admin_details_header.template.php

Spacing +5 added lines, -5 removed lines

@@ -1,17 +1,17 @@
 
-		<h3 class="txn-navigation-strip"><?php echo $previous_transaction . '&nbsp;'; echo __( 'Transaction # ', 'event_espresso' ) . $txn_nmbr['value']; echo '&nbsp;' . $next_transaction; ?></h3>
-		<h2 id="txn-date-h2" class="txn-date-h2"><?php echo $txn_datetime['value'];?></h2>
+		<h3 class="txn-navigation-strip"><?php echo $previous_transaction.'&nbsp;'; echo __('Transaction # ', 'event_espresso').$txn_nmbr['value']; echo '&nbsp;'.$next_transaction; ?></h3>
+		<h2 id="txn-date-h2" class="txn-date-h2"><?php echo $txn_datetime['value']; ?></h2>
 		<h2 id="txn-status-h2" class="txn-status-h2">
-			<?php echo __( 'Transaction Status: ', 'event_espresso' );?><span id="txn-status" class="<?php echo $txn_status['class'];?>"><?php echo $txn_status['value'];?></span>
+			<?php echo __('Transaction Status: ', 'event_espresso'); ?><span id="txn-status" class="<?php echo $txn_status['class']; ?>"><?php echo $txn_status['value']; ?></span>
 		</h2>
 
 	<?php $attributes = $amount_due ? 'class="txn-amount-due-h2"' : 'class="txn-amount-due-h2 hidden"'; ?>
 		<h2 id="txn-amount-due-h2" <?php echo $attributes; ?>>
-			<?php echo __( 'Total Amount Due: ', 'event_espresso' );?><span id="txn-admin-total-amount-due" class="<?php echo $amount_due_class;?>"><?php echo $amount_due;?></span>
+			<?php echo __('Total Amount Due: ', 'event_espresso'); ?><span id="txn-admin-total-amount-due" class="<?php echo $amount_due_class; ?>"><?php echo $amount_due; ?></span>
 		</h2>
 
 		<h3 id="txn-selected-method-of-payment-h3" class="txn-selected-method-of-payment-h3">
-			<?php echo __( 'Last Method of Payment: ', 'event_espresso' );?><?php echo $method_of_payment_name;?>
+			<?php echo __('Last Method of Payment: ', 'event_espresso'); ?><?php echo $method_of_payment_name; ?>
 		</h3>
 
 

core/helpers/EEH_Activation.helper.php

Indentation +1581 added lines, -1581 removed lines

@@ -18,233 +18,233 @@ 
 class EEH_Activation implements ResettableInterface
 {
 
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * WP_User->ID
-     *
-     * @var int
-     */
-    private static $_default_creator_id;
-
-    /**
-     * indicates whether or not we've already verified core's default data during this request,
-     * because after migrations are done, any addons activated while in maintenance mode
-     * will want to setup their own default data, and they might hook into core's default data
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
-     * This prevents doing that for EVERY single addon.
-     *
-     * @var boolean
-     */
-    protected static $_initialized_db_content_already_in_this_request = false;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    private static $table_analysis;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    private static $table_manager;
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableAnalysis
-     */
-    public static function getTableAnalysis()
-    {
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
-            self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        }
-        return self::$table_analysis;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableManager
-     */
-    public static function getTableManager()
-    {
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
-            self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
-        }
-        return self::$table_manager;
-    }
-
-
-    /**
-     *    _ensure_table_name_has_prefix
-     *
-     * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
-     * @access     public
-     * @static
-     * @param $table_name
-     * @return string
-     */
-    public static function ensure_table_name_has_prefix($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-    }
-
-
-    /**
-     *    system_initialization
-     *    ensures the EE configuration settings are loaded with at least default options set
-     *    and that all critical EE pages have been generated with the appropriate shortcodes in place
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function system_initialization()
-    {
-        EEH_Activation::reset_and_update_config();
-        //which is fired BEFORE activation of plugin anyways
-        EEH_Activation::verify_default_pages_exist();
-    }
-
-
-    /**
-     * Sets the database schema and creates folders. This should
-     * be called on plugin activation and reactivation
-     *
-     * @return boolean success, whether the database and folders are setup properly
-     * @throws \EE_Error
-     */
-    public static function initialize_db_and_folders()
-    {
-        return EEH_Activation::create_database_tables();
-    }
-
-
-    /**
-     * assuming we have an up-to-date database schema, this will populate it
-     * with default and initial data. This should be called
-     * upon activation of a new plugin, reactivation, and at the end
-     * of running migration scripts
-     *
-     * @throws \EE_Error
-     */
-    public static function initialize_db_content()
-    {
-        //let's avoid doing all this logic repeatedly, especially when addons are requesting it
-        if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
-            return;
-        }
-        EEH_Activation::$_initialized_db_content_already_in_this_request = true;
-
-        EEH_Activation::initialize_system_questions();
-        EEH_Activation::insert_default_status_codes();
-        EEH_Activation::generate_default_message_templates();
-        EEH_Activation::create_no_ticket_prices_array();
-
-        EEH_Activation::validate_messages_system();
-        EEH_Activation::insert_default_payment_methods();
-        //in case we've
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::create_cron_tasks();
-        // remove all TXN locks since that is being done via extra meta now
-        delete_option('ee_locked_transactions');
-        //also, check for CAF default db content
-        do_action('AHEE__EEH_Activation__initialize_db_content');
-        //also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
-        //which users really won't care about on initial activation
-        EE_Error::overwrite_success();
-    }
-
-
-    /**
-     * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
-     * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
-     * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
-     * (null)
-     *
-     * @param string $which_to_include can be 'current' (ones that are currently in use),
-     *                                 'old' (only returns ones that should no longer be used),or 'all',
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function get_cron_tasks($which_to_include)
-    {
-        $cron_tasks = apply_filters(
-            'FHEE__EEH_Activation__get_cron_tasks',
-            array(
-                'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
+	/**
+	 * constant used to indicate a cron task is no longer in use
+	 */
+	const cron_task_no_longer_in_use = 'no_longer_in_use';
+
+	/**
+	 * WP_User->ID
+	 *
+	 * @var int
+	 */
+	private static $_default_creator_id;
+
+	/**
+	 * indicates whether or not we've already verified core's default data during this request,
+	 * because after migrations are done, any addons activated while in maintenance mode
+	 * will want to setup their own default data, and they might hook into core's default data
+	 * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
+	 * This prevents doing that for EVERY single addon.
+	 *
+	 * @var boolean
+	 */
+	protected static $_initialized_db_content_already_in_this_request = false;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	private static $table_analysis;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	private static $table_manager;
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableAnalysis
+	 */
+	public static function getTableAnalysis()
+	{
+		if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		}
+		return self::$table_analysis;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableManager
+	 */
+	public static function getTableManager()
+	{
+		if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+			self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
+		}
+		return self::$table_manager;
+	}
+
+
+	/**
+	 *    _ensure_table_name_has_prefix
+	 *
+	 * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
+	 * @access     public
+	 * @static
+	 * @param $table_name
+	 * @return string
+	 */
+	public static function ensure_table_name_has_prefix($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+	}
+
+
+	/**
+	 *    system_initialization
+	 *    ensures the EE configuration settings are loaded with at least default options set
+	 *    and that all critical EE pages have been generated with the appropriate shortcodes in place
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function system_initialization()
+	{
+		EEH_Activation::reset_and_update_config();
+		//which is fired BEFORE activation of plugin anyways
+		EEH_Activation::verify_default_pages_exist();
+	}
+
+
+	/**
+	 * Sets the database schema and creates folders. This should
+	 * be called on plugin activation and reactivation
+	 *
+	 * @return boolean success, whether the database and folders are setup properly
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_and_folders()
+	{
+		return EEH_Activation::create_database_tables();
+	}
+
+
+	/**
+	 * assuming we have an up-to-date database schema, this will populate it
+	 * with default and initial data. This should be called
+	 * upon activation of a new plugin, reactivation, and at the end
+	 * of running migration scripts
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_content()
+	{
+		//let's avoid doing all this logic repeatedly, especially when addons are requesting it
+		if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
+			return;
+		}
+		EEH_Activation::$_initialized_db_content_already_in_this_request = true;
+
+		EEH_Activation::initialize_system_questions();
+		EEH_Activation::insert_default_status_codes();
+		EEH_Activation::generate_default_message_templates();
+		EEH_Activation::create_no_ticket_prices_array();
+
+		EEH_Activation::validate_messages_system();
+		EEH_Activation::insert_default_payment_methods();
+		//in case we've
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::create_cron_tasks();
+		// remove all TXN locks since that is being done via extra meta now
+		delete_option('ee_locked_transactions');
+		//also, check for CAF default db content
+		do_action('AHEE__EEH_Activation__initialize_db_content');
+		//also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
+		//which users really won't care about on initial activation
+		EE_Error::overwrite_success();
+	}
+
+
+	/**
+	 * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
+	 * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
+	 * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
+	 * (null)
+	 *
+	 * @param string $which_to_include can be 'current' (ones that are currently in use),
+	 *                                 'old' (only returns ones that should no longer be used),or 'all',
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function get_cron_tasks($which_to_include)
+	{
+		$cron_tasks = apply_filters(
+			'FHEE__EEH_Activation__get_cron_tasks',
+			array(
+				'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
 //				'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' => EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
-                //there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
-                'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
-            )
-        );
-        if ($which_to_include === 'old') {
-            $cron_tasks = array_filter(
-                $cron_tasks,
-                function ($value) {
-                    return $value === EEH_Activation::cron_task_no_longer_in_use;
-                }
-            );
-        } elseif ($which_to_include === 'current') {
-            $cron_tasks = array_filter($cron_tasks);
-        } elseif (WP_DEBUG && $which_to_include !== 'all') {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
-                        'event_espresso'
-                    ),
-                    $which_to_include
-                )
-            );
-        }
-        return $cron_tasks;
-    }
-
-
-    /**
-     * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
-     *
-     * @throws \EE_Error
-     */
-    public static function create_cron_tasks()
-    {
-
-        foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                /**
-                 * This allows client code to define the initial start timestamp for this schedule.
-                 */
-                if (is_array($frequency)
-                    && count($frequency) === 2
-                    && isset($frequency[0], $frequency[1])
-                ) {
-                    $start_timestamp = $frequency[0];
-                    $frequency = $frequency[1];
-                } else {
-                    $start_timestamp = time();
-                }
-                wp_schedule_event($start_timestamp, $frequency, $hook_name);
-            }
-        }
-
-    }
-
-
-    /**
-     * Remove the currently-existing and now-removed cron tasks.
-     *
-     * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
-     * @throws \EE_Error
-     */
-    public static function remove_cron_tasks($remove_all = true)
-    {
-        $cron_tasks_to_remove = $remove_all ? 'all' : 'old';
-        $crons                = _get_cron_array();
-        $crons                = is_array($crons) ? $crons : array();
-        /* reminder of what $crons look like:
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
+				//there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
+				'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
+			)
+		);
+		if ($which_to_include === 'old') {
+			$cron_tasks = array_filter(
+				$cron_tasks,
+				function ($value) {
+					return $value === EEH_Activation::cron_task_no_longer_in_use;
+				}
+			);
+		} elseif ($which_to_include === 'current') {
+			$cron_tasks = array_filter($cron_tasks);
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
+						'event_espresso'
+					),
+					$which_to_include
+				)
+			);
+		}
+		return $cron_tasks;
+	}
+
+
+	/**
+	 * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function create_cron_tasks()
+	{
+
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				/**
+				 * This allows client code to define the initial start timestamp for this schedule.
+				 */
+				if (is_array($frequency)
+					&& count($frequency) === 2
+					&& isset($frequency[0], $frequency[1])
+				) {
+					$start_timestamp = $frequency[0];
+					$frequency = $frequency[1];
+				} else {
+					$start_timestamp = time();
+				}
+				wp_schedule_event($start_timestamp, $frequency, $hook_name);
+			}
+		}
+
+	}
+
+
+	/**
+	 * Remove the currently-existing and now-removed cron tasks.
+	 *
+	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
+	 * @throws \EE_Error
+	 */
+	public static function remove_cron_tasks($remove_all = true)
+	{
+		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
+		$crons                = _get_cron_array();
+		$crons                = is_array($crons) ? $crons : array();
+		/* reminder of what $crons look like:
          * Top-level keys are timestamps, and their values are arrays.
          * The 2nd level arrays have keys with each of the cron task hook names to run at that time
          * and their values are arrays.
@@ -261,911 +261,911 @@ 
          *					...
          *      ...
          */
-        $ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
-        foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
-            if (is_array($hooks_to_fire_at_time)) {
-                foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
-                    if (isset($ee_cron_tasks_to_remove[$hook_name])
-                        && is_array($ee_cron_tasks_to_remove[$hook_name])
-                    ) {
-                        unset($crons[$timestamp][$hook_name]);
-                    }
-                }
-                //also take care of any empty cron timestamps.
-                if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[$timestamp]);
-                }
-            }
-        }
-        _set_cron_array($crons);
-    }
-
-
-    /**
-     *    CPT_initialization
-     *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function CPT_initialization()
-    {
-        // register Custom Post Types
-        EE_Registry::instance()->load_core('Register_CPTs');
-        flush_rewrite_rules();
-    }
-
-
-
-    /**
-     *    reset_and_update_config
-     * The following code was moved over from EE_Config so that it will no longer run on every request.
-     * If there is old calendar config data saved, then it will get converted on activation.
-     * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function reset_and_update_config()
-    {
-        do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
-        add_filter(
-            'FHEE__EE_Config___load_core_config__config_settings',
-            array('EEH_Activation', 'migrate_old_config_data'),
-            10,
-            3
-        );
-        //EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
-            delete_option(EE_Config::LOG_NAME);
-        }
-    }
-
-
-    /**
-     *    load_calendar_config
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_calendar_config()
-    {
-        // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
-        if (empty($plugins)) {
-            return;
-        }
-        foreach ($plugins as $plugin_path) {
-            // grab plugin folder name from path
-            $plugin = basename($plugin_path);
-            // drill down to Espresso plugins
-            // then to calendar related plugins
-            if (
-                strpos($plugin, 'espresso') !== false
-                || strpos($plugin, 'Espresso') !== false
-                || strpos($plugin, 'ee4') !== false
-                || strpos($plugin, 'EE4') !== false
-                || strpos($plugin, 'calendar') !== false
-            ) {
-                // this is what we are looking for
-                $calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
-                // does it exist in this folder ?
-                if (is_readable($calendar_config)) {
-                    // YEAH! let's load it
-                    require_once($calendar_config);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    _migrate_old_config_data
-     *
-     * @access    public
-     * @param array|stdClass $settings
-     * @param string         $config
-     * @param \EE_Config     $EE_Config
-     * @return \stdClass
-     */
-    public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
-    {
-        $convert_from_array = array('addons');
-        // in case old settings were saved as an array
-        if (is_array($settings) && in_array($config, $convert_from_array)) {
-            // convert existing settings to an object
-            $config_array = $settings;
-            $settings = new stdClass();
-            foreach ($config_array as $key => $value) {
-                if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
-                    $EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
-                } else {
-                    $settings->{$key} = $value;
-                }
-            }
-            add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
-        }
-        return $settings;
-    }
-
-
-    /**
-     * deactivate_event_espresso
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function deactivate_event_espresso()
-    {
-        // check permissions
-        if (current_user_can('activate_plugins')) {
-            deactivate_plugins(EE_PLUGIN_BASENAME, true);
-        }
-    }
-
-
-
-    /**
-     * verify_default_pages_exist
-     *
-     * @access public
-     * @static
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    public static function verify_default_pages_exist()
-    {
-        $critical_page_problem = false;
-        $critical_pages = array(
-            array(
-                'id'   => 'reg_page_id',
-                'name' => __('Registration Checkout', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CHECKOUT',
-            ),
-            array(
-                'id'   => 'txn_page_id',
-                'name' => __('Transactions', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_TXN_PAGE',
-            ),
-            array(
-                'id'   => 'thank_you_page_id',
-                'name' => __('Thank You', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_THANK_YOU',
-            ),
-            array(
-                'id'   => 'cancel_page_id',
-                'name' => __('Registration Cancelled', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CANCELLED',
-            ),
-        );
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        foreach ($critical_pages as $critical_page) {
-            // is critical page ID set in config ?
-            if ($EE_Core_Config->{$critical_page['id']} !== false) {
-                // attempt to find post by ID
-                $critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
-            }
-            // no dice?
-            if ($critical_page['post'] === null) {
-                // attempt to find post by title
-                $critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
-                // still nothing?
-                if ($critical_page['post'] === null) {
-                    $critical_page = EEH_Activation::create_critical_page($critical_page);
-                    // REALLY? Still nothing ??!?!?
-                    if ($critical_page['post'] === null) {
-                        $msg = __(
-                            'The Event Espresso critical page configuration settings could not be updated.',
-                            'event_espresso'
-                        );
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        break;
-                    }
-                }
-            }
-            // check that Post ID matches critical page ID in config
-            if (
-                isset($critical_page['post']->ID)
-                && $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
-            ) {
-                //update Config with post ID
-                $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
-                    $msg = __(
-                        'The Event Espresso critical page configuration settings could not be updated.',
-                        'event_espresso'
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            $critical_page_problem =
-                ! isset($critical_page['post']->post_status)
-                || $critical_page['post']->post_status !== 'publish'
-                || strpos($critical_page['post']->post_content, $critical_page['code']) === false
-                    ? true
-                    : $critical_page_problem;
-        }
-        if ($critical_page_problem) {
-            new PersistentAdminNotice(
-                'critical_page_problem',
-                sprintf(
-                    esc_html__(
-                        'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
-                    . __('Event Espresso Critical Pages Settings', 'event_espresso')
-                    . '</a>'
-                )
-            );
-        }
-        if (EE_Error::has_notices()) {
-            EE_Error::get_notices(false, true, true);
-        }
-    }
-
-
-
-    /**
-     * Returns the first post which uses the specified shortcode
-     *
-     * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
-     *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
-     *                             "[ESPRESSO_THANK_YOU"
-     *                             (we don't search for the closing shortcode bracket because they might have added
-     *                             parameter to the shortcode
-     * @return WP_Post or NULl
-     */
-    public static function get_page_by_ee_shortcode($ee_shortcode)
-    {
-        global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
-        $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
-        if ($post_id) {
-            return get_post($post_id);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    This function generates a post for critical espresso pages
-     *
-     * @access public
-     * @static
-     * @param array $critical_page
-     * @return array
-     */
-    public static function create_critical_page($critical_page)
-    {
-
-        $post_args = array(
-            'post_title'     => $critical_page['name'],
-            'post_status'    => 'publish',
-            'post_type'      => 'page',
-            'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
-        );
-
-        $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
-            $msg = sprintf(
-                __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return $critical_page;
-        }
-        // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
-            $msg = sprintf(
-                __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        return $critical_page;
-
-    }
-
-
-
-
-    /**
-     * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
-     * The role being used to check is filterable.
-     *
-     * @since  4.6.0
-     * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
-     */
-    public static function get_default_creator_id()
-    {
-        global $wpdb;
-        if ( ! empty(self::$_default_creator_id)) {
-            return self::$_default_creator_id;
-        }/**/
-        $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
-        //let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
-        $pre_filtered_id = apply_filters(
-            'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
-            false,
-            $role_to_check
-        );
-        if ($pre_filtered_id !== false) {
-            return (int)$pre_filtered_id;
-        }
-        $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
-        $query = $wpdb->prepare(
-            "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
-        );
-        $user_id = $wpdb->get_var($query);
-        $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int)$user_id) {
-            self::$_default_creator_id = (int)$user_id;
-            return self::$_default_creator_id;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * used by EE and EE addons during plugin activation to create tables.
-     * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
-     * but includes extra logic regarding activations.
-     *
-     * @access public
-     * @static
-     * @param string  $table_name              without the $wpdb->prefix
-     * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
-     *                                         table query)
-     * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
-     * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
-     *                                         and new once this function is done (ie, you really do want to CREATE a
-     *                                         table, and expect it to be empty once you're done) leave as FALSE when
-     *                                         you just want to verify the table exists and matches this definition
-     *                                         (and if it HAS data in it you want to leave it be)
-     * @return void
-     * @throws EE_Error if there are database errors
-     */
-    public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
-    {
-        if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-        }
-        $tableAnalysis = \EEH_Activation::getTableAnalysis();
-        $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
-        // do we need to first delete an existing version of this table ?
-        if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
-            // ok, delete the table... but ONLY if it's empty
-            $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
-            // table is NOT empty, are you SURE you want to delete this table ???
-            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
-                \EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } else if ( ! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                error_log(
-                    sprintf(
-                        __(
-                            'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
-                            'event_espresso'
-                        ),
-                        $wp_table_name,
-                        '<br/>',
-                        'espresso_db_update'
-                    )
-                );
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-
-    /**
-     *    add_column_if_it_doesn't_exist
-     *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::addColumn()
-     * @param string $table_name  (without "wp_", eg "esp_attendee"
-     * @param string $column_name
-     * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
-     *                            'VARCHAR(10)'
-     * @return bool|int
-     */
-    public static function add_column_if_it_doesnt_exist(
-        $table_name,
-        $column_name,
-        $column_info = 'INT UNSIGNED NOT NULL'
-    ) {
-        return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
-    }
-
-
-    /**
-     * get_fields_on_table
-     * Gets all the fields on the database table.
-     *
-     * @access     public
-     * @deprecated instead use TableManager::getTableColumns()
-     * @static
-     * @param string $table_name , without prefixed $wpdb->prefix
-     * @return array of database column names
-     */
-    public static function get_fields_on_table($table_name = null)
-    {
-        return \EEH_Activation::getTableManager()->getTableColumns($table_name);
-    }
-
-
-    /**
-     * db_table_is_empty
-     *
-     * @access     public\
-     * @deprecated instead use TableAnalysis::tableIsEmpty()
-     * @static
-     * @param string $table_name
-     * @return bool
-     */
-    public static function db_table_is_empty($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
-    }
-
-
-    /**
-     * delete_db_table_if_empty
-     *
-     * @access public
-     * @static
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_db_table_if_empty($table_name)
-    {
-        if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
-            return \EEH_Activation::getTableManager()->dropTable($table_name);
-        }
-        return false;
-    }
-
-
-    /**
-     * delete_unused_db_table
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropTable()
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_unused_db_table($table_name)
-    {
-        return \EEH_Activation::getTableManager()->dropTable($table_name);
-    }
-
-
-    /**
-     * drop_index
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropIndex()
-     * @param string $table_name
-     * @param string $index_name
-     * @return bool | int
-     */
-    public static function drop_index($table_name, $index_name)
-    {
-        return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
-    }
-
-
-
-    /**
-     * create_database_tables
-     *
-     * @access public
-     * @static
-     * @throws EE_Error
-     * @return boolean success (whether database is setup properly or not)
-     */
-    public static function create_database_tables()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        //find the migration script that sets the database to be compatible with the code
-        $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
-        if ($dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                if (WP_DEBUG) {
-                    foreach ($current_data_migration_script->get_errors() as $error) {
-                        EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                    }
-                } else {
-                    EE_Error::add_error(
-                        __(
-                            'There were errors creating the Event Espresso database tables and Event Espresso has been 
+		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
+		foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
+			if (is_array($hooks_to_fire_at_time)) {
+				foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
+					if (isset($ee_cron_tasks_to_remove[$hook_name])
+						&& is_array($ee_cron_tasks_to_remove[$hook_name])
+					) {
+						unset($crons[$timestamp][$hook_name]);
+					}
+				}
+				//also take care of any empty cron timestamps.
+				if (empty($hooks_to_fire_at_time)) {
+					unset($crons[$timestamp]);
+				}
+			}
+		}
+		_set_cron_array($crons);
+	}
+
+
+	/**
+	 *    CPT_initialization
+	 *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function CPT_initialization()
+	{
+		// register Custom Post Types
+		EE_Registry::instance()->load_core('Register_CPTs');
+		flush_rewrite_rules();
+	}
+
+
+
+	/**
+	 *    reset_and_update_config
+	 * The following code was moved over from EE_Config so that it will no longer run on every request.
+	 * If there is old calendar config data saved, then it will get converted on activation.
+	 * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function reset_and_update_config()
+	{
+		do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
+		add_filter(
+			'FHEE__EE_Config___load_core_config__config_settings',
+			array('EEH_Activation', 'migrate_old_config_data'),
+			10,
+			3
+		);
+		//EE_Config::reset();
+		if (! EE_Config::logging_enabled()) {
+			delete_option(EE_Config::LOG_NAME);
+		}
+	}
+
+
+	/**
+	 *    load_calendar_config
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_calendar_config()
+	{
+		// grab array of all plugin folders and loop thru it
+		$plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
+		if (empty($plugins)) {
+			return;
+		}
+		foreach ($plugins as $plugin_path) {
+			// grab plugin folder name from path
+			$plugin = basename($plugin_path);
+			// drill down to Espresso plugins
+			// then to calendar related plugins
+			if (
+				strpos($plugin, 'espresso') !== false
+				|| strpos($plugin, 'Espresso') !== false
+				|| strpos($plugin, 'ee4') !== false
+				|| strpos($plugin, 'EE4') !== false
+				|| strpos($plugin, 'calendar') !== false
+			) {
+				// this is what we are looking for
+				$calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
+				// does it exist in this folder ?
+				if (is_readable($calendar_config)) {
+					// YEAH! let's load it
+					require_once($calendar_config);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _migrate_old_config_data
+	 *
+	 * @access    public
+	 * @param array|stdClass $settings
+	 * @param string         $config
+	 * @param \EE_Config     $EE_Config
+	 * @return \stdClass
+	 */
+	public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
+	{
+		$convert_from_array = array('addons');
+		// in case old settings were saved as an array
+		if (is_array($settings) && in_array($config, $convert_from_array)) {
+			// convert existing settings to an object
+			$config_array = $settings;
+			$settings = new stdClass();
+			foreach ($config_array as $key => $value) {
+				if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
+					$EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
+				} else {
+					$settings->{$key} = $value;
+				}
+			}
+			add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * deactivate_event_espresso
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function deactivate_event_espresso()
+	{
+		// check permissions
+		if (current_user_can('activate_plugins')) {
+			deactivate_plugins(EE_PLUGIN_BASENAME, true);
+		}
+	}
+
+
+
+	/**
+	 * verify_default_pages_exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	public static function verify_default_pages_exist()
+	{
+		$critical_page_problem = false;
+		$critical_pages = array(
+			array(
+				'id'   => 'reg_page_id',
+				'name' => __('Registration Checkout', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CHECKOUT',
+			),
+			array(
+				'id'   => 'txn_page_id',
+				'name' => __('Transactions', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_TXN_PAGE',
+			),
+			array(
+				'id'   => 'thank_you_page_id',
+				'name' => __('Thank You', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_THANK_YOU',
+			),
+			array(
+				'id'   => 'cancel_page_id',
+				'name' => __('Registration Cancelled', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CANCELLED',
+			),
+		);
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		foreach ($critical_pages as $critical_page) {
+			// is critical page ID set in config ?
+			if ($EE_Core_Config->{$critical_page['id']} !== false) {
+				// attempt to find post by ID
+				$critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
+			}
+			// no dice?
+			if ($critical_page['post'] === null) {
+				// attempt to find post by title
+				$critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
+				// still nothing?
+				if ($critical_page['post'] === null) {
+					$critical_page = EEH_Activation::create_critical_page($critical_page);
+					// REALLY? Still nothing ??!?!?
+					if ($critical_page['post'] === null) {
+						$msg = __(
+							'The Event Espresso critical page configuration settings could not be updated.',
+							'event_espresso'
+						);
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						break;
+					}
+				}
+			}
+			// check that Post ID matches critical page ID in config
+			if (
+				isset($critical_page['post']->ID)
+				&& $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
+			) {
+				//update Config with post ID
+				$EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
+				if (! EE_Config::instance()->update_espresso_config(false, false)) {
+					$msg = __(
+						'The Event Espresso critical page configuration settings could not be updated.',
+						'event_espresso'
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			$critical_page_problem =
+				! isset($critical_page['post']->post_status)
+				|| $critical_page['post']->post_status !== 'publish'
+				|| strpos($critical_page['post']->post_content, $critical_page['code']) === false
+					? true
+					: $critical_page_problem;
+		}
+		if ($critical_page_problem) {
+			new PersistentAdminNotice(
+				'critical_page_problem',
+				sprintf(
+					esc_html__(
+						'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+					. __('Event Espresso Critical Pages Settings', 'event_espresso')
+					. '</a>'
+				)
+			);
+		}
+		if (EE_Error::has_notices()) {
+			EE_Error::get_notices(false, true, true);
+		}
+	}
+
+
+
+	/**
+	 * Returns the first post which uses the specified shortcode
+	 *
+	 * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
+	 *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
+	 *                             "[ESPRESSO_THANK_YOU"
+	 *                             (we don't search for the closing shortcode bracket because they might have added
+	 *                             parameter to the shortcode
+	 * @return WP_Post or NULl
+	 */
+	public static function get_page_by_ee_shortcode($ee_shortcode)
+	{
+		global $wpdb;
+		$shortcode_and_opening_bracket = '[' . $ee_shortcode;
+		$post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
+		if ($post_id) {
+			return get_post($post_id);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    This function generates a post for critical espresso pages
+	 *
+	 * @access public
+	 * @static
+	 * @param array $critical_page
+	 * @return array
+	 */
+	public static function create_critical_page($critical_page)
+	{
+
+		$post_args = array(
+			'post_title'     => $critical_page['name'],
+			'post_status'    => 'publish',
+			'post_type'      => 'page',
+			'comment_status' => 'closed',
+			'post_content'   => '[' . $critical_page['code'] . ']',
+		);
+
+		$post_id = wp_insert_post($post_args);
+		if (! $post_id) {
+			$msg = sprintf(
+				__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return $critical_page;
+		}
+		// get newly created post's details
+		if (! $critical_page['post'] = get_post($post_id)) {
+			$msg = sprintf(
+				__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		return $critical_page;
+
+	}
+
+
+
+
+	/**
+	 * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
+	 * The role being used to check is filterable.
+	 *
+	 * @since  4.6.0
+	 * @global WPDB $wpdb
+	 * @return mixed null|int WP_user ID or NULL
+	 */
+	public static function get_default_creator_id()
+	{
+		global $wpdb;
+		if ( ! empty(self::$_default_creator_id)) {
+			return self::$_default_creator_id;
+		}/**/
+		$role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
+		//let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
+		$pre_filtered_id = apply_filters(
+			'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
+			false,
+			$role_to_check
+		);
+		if ($pre_filtered_id !== false) {
+			return (int)$pre_filtered_id;
+		}
+		$capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
+		$query = $wpdb->prepare(
+			"SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
+			'%' . $role_to_check . '%'
+		);
+		$user_id = $wpdb->get_var($query);
+		$user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
+		if ($user_id && (int)$user_id) {
+			self::$_default_creator_id = (int)$user_id;
+			return self::$_default_creator_id;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * used by EE and EE addons during plugin activation to create tables.
+	 * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
+	 * but includes extra logic regarding activations.
+	 *
+	 * @access public
+	 * @static
+	 * @param string  $table_name              without the $wpdb->prefix
+	 * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
+	 *                                         table query)
+	 * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
+	 * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
+	 *                                         and new once this function is done (ie, you really do want to CREATE a
+	 *                                         table, and expect it to be empty once you're done) leave as FALSE when
+	 *                                         you just want to verify the table exists and matches this definition
+	 *                                         (and if it HAS data in it you want to leave it be)
+	 * @return void
+	 * @throws EE_Error if there are database errors
+	 */
+	public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
+	{
+		if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! function_exists('dbDelta')) {
+			require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+		}
+		$tableAnalysis = \EEH_Activation::getTableAnalysis();
+		$wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
+		// do we need to first delete an existing version of this table ?
+		if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
+			// ok, delete the table... but ONLY if it's empty
+			$deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
+			// table is NOT empty, are you SURE you want to delete this table ???
+			if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+				\EEH_Activation::getTableManager()->dropTable($wp_table_name);
+			} else if ( ! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				error_log(
+					sprintf(
+						__(
+							'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
+							'event_espresso'
+						),
+						$wp_table_name,
+						'<br/>',
+						'espresso_db_update'
+					)
+				);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+
+	/**
+	 *    add_column_if_it_doesn't_exist
+	 *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::addColumn()
+	 * @param string $table_name  (without "wp_", eg "esp_attendee"
+	 * @param string $column_name
+	 * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
+	 *                            'VARCHAR(10)'
+	 * @return bool|int
+	 */
+	public static function add_column_if_it_doesnt_exist(
+		$table_name,
+		$column_name,
+		$column_info = 'INT UNSIGNED NOT NULL'
+	) {
+		return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
+	}
+
+
+	/**
+	 * get_fields_on_table
+	 * Gets all the fields on the database table.
+	 *
+	 * @access     public
+	 * @deprecated instead use TableManager::getTableColumns()
+	 * @static
+	 * @param string $table_name , without prefixed $wpdb->prefix
+	 * @return array of database column names
+	 */
+	public static function get_fields_on_table($table_name = null)
+	{
+		return \EEH_Activation::getTableManager()->getTableColumns($table_name);
+	}
+
+
+	/**
+	 * db_table_is_empty
+	 *
+	 * @access     public\
+	 * @deprecated instead use TableAnalysis::tableIsEmpty()
+	 * @static
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public static function db_table_is_empty($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
+	}
+
+
+	/**
+	 * delete_db_table_if_empty
+	 *
+	 * @access public
+	 * @static
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_db_table_if_empty($table_name)
+	{
+		if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
+			return \EEH_Activation::getTableManager()->dropTable($table_name);
+		}
+		return false;
+	}
+
+
+	/**
+	 * delete_unused_db_table
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropTable()
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_unused_db_table($table_name)
+	{
+		return \EEH_Activation::getTableManager()->dropTable($table_name);
+	}
+
+
+	/**
+	 * drop_index
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropIndex()
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return bool | int
+	 */
+	public static function drop_index($table_name, $index_name)
+	{
+		return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
+	}
+
+
+
+	/**
+	 * create_database_tables
+	 *
+	 * @access public
+	 * @static
+	 * @throws EE_Error
+	 * @return boolean success (whether database is setup properly or not)
+	 */
+	public static function create_database_tables()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		//find the migration script that sets the database to be compatible with the code
+		$dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
+		if ($dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				if (WP_DEBUG) {
+					foreach ($current_data_migration_script->get_errors() as $error) {
+						EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+					}
+				} else {
+					EE_Error::add_error(
+						__(
+							'There were errors creating the Event Espresso database tables and Event Espresso has been 
                             deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                return false;
-            }
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to();
-        } else {
-            EE_Error::add_error(
-                __(
-                    'Could not determine most up-to-date data migration script from which to pull database schema
+							'event_espresso'
+						)
+					);
+				}
+				return false;
+			}
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to();
+		} else {
+			EE_Error::add_error(
+				__(
+					'Could not determine most up-to-date data migration script from which to pull database schema
                      structure. So database is probably not setup properly',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * initialize_system_questions
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function initialize_system_questions()
-    {
-        // QUESTION GROUPS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
-        $SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
-        // what we have
-        $question_groups = $wpdb->get_col($SQL);
-        // check the response
-        $question_groups = is_array($question_groups) ? $question_groups : array();
-        // what we should have
-        $QSG_systems = array(1, 2);
-        // loop thru what we should have and compare to what we have
-        foreach ($QSG_systems as $QSG_system) {
-            // reset values array
-            $QSG_values = array();
-            // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
-                // add it
-                switch ($QSG_system) {
-                    case 1:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 1,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_personal,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                    case 2:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 2,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_address,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                }
-                // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QSG_values,
-                        array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
-                    );
-                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
-                }
-            }
-        }
-        // QUESTIONS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
-        $SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
-        // what we have
-        $questions = $wpdb->get_col($SQL);
-        // what we should have
-        $QST_systems = array(
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'country',
-            'state',
-            'zip',
-            'phone',
-        );
-        $order_for_group_1 = 1;
-        $order_for_group_2 = 1;
-        // loop thru what we should have and compare to what we have
-        foreach ($QST_systems as $QST_system) {
-            // reset values array
-            $QST_values = array();
-            // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
-                // add it
-                switch ($QST_system) {
-                    case 'fname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('First Name', 'event_espresso'),
-                            'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'fname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 1,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'lname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Last Name', 'event_espresso'),
-                            'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'lname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 2,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'email':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Email Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email',
-                            'QST_type'          => 'EMAIL',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 3,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'address',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 4,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address2':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address2', 'event_espresso'),
-                            'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
-                            'QST_system'        => 'address2',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 5,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'city':
-                        $QST_values = array(
-                            'QST_display_text'  => __('City', 'event_espresso'),
-                            'QST_admin_label'   => __('City - System Question', 'event_espresso'),
-                            'QST_system'        => 'city',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 6,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'country':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Country', 'event_espresso'),
-                            'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
-                            'QST_system'        => 'country',
-                            'QST_type'          => 'COUNTRY',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 7,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'state':
-                        $QST_values = array(
-                            'QST_display_text'  => __('State/Province', 'event_espresso'),
-                            'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
-                            'QST_system'        => 'state',
-                            'QST_type'          => 'STATE',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 8,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'zip':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
-                            'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
-                            'QST_system'        => 'zip',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 9,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'phone':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Phone Number', 'event_espresso'),
-                            'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
-                            'QST_system'        => 'phone',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 10,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                }
-                if (! empty($QST_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QST_values,
-                        array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
-                    );
-                    $QST_ID = $wpdb->insert_id;
-                    // QUESTION GROUP QUESTIONS
-                    if (in_array($QST_system, array('fname', 'lname', 'email'))) {
-                        $system_question_we_want = EEM_Question_Group::system_personal;
-                    } else {
-                        $system_question_we_want = EEM_Question_Group::system_address;
-                    }
-                    if (isset($QSG_IDs[$system_question_we_want])) {
-                        $QSG_ID = $QSG_IDs[$system_question_we_want];
-                    } else {
-                        $id_col = EEM_Question_Group::instance()
-                                                    ->get_col(array(array('QSG_system' => $system_question_we_want)));
-                        if (is_array($id_col)) {
-                            $QSG_ID = reset($id_col);
-                        } else {
-                            //ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
-                            EE_Log::instance()->log(
-                                __FILE__,
-                                __FUNCTION__,
-                                sprintf(
-                                    __(
-                                        'Could not associate question %1$s to a question group because no system question
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * initialize_system_questions
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function initialize_system_questions()
+	{
+		// QUESTION GROUPS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
+		$SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
+		// what we have
+		$question_groups = $wpdb->get_col($SQL);
+		// check the response
+		$question_groups = is_array($question_groups) ? $question_groups : array();
+		// what we should have
+		$QSG_systems = array(1, 2);
+		// loop thru what we should have and compare to what we have
+		foreach ($QSG_systems as $QSG_system) {
+			// reset values array
+			$QSG_values = array();
+			// if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
+			if (! in_array("$QSG_system", $question_groups)) {
+				// add it
+				switch ($QSG_system) {
+					case 1:
+						$QSG_values = array(
+							'QSG_name'            => __('Personal Information', 'event_espresso'),
+							'QSG_identifier'      => 'personal-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 1,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_personal,
+							'QSG_deleted'         => 0,
+						);
+						break;
+					case 2:
+						$QSG_values = array(
+							'QSG_name'            => __('Address Information', 'event_espresso'),
+							'QSG_identifier'      => 'address-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 2,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_address,
+							'QSG_deleted'         => 0,
+						);
+						break;
+				}
+				// make sure we have some values before inserting them
+				if (! empty($QSG_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QSG_values,
+						array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
+					);
+					$QSG_IDs[$QSG_system] = $wpdb->insert_id;
+				}
+			}
+		}
+		// QUESTIONS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
+		$SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
+		// what we have
+		$questions = $wpdb->get_col($SQL);
+		// what we should have
+		$QST_systems = array(
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'country',
+			'state',
+			'zip',
+			'phone',
+		);
+		$order_for_group_1 = 1;
+		$order_for_group_2 = 1;
+		// loop thru what we should have and compare to what we have
+		foreach ($QST_systems as $QST_system) {
+			// reset values array
+			$QST_values = array();
+			// if we don't have what we should have
+			if (! in_array($QST_system, $questions)) {
+				// add it
+				switch ($QST_system) {
+					case 'fname':
+						$QST_values = array(
+							'QST_display_text'  => __('First Name', 'event_espresso'),
+							'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
+							'QST_system'        => 'fname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 1,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'lname':
+						$QST_values = array(
+							'QST_display_text'  => __('Last Name', 'event_espresso'),
+							'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
+							'QST_system'        => 'lname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 2,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'email':
+						$QST_values = array(
+							'QST_display_text'  => __('Email Address', 'event_espresso'),
+							'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email',
+							'QST_type'          => 'EMAIL',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 3,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address':
+						$QST_values = array(
+							'QST_display_text'  => __('Address', 'event_espresso'),
+							'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
+							'QST_system'        => 'address',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 4,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address2':
+						$QST_values = array(
+							'QST_display_text'  => __('Address2', 'event_espresso'),
+							'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
+							'QST_system'        => 'address2',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 5,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'city':
+						$QST_values = array(
+							'QST_display_text'  => __('City', 'event_espresso'),
+							'QST_admin_label'   => __('City - System Question', 'event_espresso'),
+							'QST_system'        => 'city',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 6,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'country':
+						$QST_values = array(
+							'QST_display_text'  => __('Country', 'event_espresso'),
+							'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
+							'QST_system'        => 'country',
+							'QST_type'          => 'COUNTRY',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 7,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'state':
+						$QST_values = array(
+							'QST_display_text'  => __('State/Province', 'event_espresso'),
+							'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
+							'QST_system'        => 'state',
+							'QST_type'          => 'STATE',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 8,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'zip':
+						$QST_values = array(
+							'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
+							'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
+							'QST_system'        => 'zip',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 9,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'phone':
+						$QST_values = array(
+							'QST_display_text'  => __('Phone Number', 'event_espresso'),
+							'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
+							'QST_system'        => 'phone',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 10,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+				}
+				if (! empty($QST_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QST_values,
+						array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
+					);
+					$QST_ID = $wpdb->insert_id;
+					// QUESTION GROUP QUESTIONS
+					if (in_array($QST_system, array('fname', 'lname', 'email'))) {
+						$system_question_we_want = EEM_Question_Group::system_personal;
+					} else {
+						$system_question_we_want = EEM_Question_Group::system_address;
+					}
+					if (isset($QSG_IDs[$system_question_we_want])) {
+						$QSG_ID = $QSG_IDs[$system_question_we_want];
+					} else {
+						$id_col = EEM_Question_Group::instance()
+													->get_col(array(array('QSG_system' => $system_question_we_want)));
+						if (is_array($id_col)) {
+							$QSG_ID = reset($id_col);
+						} else {
+							//ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
+							EE_Log::instance()->log(
+								__FILE__,
+								__FUNCTION__,
+								sprintf(
+									__(
+										'Could not associate question %1$s to a question group because no system question
                                          group existed',
-                                        'event_espresso'
-                                    ),
-                                    $QST_ID),
-                                'error');
-                            continue;
-                        }
-                    }
-                    // add system questions to groups
-                    $wpdb->insert(
-                        \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
-                        array(
-                            'QSG_ID'    => $QSG_ID,
-                            'QST_ID'    => $QST_ID,
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
-                        ),
-                        array('%d', '%d', '%d')
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Makes sure the default payment method (Invoice) is active.
-     * This used to be done automatically as part of constructing the old gateways config
-     *
-     * @throws \EE_Error
-     */
-    public static function insert_default_payment_methods()
-    {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-        } else {
-            EEM_Payment_Method::instance()->verify_button_urls();
-        }
-    }
-
-    /**
-     * insert_default_status_codes
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function insert_default_status_codes()
-    {
-
-        global $wpdb;
-
-        if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
-
-            $table_name = EEM_Status::instance()->table();
-
-            $SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
-            $wpdb->query($SQL);
-
-            $SQL = "INSERT INTO $table_name
+										'event_espresso'
+									),
+									$QST_ID),
+								'error');
+							continue;
+						}
+					}
+					// add system questions to groups
+					$wpdb->insert(
+						\EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
+						array(
+							'QSG_ID'    => $QSG_ID,
+							'QST_ID'    => $QST_ID,
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
+						),
+						array('%d', '%d', '%d')
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Makes sure the default payment method (Invoice) is active.
+	 * This used to be done automatically as part of constructing the old gateways config
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function insert_default_payment_methods()
+	{
+		if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+		} else {
+			EEM_Payment_Method::instance()->verify_button_urls();
+		}
+	}
+
+	/**
+	 * insert_default_status_codes
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function insert_default_status_codes()
+	{
+
+		global $wpdb;
+
+		if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
+
+			$table_name = EEM_Status::instance()->table();
+
+			$SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
+			$wpdb->query($SQL);
+
+			$SQL = "INSERT INTO $table_name
 					(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES
 					('ACT', 'ACTIVE', 'event', 0, NULL, 1),
 					('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),
@@ -1205,462 +1205,462 @@ 
 					('MID', 'IDLE', 'message', 0, NULL, 1),
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
-            $wpdb->query($SQL);
-
-        }
-
-    }
-
-
-    /**
-     * generate_default_message_templates
-     *
-     * @static
-     * @throws EE_Error
-     * @return bool     true means new templates were created.
-     *                  false means no templates were created.
-     *                  This is NOT an error flag. To check for errors you will want
-     *                  to use either EE_Error or a try catch for an EE_Error exception.
-     */
-    public static function generate_default_message_templates()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        /*
+			$wpdb->query($SQL);
+
+		}
+
+	}
+
+
+	/**
+	 * generate_default_message_templates
+	 *
+	 * @static
+	 * @throws EE_Error
+	 * @return bool     true means new templates were created.
+	 *                  false means no templates were created.
+	 *                  This is NOT an error flag. To check for errors you will want
+	 *                  to use either EE_Error or a try catch for an EE_Error exception.
+	 */
+	public static function generate_default_message_templates()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		/*
          * This first method is taking care of ensuring any default messengers
          * that should be made active and have templates generated are done.
          */
-        $new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
-            $message_resource_manager
-        );
-        /**
-         * This method is verifying there are no NEW default message types
-         * for ACTIVE messengers that need activated (and corresponding templates setup).
-         */
-        $new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
-            $message_resource_manager
-        );
-        //after all is done, let's persist these changes to the db.
-        $message_resource_manager->update_has_activated_messengers_option();
-        $message_resource_manager->update_active_messengers_option();
-        // will return true if either of these are true.  Otherwise will return false.
-        return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
-    }
-
-
-
-    /**
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $active_messengers */
-        $active_messengers = $message_resource_manager->active_messengers();
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_created = false;
-        foreach ($active_messengers as $active_messenger) {
-            $default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
-            $default_message_type_names_to_activate = array();
-            // looping through each default message type reported by the messenger
-            // and setup the actual message types to activate.
-            foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
-                // if already active or has already been activated before we skip
-                // (otherwise we might reactivate something user's intentionally deactivated.)
-                // we also skip if the message type is not installed.
-                if (
-                    $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $default_message_type_name_for_messenger,
-                        $active_messenger->name
-                    )
-                    || $message_resource_manager->is_message_type_active_for_messenger(
-                        $active_messenger->name,
-                        $default_message_type_name_for_messenger
-                    )
-                    || ! isset($installed_message_types[$default_message_type_name_for_messenger])
-                ) {
-                    continue;
-                }
-                $default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
-            }
-            //let's activate!
-            $message_resource_manager->ensure_message_types_are_active(
-                $default_message_type_names_to_activate,
-                $active_messenger->name,
-                false
-            );
-            //activate the templates for these message types
-            if ( ! empty($default_message_type_names_to_activate)) {
-                $templates_created = EEH_MSG_Template::generate_new_templates(
-                    $active_messenger->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_created;
-    }
-
-
-
-    /**
-     * This will activate and generate default messengers and default message types for those messengers.
-     *
-     * @param EE_message_Resource_Manager $message_resource_manager
-     * @return array|bool  True means there were default messengers and message type templates generated.
-     *                     False means that there were no templates generated
-     *                     (which could simply mean there are no default message types for a messenger).
-     * @throws EE_Error
-     */
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $messengers_to_generate */
-        $messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_generated = false;
-        foreach ($messengers_to_generate as $messenger_to_generate) {
-            $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
-            //verify the default message types match an installed message type.
-            foreach ($default_message_type_names_for_messenger as $key => $name) {
-                if (
-                    ! isset($installed_message_types[$name])
-                    || $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $name,
-                        $messenger_to_generate->name
-                    )
-                ) {
-                    unset($default_message_type_names_for_messenger[$key]);
-                }
-            }
-            // in previous iterations, the active_messengers option in the db
-            // needed updated before calling create templates. however with the changes this may not be necessary.
-            // This comment is left here just in case we discover that we _do_ need to update before
-            // passing off to create templates (after the refactor is done).
-            // @todo remove this comment when determined not necessary.
-            $message_resource_manager->activate_messenger(
-                $messenger_to_generate->name,
-                $default_message_type_names_for_messenger,
-                false
-            );
-            //create any templates needing created (or will reactivate templates already generated as necessary).
-            if ( ! empty($default_message_type_names_for_messenger)) {
-                $templates_generated = EEH_MSG_Template::generate_new_templates(
-                    $messenger_to_generate->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_generated;
-    }
-
-
-    /**
-     * This returns the default messengers to generate templates for on activation of EE.
-     * It considers:
-     * - whether a messenger is already active in the db.
-     * - whether a messenger has been made active at any time in the past.
-     *
-     * @static
-     * @param  EE_Message_Resource_Manager $message_resource_manager
-     * @return EE_messenger[]
-     */
-    protected static function _get_default_messengers_to_generate_on_activation(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $active_messengers    = $message_resource_manager->active_messengers();
-        $installed_messengers = $message_resource_manager->installed_messengers();
-        $has_activated        = $message_resource_manager->get_has_activated_messengers_option();
-
-        $messengers_to_generate = array();
-        foreach ($installed_messengers as $installed_messenger) {
-            //if installed messenger is a messenger that should be activated on install
-            //and is not already active
-            //and has never been activated
-            if (
-                ! $installed_messenger->activate_on_install
-                || isset($active_messengers[$installed_messenger->name])
-                || isset($has_activated[$installed_messenger->name])
-            ) {
-                continue;
-            }
-            $messengers_to_generate[$installed_messenger->name] = $installed_messenger;
-        }
-        return $messengers_to_generate;
-    }
-
-
-    /**
-     * This simply validates active message types to ensure they actually match installed
-     * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
-     * rows are set inactive.
-     * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
-     * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
-     * are still handled in here.
-     *
-     * @since 4.3.1
-     * @return void
-     */
-    public static function validate_messages_system()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $message_resource_manager->validate_active_message_types_are_installed();
-        do_action('AHEE__EEH_Activation__validate_messages_system');
-    }
-
-
-    /**
-     * create_no_ticket_prices_array
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function create_no_ticket_prices_array()
-    {
-        // this creates an array for tracking events that have no active ticket prices created
-        // this allows us to warn admins of the situation so that it can be corrected
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if (! $espresso_no_ticket_prices) {
-            add_option('ee_no_ticket_prices', array(), '', false);
-        }
-    }
-
-
-    /**
-     * plugin_deactivation
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function plugin_deactivation()
-    {
-    }
-
-
-    /**
-     * Finds all our EE4 custom post types, and deletes them and their associated data
-     * (like post meta or term relations)
-     *
-     * @global wpdb $wpdb
-     * @throws \EE_Error
-     */
-    public static function delete_all_espresso_cpt_data()
-    {
-        global $wpdb;
-        //get all the CPT post_types
-        $ee_post_types = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_CPT_Base) {
-                    $ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
-                }
-            }
-        }
-        //get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
-        $cpt_ids = $wpdb->get_col($query);
-        //delete each post meta and term relations too
-        foreach ($cpt_ids as $post_id) {
-            wp_delete_post($post_id, true);
-        }
-    }
-
-    /**
-     * Deletes all EE custom tables
-     *
-     * @return array
-     */
-    public static function drop_espresso_tables()
-    {
-        $tables = array();
-        // load registry
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (strpos($table->get_table_name(), 'esp_')
-                            &&
-                            (
-                                is_main_site()//main site? nuke them all
-                                || ! $table->is_global()//not main site,but not global either. nuke it
-                            )
-                        ) {
-                            $tables[$table->get_table_name()] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-
-        //there are some tables whose models were removed.
-        //they should be removed when removing all EE core's data
-        $tables_without_models = array(
-            'esp_promotion',
-            'esp_promotion_applied',
-            'esp_promotion_object',
-            'esp_promotion_rule',
-            'esp_rule',
-        );
-        foreach ($tables_without_models as $table) {
-            $tables[$table] = $table;
-        }
-        return \EEH_Activation::getTableManager()->dropTables($tables);
-    }
-
-
-
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public static function drop_tables($table_names)
-    {
-        return \EEH_Activation::getTableManager()->dropTables($table_names);
-    }
-
-
-
-    /**
-     * plugin_uninstall
-     *
-     * @access public
-     * @static
-     * @param bool $remove_all
-     * @return void
-     */
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
-    {
-        global $wpdb;
-        self::drop_espresso_tables();
-        $wp_options_to_delete = array(
-            'ee_no_ticket_prices'                => true,
-            'ee_active_messengers'               => true,
-            'ee_has_activated_messenger'         => true,
-            'ee_flush_rewrite_rules'             => true,
-            'ee_config'                          => false,
-            'ee_data_migration_current_db_state' => true,
-            'ee_data_migration_mapping_'         => false,
-            'ee_data_migration_script_'          => false,
-            'ee_data_migrations'                 => true,
-            'ee_dms_map'                         => false,
-            'ee_notices'                         => true,
-            'lang_file_check_'                   => false,
-            'ee_maintenance_mode'                => true,
-            'ee_ueip_optin'                      => true,
-            'ee_ueip_has_notified'               => true,
-            'ee_plugin_activation_errors'        => true,
-            'ee_id_mapping_from'                 => false,
-            'espresso_persistent_admin_notices'  => true,
-            'ee_encryption_key'                  => true,
-            'pue_force_upgrade_'                 => false,
-            'pue_json_error_'                    => false,
-            'pue_install_key_'                   => false,
-            'pue_verification_error_'            => false,
-            'pu_dismissed_upgrade_'              => false,
-            'external_updates-'                  => false,
-            'ee_extra_data'                      => true,
-            'ee_ssn_'                            => false,
-            'ee_rss_'                            => false,
-            'ee_rte_n_tx_'                       => false,
-            'ee_pers_admin_notices'              => true,
-            'ee_job_parameters_'                 => false,
-            'ee_upload_directories_incomplete'   => true,
-            'ee_verified_db_collations'          => true,
-        );
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = array();
-        foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
-            if ($no_wildcard) {
-                if ( ! delete_option($option_name)) {
-                    $undeleted_options[] = $option_name;
-                }
-            } else {
-                $option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
-                foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if ( ! delete_option($option_name_from_wildcard)) {
-                        $undeleted_options[] = $option_name_from_wildcard;
-                    }
-                }
-            }
-        }
-        //also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
-        remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
-            $db_update_sans_ee4 = array();
-            foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
-                    $db_update_sans_ee4[$version] = $times_activated;
-                }
-            }
-            update_option('espresso_db_update', $db_update_sans_ee4);
-        }
-        $errors = '';
-        if ( ! empty($undeleted_options)) {
-            $errors .= sprintf(
-                __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
-                '<br/>',
-                implode(',<br/>', $undeleted_options)
-            );
-        }
-        if ( ! empty($errors)) {
-            EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-    /**
-     * Gets the mysql error code from the last used query by wpdb
-     *
-     * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
-     */
-    public static function last_wpdb_error_code()
-    {
-        global $wpdb;
-        if ($wpdb->use_mysqli) {
-            return mysqli_errno($wpdb->dbh);
-        } else {
-            return mysql_errno($wpdb->dbh);
-        }
-    }
-
-    /**
-     * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
-     *
-     * @global wpdb  $wpdb
-     * @deprecated instead use TableAnalysis::tableExists()
-     * @param string $table_name with or without $wpdb->prefix
-     * @return boolean
-     */
-    public static function table_exists($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
-    }
-
-    /**
-     * Resets the cache on EEH_Activation
-     */
-    public static function reset()
-    {
-        self::$_default_creator_id                             = null;
-        self::$_initialized_db_content_already_in_this_request = false;
-    }
+		$new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
+			$message_resource_manager
+		);
+		/**
+		 * This method is verifying there are no NEW default message types
+		 * for ACTIVE messengers that need activated (and corresponding templates setup).
+		 */
+		$new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
+			$message_resource_manager
+		);
+		//after all is done, let's persist these changes to the db.
+		$message_resource_manager->update_has_activated_messengers_option();
+		$message_resource_manager->update_active_messengers_option();
+		// will return true if either of these are true.  Otherwise will return false.
+		return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
+	}
+
+
+
+	/**
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $active_messengers */
+		$active_messengers = $message_resource_manager->active_messengers();
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_created = false;
+		foreach ($active_messengers as $active_messenger) {
+			$default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
+			$default_message_type_names_to_activate = array();
+			// looping through each default message type reported by the messenger
+			// and setup the actual message types to activate.
+			foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
+				// if already active or has already been activated before we skip
+				// (otherwise we might reactivate something user's intentionally deactivated.)
+				// we also skip if the message type is not installed.
+				if (
+					$message_resource_manager->has_message_type_been_activated_for_messenger(
+						$default_message_type_name_for_messenger,
+						$active_messenger->name
+					)
+					|| $message_resource_manager->is_message_type_active_for_messenger(
+						$active_messenger->name,
+						$default_message_type_name_for_messenger
+					)
+					|| ! isset($installed_message_types[$default_message_type_name_for_messenger])
+				) {
+					continue;
+				}
+				$default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
+			}
+			//let's activate!
+			$message_resource_manager->ensure_message_types_are_active(
+				$default_message_type_names_to_activate,
+				$active_messenger->name,
+				false
+			);
+			//activate the templates for these message types
+			if ( ! empty($default_message_type_names_to_activate)) {
+				$templates_created = EEH_MSG_Template::generate_new_templates(
+					$active_messenger->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_created;
+	}
+
+
+
+	/**
+	 * This will activate and generate default messengers and default message types for those messengers.
+	 *
+	 * @param EE_message_Resource_Manager $message_resource_manager
+	 * @return array|bool  True means there were default messengers and message type templates generated.
+	 *                     False means that there were no templates generated
+	 *                     (which could simply mean there are no default message types for a messenger).
+	 * @throws EE_Error
+	 */
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $messengers_to_generate */
+		$messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_generated = false;
+		foreach ($messengers_to_generate as $messenger_to_generate) {
+			$default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
+			//verify the default message types match an installed message type.
+			foreach ($default_message_type_names_for_messenger as $key => $name) {
+				if (
+					! isset($installed_message_types[$name])
+					|| $message_resource_manager->has_message_type_been_activated_for_messenger(
+						$name,
+						$messenger_to_generate->name
+					)
+				) {
+					unset($default_message_type_names_for_messenger[$key]);
+				}
+			}
+			// in previous iterations, the active_messengers option in the db
+			// needed updated before calling create templates. however with the changes this may not be necessary.
+			// This comment is left here just in case we discover that we _do_ need to update before
+			// passing off to create templates (after the refactor is done).
+			// @todo remove this comment when determined not necessary.
+			$message_resource_manager->activate_messenger(
+				$messenger_to_generate->name,
+				$default_message_type_names_for_messenger,
+				false
+			);
+			//create any templates needing created (or will reactivate templates already generated as necessary).
+			if ( ! empty($default_message_type_names_for_messenger)) {
+				$templates_generated = EEH_MSG_Template::generate_new_templates(
+					$messenger_to_generate->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_generated;
+	}
+
+
+	/**
+	 * This returns the default messengers to generate templates for on activation of EE.
+	 * It considers:
+	 * - whether a messenger is already active in the db.
+	 * - whether a messenger has been made active at any time in the past.
+	 *
+	 * @static
+	 * @param  EE_Message_Resource_Manager $message_resource_manager
+	 * @return EE_messenger[]
+	 */
+	protected static function _get_default_messengers_to_generate_on_activation(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$active_messengers    = $message_resource_manager->active_messengers();
+		$installed_messengers = $message_resource_manager->installed_messengers();
+		$has_activated        = $message_resource_manager->get_has_activated_messengers_option();
+
+		$messengers_to_generate = array();
+		foreach ($installed_messengers as $installed_messenger) {
+			//if installed messenger is a messenger that should be activated on install
+			//and is not already active
+			//and has never been activated
+			if (
+				! $installed_messenger->activate_on_install
+				|| isset($active_messengers[$installed_messenger->name])
+				|| isset($has_activated[$installed_messenger->name])
+			) {
+				continue;
+			}
+			$messengers_to_generate[$installed_messenger->name] = $installed_messenger;
+		}
+		return $messengers_to_generate;
+	}
+
+
+	/**
+	 * This simply validates active message types to ensure they actually match installed
+	 * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
+	 * rows are set inactive.
+	 * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
+	 * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
+	 * are still handled in here.
+	 *
+	 * @since 4.3.1
+	 * @return void
+	 */
+	public static function validate_messages_system()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$message_resource_manager->validate_active_message_types_are_installed();
+		do_action('AHEE__EEH_Activation__validate_messages_system');
+	}
+
+
+	/**
+	 * create_no_ticket_prices_array
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function create_no_ticket_prices_array()
+	{
+		// this creates an array for tracking events that have no active ticket prices created
+		// this allows us to warn admins of the situation so that it can be corrected
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
+		if (! $espresso_no_ticket_prices) {
+			add_option('ee_no_ticket_prices', array(), '', false);
+		}
+	}
+
+
+	/**
+	 * plugin_deactivation
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function plugin_deactivation()
+	{
+	}
+
+
+	/**
+	 * Finds all our EE4 custom post types, and deletes them and their associated data
+	 * (like post meta or term relations)
+	 *
+	 * @global wpdb $wpdb
+	 * @throws \EE_Error
+	 */
+	public static function delete_all_espresso_cpt_data()
+	{
+		global $wpdb;
+		//get all the CPT post_types
+		$ee_post_types = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_CPT_Base) {
+					$ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
+				}
+			}
+		}
+		//get all our CPTs
+		$query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+		$cpt_ids = $wpdb->get_col($query);
+		//delete each post meta and term relations too
+		foreach ($cpt_ids as $post_id) {
+			wp_delete_post($post_id, true);
+		}
+	}
+
+	/**
+	 * Deletes all EE custom tables
+	 *
+	 * @return array
+	 */
+	public static function drop_espresso_tables()
+	{
+		$tables = array();
+		// load registry
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (strpos($table->get_table_name(), 'esp_')
+							&&
+							(
+								is_main_site()//main site? nuke them all
+								|| ! $table->is_global()//not main site,but not global either. nuke it
+							)
+						) {
+							$tables[$table->get_table_name()] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+
+		//there are some tables whose models were removed.
+		//they should be removed when removing all EE core's data
+		$tables_without_models = array(
+			'esp_promotion',
+			'esp_promotion_applied',
+			'esp_promotion_object',
+			'esp_promotion_rule',
+			'esp_rule',
+		);
+		foreach ($tables_without_models as $table) {
+			$tables[$table] = $table;
+		}
+		return \EEH_Activation::getTableManager()->dropTables($tables);
+	}
+
+
+
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public static function drop_tables($table_names)
+	{
+		return \EEH_Activation::getTableManager()->dropTables($table_names);
+	}
+
+
+
+	/**
+	 * plugin_uninstall
+	 *
+	 * @access public
+	 * @static
+	 * @param bool $remove_all
+	 * @return void
+	 */
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
+	{
+		global $wpdb;
+		self::drop_espresso_tables();
+		$wp_options_to_delete = array(
+			'ee_no_ticket_prices'                => true,
+			'ee_active_messengers'               => true,
+			'ee_has_activated_messenger'         => true,
+			'ee_flush_rewrite_rules'             => true,
+			'ee_config'                          => false,
+			'ee_data_migration_current_db_state' => true,
+			'ee_data_migration_mapping_'         => false,
+			'ee_data_migration_script_'          => false,
+			'ee_data_migrations'                 => true,
+			'ee_dms_map'                         => false,
+			'ee_notices'                         => true,
+			'lang_file_check_'                   => false,
+			'ee_maintenance_mode'                => true,
+			'ee_ueip_optin'                      => true,
+			'ee_ueip_has_notified'               => true,
+			'ee_plugin_activation_errors'        => true,
+			'ee_id_mapping_from'                 => false,
+			'espresso_persistent_admin_notices'  => true,
+			'ee_encryption_key'                  => true,
+			'pue_force_upgrade_'                 => false,
+			'pue_json_error_'                    => false,
+			'pue_install_key_'                   => false,
+			'pue_verification_error_'            => false,
+			'pu_dismissed_upgrade_'              => false,
+			'external_updates-'                  => false,
+			'ee_extra_data'                      => true,
+			'ee_ssn_'                            => false,
+			'ee_rss_'                            => false,
+			'ee_rte_n_tx_'                       => false,
+			'ee_pers_admin_notices'              => true,
+			'ee_job_parameters_'                 => false,
+			'ee_upload_directories_incomplete'   => true,
+			'ee_verified_db_collations'          => true,
+		);
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = array();
+		foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
+			if ($no_wildcard) {
+				if ( ! delete_option($option_name)) {
+					$undeleted_options[] = $option_name;
+				}
+			} else {
+				$option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
+				foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
+					if ( ! delete_option($option_name_from_wildcard)) {
+						$undeleted_options[] = $option_name_from_wildcard;
+					}
+				}
+			}
+		}
+		//also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
+		remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
+			$db_update_sans_ee4 = array();
+			foreach ($espresso_db_update as $version => $times_activated) {
+				if ((string)$version[0] === '3') {//if its NON EE4
+					$db_update_sans_ee4[$version] = $times_activated;
+				}
+			}
+			update_option('espresso_db_update', $db_update_sans_ee4);
+		}
+		$errors = '';
+		if ( ! empty($undeleted_options)) {
+			$errors .= sprintf(
+				__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
+				'<br/>',
+				implode(',<br/>', $undeleted_options)
+			);
+		}
+		if ( ! empty($errors)) {
+			EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+	/**
+	 * Gets the mysql error code from the last used query by wpdb
+	 *
+	 * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
+	 */
+	public static function last_wpdb_error_code()
+	{
+		global $wpdb;
+		if ($wpdb->use_mysqli) {
+			return mysqli_errno($wpdb->dbh);
+		} else {
+			return mysql_errno($wpdb->dbh);
+		}
+	}
+
+	/**
+	 * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
+	 *
+	 * @global wpdb  $wpdb
+	 * @deprecated instead use TableAnalysis::tableExists()
+	 * @param string $table_name with or without $wpdb->prefix
+	 * @return boolean
+	 */
+	public static function table_exists($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
+	}
+
+	/**
+	 * Resets the cache on EEH_Activation
+	 */
+	public static function reset()
+	{
+		self::$_default_creator_id                             = null;
+		self::$_initialized_db_content_already_in_this_request = false;
+	}
 }
 // End of file EEH_Activation.helper.php
 // Location: /helpers/EEH_Activation.core.php

Spacing +28 added lines, -28 removed lines

@@ -57,7 +57,7 @@ 
      */
     public static function getTableAnalysis()
     {
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+        if ( ! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
             self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
         }
         return self::$table_analysis;
@@ -69,7 +69,7 @@ 
      */
     public static function getTableManager()
     {
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+        if ( ! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
             self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
         }
         return self::$table_manager;
@@ -183,7 +183,7 @@ 
         if ($which_to_include === 'old') {
             $cron_tasks = array_filter(
                 $cron_tasks,
-                function ($value) {
+                function($value) {
                     return $value === EEH_Activation::cron_task_no_longer_in_use;
                 }
             );
@@ -213,7 +213,7 @@ 
     {
 
         foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
+            if ( ! wp_next_scheduled($hook_name)) {
                 /**
                  * This allows client code to define the initial start timestamp for this schedule.
                  */
@@ -318,7 +318,7 @@ 
             3
         );
         //EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             delete_option(EE_Config::LOG_NAME);
         }
     }
@@ -333,7 +333,7 @@ 
     public static function load_calendar_config()
     {
         // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR);
+        $plugins = glob(WP_PLUGIN_DIR.DS.'*', GLOB_ONLYDIR);
         if (empty($plugins)) {
             return;
         }
@@ -350,7 +350,7 @@ 
                 || strpos($plugin, 'calendar') !== false
             ) {
                 // this is what we are looking for
-                $calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
+                $calendar_config = $plugin_path.DS.'EE_Calendar_Config.php';
                 // does it exist in this folder ?
                 if (is_readable($calendar_config)) {
                     // YEAH! let's load it
@@ -478,7 +478,7 @@ 
             ) {
                 //update Config with post ID
                 $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
+                if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
                     $msg = __(
                         'The Event Espresso critical page configuration settings could not be updated.',
                         'event_espresso'
@@ -501,7 +501,7 @@ 
                         'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+                    '<a href="'.admin_url('admin.php?page=espresso_general_settings&action=critical_pages').'">'
                     . __('Event Espresso Critical Pages Settings', 'event_espresso')
                     . '</a>'
                 )
@@ -527,7 +527,7 @@ 
     public static function get_page_by_ee_shortcode($ee_shortcode)
     {
         global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
+        $shortcode_and_opening_bracket = '['.$ee_shortcode;
         $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
         if ($post_id) {
             return get_post($post_id);
@@ -553,11 +553,11 @@ 
             'post_status'    => 'publish',
             'post_type'      => 'page',
             'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
+            'post_content'   => '['.$critical_page['code'].']',
         );
 
         $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
+        if ( ! $post_id) {
             $msg = sprintf(
                 __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
                 $critical_page['name']
@@ -566,7 +566,7 @@ 
             return $critical_page;
         }
         // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
+        if ( ! $critical_page['post'] = get_post($post_id)) {
             $msg = sprintf(
                 __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
                 $critical_page['name']
@@ -603,17 +603,17 @@ 
             $role_to_check
         );
         if ($pre_filtered_id !== false) {
-            return (int)$pre_filtered_id;
+            return (int) $pre_filtered_id;
         }
         $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
         $query = $wpdb->prepare(
             "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
+            '%'.$role_to_check.'%'
         );
         $user_id = $wpdb->get_var($query);
         $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int)$user_id) {
-            self::$_default_creator_id = (int)$user_id;
+        if ($user_id && (int) $user_id) {
+            self::$_default_creator_id = (int) $user_id;
             return self::$_default_creator_id;
         } else {
             return null;
@@ -648,7 +648,7 @@ 
         }
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+            require_once(ABSPATH.'wp-admin/includes/upgrade.php');
         }
         $tableAnalysis = \EEH_Activation::getTableAnalysis();
         $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
@@ -859,13 +859,13 @@ 
             // reset values array
             $QSG_values = array();
             // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
+            if ( ! in_array("$QSG_system", $question_groups)) {
                 // add it
                 switch ($QSG_system) {
                     case 1:
                         $QSG_values = array(
                             'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
+                            'QSG_identifier'      => 'personal-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 1,
                             'QSG_show_group_name' => 1,
@@ -877,7 +877,7 @@ 
                     case 2:
                         $QSG_values = array(
                             'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
+                            'QSG_identifier'      => 'address-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 2,
                             'QSG_show_group_name' => 1,
@@ -888,7 +888,7 @@ 
                         break;
                 }
                 // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
+                if ( ! empty($QSG_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
@@ -925,7 +925,7 @@ 
             // reset values array
             $QST_values = array();
             // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
+            if ( ! in_array($QST_system, $questions)) {
                 // add it
                 switch ($QST_system) {
                     case 'fname':
@@ -1077,7 +1077,7 @@ 
                         );
                         break;
                 }
-                if (! empty($QST_values)) {
+                if ( ! empty($QST_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
@@ -1138,7 +1138,7 @@ 
      */
     public static function insert_default_payment_methods()
     {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+        if ( ! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
         } else {
@@ -1427,7 +1427,7 @@ 
         // this creates an array for tracking events that have no active ticket prices created
         // this allows us to warn admins of the situation so that it can be corrected
         $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if (! $espresso_no_ticket_prices) {
+        if ( ! $espresso_no_ticket_prices) {
             add_option('ee_no_ticket_prices', array(), '', false);
         }
     }
@@ -1466,7 +1466,7 @@ 
             }
         }
         //get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (".implode(",", $ee_post_types).")";
         $cpt_ids = $wpdb->get_col($query);
         //delete each post meta and term relations too
         foreach ($cpt_ids as $post_id) {
@@ -1606,7 +1606,7 @@ 
         if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
             $db_update_sans_ee4 = array();
             foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
+                if ((string) $version[0] === '3') {//if its NON EE4
                     $db_update_sans_ee4[$version] = $times_activated;
                 }
             }

modules/single_page_checkout/reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php

Indentation +2870 added lines, -2870 removed lines

@@ -15,2874 +15,2874 @@
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @access protected
-     * @var EE_Line_Item_Display $Line_Item_Display
-     */
-    protected $line_item_display;
-
-    /**
-     * @access protected
-     * @var boolean $handle_IPN_in_this_request
-     */
-    protected $handle_IPN_in_this_request = false;
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_filter(
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
-        );
-        add_action(
-            'wp_ajax_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action(
-            'wp_ajax_nopriv_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
-        add_action(
-            'wp_ajax_nopriv_save_payer_details',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
-        );
-        add_action(
-            'wp_ajax_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_action(
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_filter(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
-            10,
-            1
-        );
-    }
-
-
-    /**
-     *    ajax switch_spco_billing_form
-     *
-     * @throws \EE_Error
-     */
-    public static function switch_spco_billing_form()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
-    }
-
-
-    /**
-     *    ajax save_payer_details
-     *
-     * @throws \EE_Error
-     */
-    public static function save_payer_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
-    }
-
-
-    /**
-     *    ajax get_transaction_details
-     *
-     * @throws \EE_Error
-     */
-    public static function get_transaction_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
-    }
-
-
-    /**
-     * bypass_recaptcha_for_load_payment_method
-     *
-     * @access public
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function bypass_recaptcha_for_load_payment_method()
-    {
-        return array(
-            'EESID'  => EE_Registry::instance()->SSN->id(),
-            'step'   => 'payment_options',
-            'action' => 'spco_billing_form',
-        );
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug     = 'payment_options';
-        $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
-        $this->checkout  = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__(
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @return null
-     */
-    public function line_item_display()
-    {
-        return $this->line_item_display;
-    }
-
-
-    /**
-     * @param null $line_item_display
-     */
-    public function set_line_item_display($line_item_display)
-    {
-        $this->line_item_display = $line_item_display;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request()
-    {
-        return $this->handle_IPN_in_this_request;
-    }
-
-
-    /**
-     * @param boolean $handle_IPN_in_this_request
-     */
-    public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
-    {
-        $this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * translate_js_strings
-     *
-     * @return void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
-            'Please select a method of payment in order to continue.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
-            'Forwarding to Secure Payment Provider.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * enqueue_styles_and_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        $transaction = $this->checkout->transaction;
-        //if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
-            return;
-        }
-        foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
-            $type_obj = $payment_method->type_obj();
-            if ($type_obj instanceof EE_PMT_Base) {
-                $billing_form = $type_obj->generate_new_billing_form($transaction);
-                if ($billing_form instanceof EE_Form_Section_Proper) {
-                    $billing_form->enqueue_js();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * initialize_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function initialize_reg_step()
-    {
-        // TODO: if /when we implement donations, then this will need overriding
-        if (// don't need payment options for:
-            // 	registrations made via the admin
-            // 	completed transactions
-            // 	overpaid transactions
-            // 	$ 0.00 transactions (no payment required)
-            ! $this->checkout->payment_required()
-            // but do NOT remove if current action being called belongs to this reg step
-            && ! is_callable(array($this, $this->checkout->action))
-            && ! $this->completed()
-        ) {
-            // and if so, then we no longer need the Payment Options step
-            if ($this->is_current_step()) {
-                $this->checkout->generate_reg_form = false;
-            }
-            $this->checkout->remove_reg_step($this->_slug);
-            // DEBUG LOG
-            //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        // get all active payment methods
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function generate_reg_form()
-    {
-        // reset in case someone changes their mind
-        $this->_reset_selected_method_of_payment();
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'payments_closed';
-        $registrations_requiring_payment            = array();
-        $registrations_for_free_events              = array();
-        $registrations_requiring_pre_approval       = array();
-        $sold_out_events                            = array();
-        $insufficient_spaces_available              = array();
-        $no_payment_required                        = true;
-        // loop thru registrations to gather info
-        $registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            $this->checkout->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
-                } else {
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
-                }
-                continue;
-            }
-            // event requires admin approval
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
-                // add event to list of events with pre-approval reg status
-                $registrations_requiring_pre_approval[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            if ($this->checkout->revisit
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-                && (
-                    $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out(true)
-                )
-            ) {
-                // add event to list of events that are sold out
-                $sold_out_events[$registration->event()->ID()] = $registration->event();
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            // are they allowed to pay now and is there monies owing?
-            if ($registration->owes_monies_and_can_pay()) {
-                $registrations_requiring_payment[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
-                    $registration->event(),
-                    $this
-                );
-            } elseif (! $this->checkout->revisit
-                && $registration->status_ID() !== EEM_Registration::status_id_not_approved
-                && $registration->ticket()->is_free()
-            ) {
-                $registrations_for_free_events[$registration->event()->ID()] = $registration;
-            }
-        }
-        $subsections = array();
-        // now decide which template to load
-        if (! empty($sold_out_events)) {
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
-        }
-        if (! empty($insufficient_spaces_available)) {
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
-                $insufficient_spaces_available
-            );
-        }
-        if (! empty($registrations_requiring_pre_approval)) {
-            $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
-                $registrations_requiring_pre_approval
-            );
-        }
-        if (! empty($registrations_for_free_events)) {
-            $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
-        }
-        if (! empty($registrations_requiring_payment)) {
-            if ($this->checkout->amount_owing > 0) {
-                // autoload Line_Item_Display classes
-                EEH_Autoloader::register_line_item_filter_autoloaders();
-                $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
-                    apply_filters(
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-                        new EE_Line_Item_Filter_Collection()
-                    ),
-                    $this->checkout->cart->get_grand_total()
-                );
-                /** @var EE_Line_Item $filtered_line_item_tree */
-                $filtered_line_item_tree = $line_item_filter_processor->process();
-                EEH_Autoloader::register_line_item_display_autoloaders();
-                $this->set_line_item_display(new EE_Line_Item_Display('spco'));
-                $subsections['payment_options'] = $this->_display_payment_options(
-                    $this->line_item_display->display_line_item(
-                        $filtered_line_item_tree,
-                        array('registrations' => $registrations)
-                    )
-                );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
-                $this->_apply_registration_payments_to_amount_owing($registrations);
-            }
-            $no_payment_required = false;
-        } else {
-            $this->_hide_reg_step_submit_button_if_revisit();
-        }
-        $this->_save_selected_method_of_payment();
-
-        $subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
-        $subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
-
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => new EE_No_Layout(),
-            )
-        );
-    }
-
-
-    /**
-     * add line item filters required for this reg step
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
-     *        payment options reg step, can apply these filters via the following: apply_filters(
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
-     *        filter collection by passing that instead of instantiating a new collection
-     *
-     * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
-     * @return EE_Line_Item_Filter_Collection
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
-    {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
-            return $line_item_filter_collection;
-        }
-        $line_item_filter_collection->add(
-            new EE_Billable_Line_Item_Filter(
-                EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
-                    EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                    )
-                )
-            )
-        );
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
-        return $line_item_filter_collection;
-    }
-
-
-    /**
-     * remove_ejected_registrations
-     * if a registrant has lost their potential space at an event due to lack of payment,
-     * then this method removes them from the list of registrations being paid for during this request
-     *
-     * @param \EE_Registration[] $registrations
-     * @return EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function remove_ejected_registrations(array $registrations)
-    {
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            EE_Registry::instance()->SSN->checkout()->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[$REG_ID])) {
-                unset($registrations[$REG_ID]);
-                continue;
-            }
-        }
-        return $registrations;
-    }
-
-
-    /**
-     * find_registrations_that_lost_their_space
-     * If a registrant chooses an offline payment method like Invoice,
-     * then no space is reserved for them at the event until they fully pay fo that site
-     * (unless the event's default reg status is set to APPROVED)
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
-     * then this method will determine which registrations have lost the ability to complete the reg process.
-     *
-     * @param \EE_Registration[] $registrations
-     * @param bool               $revisit
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
-    {
-        // registrations per event
-        $event_reg_count = array();
-        // spaces left per event
-        $event_spaces_remaining = array();
-        // tickets left sorted by ID
-        $tickets_remaining = array();
-        // registrations that have lost their space
-        $ejected_registrations = array();
-        foreach ($registrations as $REG_ID => $registration) {
-            if ($registration->status_ID() === EEM_Registration::status_id_approved
-                || apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
-                    false,
-                    $registration,
-                    $revisit
-                )
-            ) {
-                continue;
-            }
-            $EVT_ID = $registration->event_ID();
-            $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[$ticket->ID()])) {
-                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
-            }
-            if ($tickets_remaining[$ticket->ID()] > 0) {
-                if (! isset($event_reg_count[$EVT_ID])) {
-                    $event_reg_count[$EVT_ID] = 0;
-                }
-                $event_reg_count[$EVT_ID]++;
-                if (! isset($event_spaces_remaining[$EVT_ID])) {
-                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
-                }
-            }
-            if ($revisit
-                && ($tickets_remaining[$ticket->ID()] === 0
-                    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
-                )
-            ) {
-                $ejected_registrations[$REG_ID] = $registration->event();
-                if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
-                    /** @type EE_Registration_Processor $registration_processor */
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-                    // at this point, we should have enough details about the registrant to consider the registration
-                    // NOT incomplete
-                    $registration_processor->manually_update_registration_status(
-                        $registration,
-                        EEM_Registration::status_id_wait_list
-                    );
-                }
-            }
-        }
-        return $ejected_registrations;
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _adjust_registration_status_if_event_old_sold()
-    {
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _hide_reg_step_submit_button_if_revisit()
-    {
-        if ($this->checkout->revisit) {
-            add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
-        }
-    }
-
-
-    /**
-     * sold_out_events
-     * displays notices regarding events that have sold out since hte registrant first signed up
-     *
-     * @param \EE_Event[] $sold_out_events_array
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _sold_out_events($sold_out_events_array = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'events_sold_out';
-        $sold_out_events                            = '';
-        foreach ($sold_out_events_array as $sold_out_event) {
-            $sold_out_events .= EEH_HTML::li(
-                EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
-                    '',
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
-                )
-            );
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                'sold_out_events'     => $sold_out_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
-                                    sprintf(
-                                        esc_html__(
-                                            'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
-                                            'event_espresso'
-                                        ),
-                                        '<strong>',
-                                        '</strong>',
-                                        '<br />'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _insufficient_spaces_available
-     * displays notices regarding events that do not have enough remaining spaces
-     * to satisfy the current number of registrations looking to pay
-     *
-     * @param \EE_Event[] $insufficient_spaces_events_array
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'invoice';
-        $insufficient_space_events                  = '';
-        foreach ($insufficient_spaces_events_array as $event) {
-            if ($event instanceof EE_Event) {
-                $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => array(
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
-                ),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
-                            array(
-                                'sold_out_events'     => $insufficient_space_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
-                                    esc_html__(
-                                        'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * registrations_requiring_pre_approval
-     *
-     * @param array $registrations_requiring_pre_approval
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
-    {
-        $events_requiring_pre_approval = '';
-        foreach ($registrations_requiring_pre_approval as $registration) {
-            if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
-                $events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
-                    EEH_HTML::span(
-                        '',
-                        '',
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
-                    )
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'events_requiring_pre_approval.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
-                                'events_requiring_pre_approval_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
-                                    esc_html__(
-                                        'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _no_payment_required
-     *
-     * @param \EE_Event[] $registrations_for_free_events
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _no_payment_required($registrations_for_free_events = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
-        // generate no_payment_required form
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'no_payment_required.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
-                            array(
-                                'revisit'                       => $this->checkout->revisit,
-                                'registrations'                 => array(),
-                                'ticket_count'                  => array(),
-                                'registrations_for_free_events' => $registrations_for_free_events,
-                                'no_payment_required_msg'       => EEH_HTML::p(
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _display_payment_options
-     *
-     * @param string $transaction_details
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _display_payment_options($transaction_details = '')
-    {
-        // has method_of_payment been set by no-js user?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
-        // build payment options form
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
-            new EE_Form_Section_Proper(
-                array(
-                    'subsections'     => array(
-                        'before_payment_options' => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
-                            new EE_Form_Section_Proper(
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
-                            )
-                        ),
-                        'payment_options'        => $this->_setup_payment_options(),
-                        'after_payment_options'  => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
-                            new EE_Form_Section_Proper(
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
-                            )
-                        ),
-                    ),
-                    'layout_strategy' => new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template,
-                            'template_args'        => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
-                                array(
-                                    'reg_count'                 => $this->line_item_display->total_items(),
-                                    'transaction_details'       => $transaction_details,
-                                    'available_payment_methods' => array(),
-                                )
-                            ),
-                        )
-                    ),
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _extra_hidden_inputs
-     *
-     * @param bool $no_payment_required
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _extra_hidden_inputs($no_payment_required = true)
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    'spco_no_payment_required' => new EE_Hidden_Input(
-                        array(
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
-                            'html_name'              => 'spco_no_payment_required',
-                            'html_id'                => 'spco-no-payment-required-payment_options',
-                            'default'                => $no_payment_required,
-                        )
-                    ),
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
-                        array(
-                            'normalization_strategy' => new EE_Int_Normalization(),
-                            'html_name'              => 'spco_transaction_id',
-                            'html_id'                => 'spco-transaction-id',
-                            'default'                => $this->checkout->transaction->ID(),
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     *    _apply_registration_payments_to_amount_owing
-     *
-     * @access protected
-     * @param array $registrations
-     * @throws EE_Error
-     */
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
-    {
-        $payments = array();
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
-                $payments += $registration->registration_payments();
-            }
-        }
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Registration_Payment) {
-                    $this->checkout->amount_owing -= $payment->amount();
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    _reset_selected_method_of_payment
-     *
-     * @access    private
-     * @param    bool $force_reset
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _reset_selected_method_of_payment($force_reset = false)
-    {
-        $reset_payment_method = $force_reset
-            ? true
-            : sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
-        if ($reset_payment_method) {
-            $this->checkout->selected_method_of_payment = null;
-            $this->checkout->payment_method             = null;
-            $this->checkout->billing_form               = null;
-            $this->_save_selected_method_of_payment();
-        }
-    }
-
-
-    /**
-     * _save_selected_method_of_payment
-     * stores the selected_method_of_payment in the session
-     * so that it's available for all subsequent requests including AJAX
-     *
-     * @access        private
-     * @param string $selected_method_of_payment
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _save_selected_method_of_payment($selected_method_of_payment = '')
-    {
-        $selected_method_of_payment = ! empty($selected_method_of_payment)
-            ? $selected_method_of_payment
-            : $this->checkout->selected_method_of_payment;
-        EE_Registry::instance()->SSN->set_session_data(
-            array('selected_method_of_payment' => $selected_method_of_payment)
-        );
-    }
-
-
-    /**
-     * _setup_payment_options
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function _setup_payment_options()
-    {
-        // load payment method classes
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
-        if (empty($this->checkout->available_payment_methods)) {
-            EE_Error::add_error(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
-                    sprintf(
-                        esc_html__(
-                            'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
-                            'event_espresso'
-                        ),
-                        '<br>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    )
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
-            ? apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
-            )
-            : apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Method of Payment', 'event_espresso')
-            );
-        $available_payment_methods = array(
-            // display the "Payment Method" header
-            'payment_method_header' => new EE_Form_Section_HTML(
-                EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
-            ),
-        );
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
-        $available_payment_method_options = array();
-        $default_payment_method_option    = array();
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
-        $payment_methods_billing_info = array(
-            new EE_Form_Section_HTML(
-                EEH_HTML::div('<br />', '', '', 'clear:both;')
-            ),
-        );
-        // loop through payment methods
-        foreach ($this->checkout->available_payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $payment_method_button = EEH_HTML::img(
-                    $payment_method->button_url(),
-                    $payment_method->name(),
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
-                    'spco-payment-method-btn-img'
-                );
-                // check if any payment methods are set as default
-                // if payment method is already selected OR nothing is selected and this payment method should be
-                // open_by_default
-                if (($this->checkout->selected_method_of_payment === $payment_method->slug())
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
-                ) {
-                    $this->checkout->selected_method_of_payment = $payment_method->slug();
-                    $this->_save_selected_method_of_payment();
-                    $default_payment_method_option[$payment_method->slug()] = $payment_method_button;
-                } else {
-                    $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
-                }
-                $payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
-                    $payment_method
-                );
-            }
-        }
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
-        // of PMs
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
-        // now generate the actual form  inputs
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
-            $available_payment_method_options
-        );
-        $available_payment_methods                              += $payment_methods_billing_info;
-        // build the available payment methods form
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'spco-available-methods-of-payment-dv',
-                'subsections'     => $available_payment_methods,
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-            )
-        );
-    }
-
-
-    /**
-     * _get_available_payment_methods
-     *
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_available_payment_methods()
-    {
-        if (! empty($this->checkout->available_payment_methods)) {
-            return $this->checkout->available_payment_methods;
-        }
-        $available_payment_methods = array();
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        /** @type EEM_Payment_Method $EEM_Payment_Method */
-        $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-        // get all active payment methods
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $available_payment_methods[$payment_method->slug()] = $payment_method;
-            }
-        }
-        return $available_payment_methods;
-    }
-
-
-    /**
-     *    _available_payment_method_inputs
-     *
-     * @access    private
-     * @param    array $available_payment_method_options
-     * @return    \EE_Form_Section_Proper
-     */
-    private function _available_payment_method_inputs($available_payment_method_options = array())
-    {
-        // generate inputs
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-available-payment-method-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    '' => new EE_Radio_Button_Input(
-                        $available_payment_method_options,
-                        array(
-                            'html_name'          => 'selected_method_of_payment',
-                            'html_class'         => 'spco-payment-method',
-                            'default'            => $this->checkout->selected_method_of_payment,
-                            'label_size'         => 11,
-                            'enforce_label_size' => true,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     *    _payment_method_billing_info
-     *
-     * @access    private
-     * @param    EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
-    {
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
-            ? true
-            : false;
-        // generate the billing form for payment method
-        $billing_form                 = $currently_selected
-            ? $this->_get_billing_form_for_payment_method($payment_method)
-            : new EE_Form_Section_HTML();
-        $this->checkout->billing_form = $currently_selected
-            ? $billing_form
-            : $this->checkout->billing_form;
-        // it's all in the details
-        $info_html = EEH_HTML::h3(
-            esc_html__('Important information regarding your payment', 'event_espresso'),
-            '',
-            'spco-payment-method-hdr'
-        );
-        // add some info regarding the step, either from what's saved in the admin,
-        // or a default string depending on whether the PM has a billing form or not
-        if ($payment_method->description()) {
-            $payment_method_info = $payment_method->description();
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
-            $payment_method_info = sprintf(
-                esc_html__(
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
-                    'event_espresso'
-                ),
-                $this->submit_button_text()
-            );
-        } else {
-            $payment_method_info = sprintf(
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
-                $this->submit_button_text()
-            );
-        }
-        $info_html .= EEH_HTML::p(
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
-                $payment_method_info
-            ),
-            '',
-            'spco-payment-method-desc ee-attention'
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
-                'html_class'      => 'spco-payment-method-info-dv',
-                // only display the selected or default PM
-                'html_style'      => $currently_selected ? '' : 'display:none;',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    'info'         => new EE_Form_Section_HTML($info_html),
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * get_billing_form_html_for_payment_method
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_billing_form_html_for_payment_method()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            return false;
-        }
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-            false
-        )) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // now generate billing form for selected method of payment
-        $payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
-        // fill form with attendee info if applicable
-        if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
-            && $this->checkout->transaction_has_primary_registrant()
-        ) {
-            $payment_method_billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if ($payment_method_billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $payment_method_billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $payment_method_billing_form
-                );
-        }
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
-            ? $payment_method_billing_form->get_html()
-            : '';
-        $this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
-        // localize validation rules for main form
-        $this->checkout->current_step->reg_form->localize_validation_rules();
-        $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        return true;
-    }
-
-
-    /**
-     * _get_billing_form_for_payment_method
-     *
-     * @access private
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
-    {
-        $billing_form = $payment_method->type_obj()->billing_form(
-            $this->checkout->transaction,
-            array('amount_owing' => $this->checkout->amount_owing)
-        );
-        if ($billing_form instanceof EE_Billing_Info_Form) {
-            if (apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-                false
-            )
-                && EE_Registry::instance()->REQ->is_set('payment_method')
-            ) {
-                EE_Error::add_success(
-                    apply_filters(
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                        sprintf(
-                            esc_html__(
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                                'event_espresso'
-                            ),
-                            $payment_method->name()
-                        )
-                    )
-                );
-            }
-            return apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-                $billing_form,
-                $payment_method
-            );
-        }
-        // no actual billing form, so return empty HTML form section
-        return new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _get_selected_method_of_payment
-     *
-     * @access private
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
-     *                          is not found in the incoming request
-     * @param string  $request_param
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_selected_method_of_payment(
-        $required = false,
-        $request_param = 'selected_method_of_payment'
-    ) {
-        // is selected_method_of_payment set in the request ?
-        $selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
-        if ($selected_method_of_payment) {
-            // sanitize it
-            $selected_method_of_payment = is_array($selected_method_of_payment)
-                ? array_shift($selected_method_of_payment)
-                : $selected_method_of_payment;
-            $selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
-            // store it in the session so that it's available for all subsequent requests including AJAX
-            $this->_save_selected_method_of_payment($selected_method_of_payment);
-        } else {
-            // or is is set in the session ?
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
-                'selected_method_of_payment'
-            );
-        }
-        // do ya really really gotta have it?
-        if (empty($selected_method_of_payment) && $required) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $selected_method_of_payment;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
-    /********************************************************************************************************/
-    /**
-     * switch_payment_method
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function switch_payment_method()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return false;
-        }
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-            false
-        )) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // fill form with attendee info if applicable
-        if (apply_filters(
-            'FHEE__populate_billing_form_fields_from_attendee',
-            (
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $this->checkout->transaction_has_primary_registrant()
-            ),
-            $this->checkout->billing_form,
-            $this->checkout->transaction
-        )
-        ) {
-            $this->checkout->billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $this->checkout->billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $this->checkout->billing_form
-                );
-        }
-        // get html and validation rules for form
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->json_response->set_return_data(
-                array('payment_method_info' => $this->checkout->billing_form->get_html())
-            );
-            // localize validation rules for main form
-            $this->checkout->billing_form->localize_validation_rules(true);
-            $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        } else {
-            $this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
-        }
-        //prevents advancement to next step
-        $this->checkout->continue_reg = false;
-        return true;
-    }
-
-
-    /**
-     * _verify_payment_method_is_set
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _verify_payment_method_is_set()
-    {
-        // generate billing form for selected method of payment if it hasn't been done already
-        if (empty($this->checkout->selected_method_of_payment)) {
-            // how have they chosen to pay?
-            $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        } else {
-            // choose your own adventure based on method_of_payment
-            switch ($this->checkout->selected_method_of_payment) {
-                case 'events_sold_out' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                case 'payments_closed' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                case 'no_payment_required' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                default:
-            }
-        }
-        // verify payment method
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            // get payment method for selected method of payment
-            $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
-        }
-        return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
-    }
-
-
-
-    /********************************************************************************************************/
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * save_payer_details_via_ajax
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function save_payer_details_via_ajax()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return;
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // generate primary attendee from payer info if applicable
-        if (! $this->checkout->transaction_has_primary_registrant()) {
-            $attendee = $this->_create_attendee_from_request_data();
-            if ($attendee instanceof EE_Attendee) {
-                foreach ($this->checkout->transaction->registrations() as $registration) {
-                    if ($registration->is_primary_registrant()) {
-                        $this->checkout->primary_attendee_obj = $attendee;
-                        $registration->_add_relation_to($attendee, 'Attendee');
-                        $registration->set_attendee_id($attendee->ID());
-                        $registration->update_cache_after_object_save('Attendee', $attendee);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * create_attendee_from_request_data
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _create_attendee_from_request_data()
-    {
-        // get State ID
-        $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
-        if (! empty($STA_ID)) {
-            // can we get state object from name ?
-            EE_Registry::instance()->load_model('State');
-            $state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
-        }
-        // get Country ISO
-        $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
-        if (! empty($CNT_ISO)) {
-            // can we get country object from name ?
-            EE_Registry::instance()->load_model('Country');
-            $country = EEM_Country::instance()->get_col(
-                array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
-                'CNT_ISO'
-            );
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
-        }
-        // grab attendee data
-        $attendee_data = array(
-            'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
-            'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
-            'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
-            'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
-            'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
-            'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
-            'STA_ID'       => $STA_ID,
-            'CNT_ISO'      => $CNT_ISO,
-            'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
-            'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
-        );
-        // validate the email address since it is the most important piece of info
-        if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
-            EE_Error::add_error(
-                esc_html__('An invalid email address was submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
-        // AND email address
-        if (! empty($attendee_data['ATT_fname'])
-            && ! empty($attendee_data['ATT_lname'])
-            && ! empty($attendee_data['ATT_email'])
-        ) {
-            $existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
-                array(
-                    'ATT_fname' => $attendee_data['ATT_fname'],
-                    'ATT_lname' => $attendee_data['ATT_lname'],
-                    'ATT_email' => $attendee_data['ATT_email'],
-                )
-            );
-            if ($existing_attendee instanceof EE_Attendee) {
-                return $existing_attendee;
-            }
-        }
-        // no existing attendee? kk let's create a new one
-        // kinda lame, but we need a first and last name to create an attendee, so use the email address if those
-        // don't exist
-        $attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
-            ? $attendee_data['ATT_fname']
-            : $attendee_data['ATT_email'];
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
-            ? $attendee_data['ATT_lname']
-            : $attendee_data['ATT_email'];
-        return EE_Attendee::new_instance($attendee_data);
-    }
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  *****************************************/
-    /********************************************************************************************************/
-    /**
-     * process_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function process_reg_step()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
-            ? 'no_payment_required'
-            : $this->_get_selected_method_of_payment(true);
-        // choose your own adventure based on method_of_payment
-        switch ($this->checkout->selected_method_of_payment) {
-
-            case 'events_sold_out' :
-                $this->checkout->redirect     = true;
-                $this->checkout->redirect_url = $this->checkout->cancel_page_url;
-                $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-                // mark this reg step as completed
-                $this->set_completed();
-                return false;
-                break;
-
-            case 'payments_closed' :
-                if (apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
-                    false
-                )) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required at this time.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-                break;
-
-            case 'no_payment_required' :
-                if (apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
-                    false
-                )) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-                break;
-
-            default:
-                $registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                );
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-                    $registrations,
-                    EE_Registry::instance()->SSN->checkout()->revisit
-                );
-                // calculate difference between the two arrays
-                $registrations = array_diff($registrations, $ejected_registrations);
-                if (empty($registrations)) {
-                    $this->_redirect_because_event_sold_out();
-                    return false;
-                }
-                $payment_successful = $this->_process_payment();
-                if ($payment_successful) {
-                    $this->checkout->continue_reg = true;
-                    $this->_maybe_set_completed($this->checkout->payment_method);
-                } else {
-                    $this->checkout->continue_reg = false;
-                }
-                return $payment_successful;
-        }
-    }
-
-
-    /**
-     * _redirect_because_event_sold_out
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _redirect_because_event_sold_out()
-    {
-        $this->checkout->continue_reg = false;
-        // set redirect URL
-        $this->checkout->redirect_url = add_query_arg(
-            array('e_reg_url_link' => $this->checkout->reg_url_link),
-            $this->checkout->current_step->reg_step_url()
-        );
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-    }
-
-
-    /**
-     * _maybe_set_completed
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _maybe_set_completed(EE_Payment_Method $payment_method)
-    {
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite :
-                break;
-            case EE_PMT_Base::onsite :
-            case EE_PMT_Base::offline :
-                // mark this reg step as completed
-                $this->set_completed();
-                break;
-        }
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to retry a payment
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function update_reg_step()
-    {
-        $success = true;
-        // if payment required
-        if ($this->checkout->transaction->total() > 0) {
-            do_action(
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
-                $this->checkout->transaction
-            );
-            // attempt payment via payment method
-            $success = $this->process_reg_step();
-        }
-        if ($success && ! $this->checkout->redirect) {
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
-                $this->checkout->transaction->ID()
-            );
-            // set return URL
-            $this->checkout->redirect_url = add_query_arg(
-                array('e_reg_url_link' => $this->checkout->reg_url_link),
-                $this->checkout->thank_you_page_url
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     *    _process_payment
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_payment()
-    {
-        // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
-            return false;
-        }
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $this->checkout->json_response->set_plz_select_method_of_payment(
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
-            );
-            return false;
-        }
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            return false;
-        }
-        // setup billing form
-        if ($this->checkout->payment_method->is_on_site()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-            // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
-                return false;
-            }
-        }
-        // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
-            return false;
-        }
-        // if session is close to expiring (under 10 minutes by default)
-        if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
-            // add some time to session expiration so that payment can be completed
-            EE_Registry::instance()->SSN->extend_expiration();
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        //$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
-        // in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
-        // for events with a default reg status of Approved
-        // $transaction_processor->toggle_registration_statuses_for_default_approved_events(
-        //      $this->checkout->transaction, $this->checkout->reg_cache_where_params
-        // );
-        // attempt payment
-        $payment = $this->_attempt_payment($this->checkout->payment_method);
-        // process results
-        $payment = $this->_validate_payment($payment);
-        $payment = $this->_post_payment_processing($payment);
-        // verify payment
-        if ($payment instanceof EE_Payment) {
-            // store that for later
-            $this->checkout->payment = $payment;
-            // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
-            $this->checkout->transaction->toggle_failed_transaction_status();
-            $payment_status = $payment->status();
-            if (
-                $payment_status === EEM_Payment::status_id_approved
-                || $payment_status === EEM_Payment::status_id_pending
-            ) {
-                return true;
-            } else {
-                return false;
-            }
-        } else if ($payment === true) {
-            // please note that offline payment methods will NOT make a payment,
-            // but instead just mark themselves as the PMD_ID on the transaction, and return true
-            $this->checkout->payment = $payment;
-            return true;
-        }
-        // where's my money?
-        return false;
-    }
-
-
-    /**
-     * _last_second_ticket_verifications
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _last_second_ticket_verifications()
-    {
-        // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
-            return true;
-        }
-        $registrations = $this->checkout->transaction->registrations();
-        if (empty($registrations)) {
-            return false;
-        }
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
-                $event = $registration->event_obj();
-                if ($event instanceof EE_Event && $event->is_sold_out(true)) {
-                    EE_Error::add_error(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
-                            sprintf(
-                                esc_html__(
-                                    'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
-                                    'event_espresso'
-                                ),
-                                $event->name()
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * redirect_form
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function redirect_form()
-    {
-        $payment_method_billing_info = $this->_payment_method_billing_info(
-            $this->_get_payment_method_for_selected_method_of_payment()
-        );
-        $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
-        EE_Registry::instance()->REQ->add_output($html);
-        return true;
-    }
-
-
-    /**
-     * _billing_form_is_valid
-     *
-     * @access private
-     * @return bool
-     * @throws \EE_Error
-     */
-    private function _billing_form_is_valid()
-    {
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
-            return true;
-        }
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
-            if ($this->checkout->billing_form->was_submitted()) {
-                $this->checkout->billing_form->receive_form_submission();
-                if ($this->checkout->billing_form->is_valid()) {
-                    return true;
-                }
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
-                $error_strings     = array();
-                foreach ($validation_errors as $validation_error) {
-                    if ($validation_error instanceof EE_Validation_Error) {
-                        $form_section = $validation_error->get_form_section();
-                        if ($form_section instanceof EE_Form_Input_Base) {
-                            $label = $form_section->html_label_text();
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
-                            $label = $form_section->name();
-                        } else {
-                            $label = esc_html__('Validation Error', 'event_espresso');
-                        }
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
-                    }
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        implode('<br/>', $error_strings)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The billing form was not submitted or something prevented it\'s submission.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * _setup_primary_registrant_prior_to_payment
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
-     * yet)
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _setup_primary_registrant_prior_to_payment()
-    {
-        // check if transaction has a primary registrant and that it has a related Attendee object
-        // if not, then we need to at least gather some primary registrant data before attempting payment
-        if (
-            $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-            && ! $this->checkout->transaction_has_primary_registrant()
-            && ! $this->_capture_primary_registration_data_from_billing_form()
-        ) {
-            return false;
-        }
-        // because saving an object clears it's cache, we need to do the chevy shuffle
-        // grab the primary_registration object
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        // at this point we'll consider a TXN to not have been failed
-        $this->checkout->transaction->toggle_failed_transaction_status();
-        // save the TXN ( which clears cached copy of primary_registration)
-        $this->checkout->transaction->save();
-        // grab TXN ID and save it to the primary_registration
-        $primary_registration->set_transaction_id($this->checkout->transaction->ID());
-        // save what we have so far
-        $primary_registration->save();
-        return true;
-    }
-
-
-    /**
-     * _capture_primary_registration_data_from_billing_form
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _capture_primary_registration_data_from_billing_form()
-    {
-        // convert billing form data into an attendee
-        $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
-              instanceof
-              EE_Attendee
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        // at this point, we should have enough details about the registrant to consider the registration NOT incomplete
-        $registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
-        return true;
-    }
-
-
-    /**
-     * _get_payment_method_for_selected_method_of_payment
-     * retrieves a valid payment method
-     *
-     * @access public
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_payment_method_for_selected_method_of_payment()
-    {
-        if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
-            $this->_redirect_because_event_sold_out();
-            return null;
-        }
-        // get EE_Payment_Method object
-        if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
-            $payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
-        } else {
-            // load EEM_Payment_Method
-            EE_Registry::instance()->load_model('Payment_Method');
-            /** @type EEM_Payment_Method $EEM_Payment_Method */
-            $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-            $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
-        }
-        // verify $payment_method
-        if (! $payment_method instanceof EE_Payment_Method) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     *    _attempt_payment
-     *
-     * @access    private
-     * @type    EE_Payment_Method $payment_method
-     * @return mixed EE_Payment | boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _attempt_payment(EE_Payment_Method $payment_method)
-    {
-        $payment = null;
-        $this->checkout->transaction->save();
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
-            return false;
-        }
-        try {
-            $payment_processor->set_revisit($this->checkout->revisit);
-            // generate payment object
-            $payment = $payment_processor->process_payment(
-                $payment_method,
-                $this->checkout->transaction,
-                $this->checkout->amount_owing,
-                $this->checkout->billing_form,
-                $this->_get_return_url($payment_method),
-                'CART',
-                $this->checkout->admin_request,
-                true,
-                $this->reg_step_url()
-            );
-        } catch (Exception $e) {
-            $this->_handle_payment_processor_exception($e);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _handle_payment_processor_exception
-     *
-     * @access protected
-     * @param \Exception $e
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _handle_payment_processor_exception(Exception $e)
-    {
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
-                $e->getMessage(),
-                $e->getFile(),
-                $e->getLine()
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * _get_return_url
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_return_url(EE_Payment_Method $payment_method)
-    {
-        $return_url = '';
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite :
-                $return_url = add_query_arg(
-                    array(
-                        'action'                     => 'process_gateway_response',
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
-                    ),
-                    $this->reg_step_url()
-                );
-                break;
-            case EE_PMT_Base::onsite :
-            case EE_PMT_Base::offline :
-                $return_url = $this->checkout->next_step->reg_step_url();
-                break;
-        }
-        return $return_url;
-    }
-
-
-    /**
-     * _validate_payment
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _validate_payment($payment = null)
-    {
-        if ($this->checkout->payment_method->is_off_line()) {
-            return true;
-        }
-        // verify payment object
-        if (! $payment instanceof EE_Payment) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _post_payment_processing
-     *
-     * @access private
-     * @param EE_Payment|bool $payment
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _post_payment_processing($payment = null)
-    {
-        // Off-Line payment?
-        if ($payment === true) {
-            //$this->_setup_redirect_for_next_step();
-            return true;
-            // On-Site payment?
-        } else if ($this->checkout->payment_method->is_on_site()) {
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
-                //$this->_setup_redirect_for_next_step();
-                $this->checkout->continue_reg = false;
-            }
-            // Off-Site payment?
-        } else if ($this->checkout->payment_method->is_off_site()) {
-            // if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
-            if ($payment instanceof EE_Payment && $payment->redirect_url()) {
-                do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
-                $this->checkout->redirect      = true;
-                $this->checkout->redirect_form = $payment->redirect_form();
-                $this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
-                // set JSON response
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
-                // and lastly, let's bump the payment status to pending
-                $payment->set_status(EEM_Payment::status_id_pending);
-                $payment->save();
-            } else {
-                // not a payment
-                $this->checkout->continue_reg = false;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            // ummm ya... not Off-Line, not On-Site, not off-Site ????
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    _process_payment_status
-     *
-     * @access private
-     * @type    EE_Payment $payment
-     * @param string       $payment_occurs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
-    {
-        // off-line payment? carry on
-        if ($payment_occurs === EE_PMT_Base::offline) {
-            return true;
-        }
-        // verify payment validity
-        if ($payment instanceof EE_Payment) {
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
-            $msg = $payment->gateway_response();
-            // check results
-            switch ($payment->status()) {
-                // good payment
-                case EEM_Payment::status_id_approved :
-                    EE_Error::add_success(
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return true;
-                    break;
-                // slow payment
-                case EEM_Payment::status_id_pending :
-                    if (empty($msg)) {
-                        $msg = esc_html__(
-                            'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return true;
-                    break;
-                // don't wanna payment
-                case EEM_Payment::status_id_cancelled :
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'Payment cancelled. Please try again.',
-                            'Payment cancelled. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                    break;
-                // not enough payment
-                case EEM_Payment::status_id_declined :
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'We\'re sorry but your payment was declined. Please try again.',
-                            'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                    break;
-                // bad payment
-                case EEM_Payment::status_id_failed :
-                    if (! empty($msg)) {
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        return false;
-                    }
-                    // default to error below
-                    break;
-            }
-        }
-        // off-site payment gateway responses are too unreliable, so let's just assume that
-        // the payment processing is just running slower than the registrant's request
-        if ($payment_occurs === EE_PMT_Base::offsite) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
-    /********************************************************************************************************/
-    /**
-     * process_gateway_response
-     * this is the return point for Off-Site Payment Methods
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
-     * otherwise, it will load up the last payment made for the TXN.
-     * If the payment retrieved looks good, it will then either:
-     *    complete the current step and allow advancement to the next reg step
-     *        or present the payment options again
-     *
-     * @access private
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public function process_gateway_response()
-    {
-        $payment = null;
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        if (! $this->checkout->payment_method->is_off_site()) {
-            return false;
-        }
-        $this->_validate_offsite_return();
-        // DEBUG LOG
-        //$this->checkout->log(
-        //	__CLASS__, __FUNCTION__, __LINE__,
-        //	array(
-        //		'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-        //		'payment_method' => $this->checkout->payment_method,
-        //	),
-        //	true
-        //);
-        // verify TXN
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
-                $this->checkout->continue_reg = false;
-                return false;
-            }
-            $payment = $this->_process_off_site_payment($gateway);
-            $payment = $this->_process_cancelled_payments($payment);
-            $payment = $this->_validate_payment($payment);
-            // if payment was not declined by the payment gateway or cancelled by the registrant
-            if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
-                //$this->_setup_redirect_for_next_step();
-                // store that for later
-                $this->checkout->payment = $payment;
-                // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
-                // because we will complete this step during the IPN processing then
-                if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
-                    $this->set_completed();
-                }
-                return true;
-            }
-        }
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
-        //	array( 'payment' => $payment )
-        //);
-        $this->checkout->continue_reg = false;
-        return false;
-    }
-
-
-    /**
-     * _validate_return
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    private function _validate_offsite_return()
-    {
-        $TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
-        if ($TXN_ID !== $this->checkout->transaction->ID()) {
-            // Houston... we might have a problem
-            $invalid_TXN = false;
-            // first gather some info
-            $valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $primary_registrant = $valid_TXN instanceof EE_Transaction
-                ? $valid_TXN->primary_registration()
-                : null;
-            // let's start by retrieving the cart for this TXN
-            $cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
-            if ($cart instanceof EE_Cart) {
-                // verify that the current cart has tickets
-                $tickets = $cart->get_tickets();
-                if (empty($tickets)) {
-                    $invalid_TXN = true;
-                }
-            } else {
-                $invalid_TXN = true;
-            }
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
-                ? $primary_registrant->session_ID()
-                : null;
-            // validate current Session ID and compare against valid TXN session ID
-            if (
-                $invalid_TXN // if this is already true, then skip other checks
-                || EE_Session::instance()->id() === null
-                || (
-                    // WARNING !!!
-                    // this could be PayPal sending back duplicate requests (ya they do that)
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
-                    // so now we need to determine if this current TXN looks valid or not
-                    // and whether this reg step has even been started ?
-                    EE_Session::instance()->id() === $valid_TXN_SID
-                    // really? you're half way through this reg step, but you never started it ?
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
-                )
-            ) {
-                $invalid_TXN = true;
-            }
-            if ($invalid_TXN) {
-                // is the valid TXN completed ?
-                if ($valid_TXN instanceof EE_Transaction) {
-                    // has this step even been started ?
-                    $reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
-                    if ($reg_step_completed !== false && $reg_step_completed !== true) {
-                        // so it **looks** like this is a double request from PayPal
-                        // so let's try to pick up where we left off
-                        $this->checkout->transaction = $valid_TXN;
-                        $this->checkout->refresh_all_entities(true);
-                        return;
-                    }
-                }
-                // you appear to be lost?
-                $this->_redirect_wayward_request($primary_registrant);
-            }
-        }
-    }
-
-
-    /**
-     * _redirect_wayward_request
-     *
-     * @access private
-     * @param \EE_Registration|null $primary_registrant
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _redirect_wayward_request(EE_Registration $primary_registrant)
-    {
-        if (! $primary_registrant instanceof EE_Registration) {
-            // try redirecting based on the current TXN
-            $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
-                ? $this->checkout->transaction->primary_registration()
-                : null;
-        }
-        if (! $primary_registrant instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // make sure transaction is not locked
-        $this->checkout->transaction->unlock();
-        wp_safe_redirect(
-            add_query_arg(
-                array(
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
-                ),
-                $this->checkout->thank_you_page_url
-            )
-        );
-        exit();
-    }
-
-
-    /**
-     * _process_off_site_payment
-     *
-     * @access private
-     * @param \EE_Offsite_Gateway $gateway
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
-    {
-        try {
-            $request_data = \EE_Registry::instance()->REQ->params();
-            // if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
-            $this->set_handle_IPN_in_this_request(
-                $gateway->handle_IPN_in_this_request($request_data, false)
-            );
-            if ($this->handle_IPN_in_this_request()) {
-                // get payment details and process results
-                /** @type EE_Payment_Processor $payment_processor */
-                $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                $payment           = $payment_processor->process_ipn(
-                    $request_data,
-                    $this->checkout->transaction,
-                    $this->checkout->payment_method,
-                    true,
-                    false
-                );
-                //$payment_source = 'process_ipn';
-            } else {
-                $payment = $this->checkout->transaction->last_payment();
-                //$payment_source = 'last_payment';
-            }
-        } catch (Exception $e) {
-            // let's just eat the exception and try to move on using any previously set payment info
-            $payment = $this->checkout->transaction->last_payment();
-            //$payment_source = 'last_payment after Exception';
-            // but if we STILL don't have a payment object
-            if (! $payment instanceof EE_Payment) {
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
-                $this->_handle_payment_processor_exception($e);
-            }
-        }
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
-        //	array(
-        //		'process_ipn_payment' => $payment,
-        //		'payment_source'      => $payment_source,
-        //	)
-        //);
-        return $payment;
-    }
-
-
-    /**
-     * _process_cancelled_payments
-     * just makes sure that the payment status gets updated correctly
-     * so tha tan error isn't generated during payment validation
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment | FALSE
-     * @throws \EE_Error
-     */
-    private function _process_cancelled_payments($payment = null)
-    {
-        if (
-            $payment instanceof EE_Payment
-            && isset($_REQUEST['ee_cancel_payment'])
-            && $payment->status() === EEM_Payment::status_id_failed
-        ) {
-            $payment->set_status(EEM_Payment::status_id_cancelled);
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    get_transaction_details_for_gateways
-     *
-     * @access    public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_transaction_details_for_gateways()
-    {
-        $txn_details = array();
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $txn_details = array(
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
-            );
-        }
-        // get EE_Payment_Method object
-        if (
-            empty($txn_details)
-            &&
-            ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
-        ) {
-            $txn_details = array(
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                'error'                      => esc_html__(
-                    'A valid Payment Method could not be determined.',
-                    'event_espresso'
-                ),
-            );
-        }
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
-            $return_url  = $this->_get_return_url($this->checkout->payment_method);
-            $txn_details = array(
-                'TXN_ID'         => $this->checkout->transaction->ID(),
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
-                'TXN_total'      => $this->checkout->transaction->total(),
-                'TXN_paid'       => $this->checkout->transaction->paid(),
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
-                'payment_amount' => $this->checkout->amount_owing,
-                'return_url'     => $return_url,
-                'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
-                    array(
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
-                    )
-                ),
-            );
-        }
-        echo wp_json_encode($txn_details);
-        exit();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
-    }
+	/**
+	 * @access protected
+	 * @var EE_Line_Item_Display $Line_Item_Display
+	 */
+	protected $line_item_display;
+
+	/**
+	 * @access protected
+	 * @var boolean $handle_IPN_in_this_request
+	 */
+	protected $handle_IPN_in_this_request = false;
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_filter(
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
+		);
+		add_action(
+			'wp_ajax_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action(
+			'wp_ajax_nopriv_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
+		add_action(
+			'wp_ajax_nopriv_save_payer_details',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
+		);
+		add_action(
+			'wp_ajax_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_action(
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_filter(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 *    ajax switch_spco_billing_form
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function switch_spco_billing_form()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
+	}
+
+
+	/**
+	 *    ajax save_payer_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function save_payer_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
+	}
+
+
+	/**
+	 *    ajax get_transaction_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function get_transaction_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
+	}
+
+
+	/**
+	 * bypass_recaptcha_for_load_payment_method
+	 *
+	 * @access public
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function bypass_recaptcha_for_load_payment_method()
+	{
+		return array(
+			'EESID'  => EE_Registry::instance()->SSN->id(),
+			'step'   => 'payment_options',
+			'action' => 'spco_billing_form',
+		);
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug     = 'payment_options';
+		$this->_name     = esc_html__('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+		$this->checkout  = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__(
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @return null
+	 */
+	public function line_item_display()
+	{
+		return $this->line_item_display;
+	}
+
+
+	/**
+	 * @param null $line_item_display
+	 */
+	public function set_line_item_display($line_item_display)
+	{
+		$this->line_item_display = $line_item_display;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request()
+	{
+		return $this->handle_IPN_in_this_request;
+	}
+
+
+	/**
+	 * @param boolean $handle_IPN_in_this_request
+	 */
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
+	{
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * translate_js_strings
+	 *
+	 * @return void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+			'Please select a method of payment in order to continue.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+			'Forwarding to Secure Payment Provider.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * enqueue_styles_and_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		$transaction = $this->checkout->transaction;
+		//if the transaction isn't set or nothing is owed on it, don't enqueue any JS
+		if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
+			return;
+		}
+		foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
+			$type_obj = $payment_method->type_obj();
+			if ($type_obj instanceof EE_PMT_Base) {
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
+				if ($billing_form instanceof EE_Form_Section_Proper) {
+					$billing_form->enqueue_js();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * initialize_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function initialize_reg_step()
+	{
+		// TODO: if /when we implement donations, then this will need overriding
+		if (// don't need payment options for:
+			// 	registrations made via the admin
+			// 	completed transactions
+			// 	overpaid transactions
+			// 	$ 0.00 transactions (no payment required)
+			! $this->checkout->payment_required()
+			// but do NOT remove if current action being called belongs to this reg step
+			&& ! is_callable(array($this, $this->checkout->action))
+			&& ! $this->completed()
+		) {
+			// and if so, then we no longer need the Payment Options step
+			if ($this->is_current_step()) {
+				$this->checkout->generate_reg_form = false;
+			}
+			$this->checkout->remove_reg_step($this->_slug);
+			// DEBUG LOG
+			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		// get all active payment methods
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function generate_reg_form()
+	{
+		// reset in case someone changes their mind
+		$this->_reset_selected_method_of_payment();
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'payments_closed';
+		$registrations_requiring_payment            = array();
+		$registrations_for_free_events              = array();
+		$registrations_requiring_pre_approval       = array();
+		$sold_out_events                            = array();
+		$insufficient_spaces_available              = array();
+		$no_payment_required                        = true;
+		// loop thru registrations to gather info
+		$registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			$this->checkout->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			/** @var $registration EE_Registration */
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[ $REG_ID ])) {
+				if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
+					$sold_out_events[ $registration->event()->ID() ] = $registration->event();
+				} else {
+					$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+				}
+				continue;
+			}
+			// event requires admin approval
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
+				// add event to list of events with pre-approval reg status
+				$registrations_requiring_pre_approval[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			if ($this->checkout->revisit
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+				&& (
+					$registration->event()->is_sold_out()
+					|| $registration->event()->is_sold_out(true)
+				)
+			) {
+				// add event to list of events that are sold out
+				$sold_out_events[$registration->event()->ID()] = $registration->event();
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			// are they allowed to pay now and is there monies owing?
+			if ($registration->owes_monies_and_can_pay()) {
+				$registrations_requiring_payment[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
+					$registration->event(),
+					$this
+				);
+			} elseif (! $this->checkout->revisit
+				&& $registration->status_ID() !== EEM_Registration::status_id_not_approved
+				&& $registration->ticket()->is_free()
+			) {
+				$registrations_for_free_events[$registration->event()->ID()] = $registration;
+			}
+		}
+		$subsections = array();
+		// now decide which template to load
+		if (! empty($sold_out_events)) {
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
+		}
+		if (! empty($insufficient_spaces_available)) {
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
+				$insufficient_spaces_available
+			);
+		}
+		if (! empty($registrations_requiring_pre_approval)) {
+			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
+				$registrations_requiring_pre_approval
+			);
+		}
+		if (! empty($registrations_for_free_events)) {
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
+		}
+		if (! empty($registrations_requiring_payment)) {
+			if ($this->checkout->amount_owing > 0) {
+				// autoload Line_Item_Display classes
+				EEH_Autoloader::register_line_item_filter_autoloaders();
+				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
+					apply_filters(
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+						new EE_Line_Item_Filter_Collection()
+					),
+					$this->checkout->cart->get_grand_total()
+				);
+				/** @var EE_Line_Item $filtered_line_item_tree */
+				$filtered_line_item_tree = $line_item_filter_processor->process();
+				EEH_Autoloader::register_line_item_display_autoloaders();
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
+				$subsections['payment_options'] = $this->_display_payment_options(
+					$this->line_item_display->display_line_item(
+						$filtered_line_item_tree,
+						array('registrations' => $registrations)
+					)
+				);
+				$this->checkout->amount_owing   = $filtered_line_item_tree->total();
+				$this->_apply_registration_payments_to_amount_owing($registrations);
+			}
+			$no_payment_required = false;
+		} else {
+			$this->_hide_reg_step_submit_button_if_revisit();
+		}
+		$this->_save_selected_method_of_payment();
+
+		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
+		$subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
+
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => new EE_No_Layout(),
+			)
+		);
+	}
+
+
+	/**
+	 * add line item filters required for this reg step
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
+	 *        filter collection by passing that instead of instantiating a new collection
+	 *
+	 * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
+	 * @return EE_Line_Item_Filter_Collection
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
+	{
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
+			return $line_item_filter_collection;
+		}
+		$line_item_filter_collection->add(
+			new EE_Billable_Line_Item_Filter(
+				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
+					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+					)
+				)
+			)
+		);
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
+		return $line_item_filter_collection;
+	}
+
+
+	/**
+	 * remove_ejected_registrations
+	 * if a registrant has lost their potential space at an event due to lack of payment,
+	 * then this method removes them from the list of registrations being paid for during this request
+	 *
+	 * @param \EE_Registration[] $registrations
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function remove_ejected_registrations(array $registrations)
+	{
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			EE_Registry::instance()->SSN->checkout()->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[$REG_ID])) {
+				unset($registrations[$REG_ID]);
+				continue;
+			}
+		}
+		return $registrations;
+	}
+
+
+	/**
+	 * find_registrations_that_lost_their_space
+	 * If a registrant chooses an offline payment method like Invoice,
+	 * then no space is reserved for them at the event until they fully pay fo that site
+	 * (unless the event's default reg status is set to APPROVED)
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
+	 *
+	 * @param \EE_Registration[] $registrations
+	 * @param bool               $revisit
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
+	{
+		// registrations per event
+		$event_reg_count = array();
+		// spaces left per event
+		$event_spaces_remaining = array();
+		// tickets left sorted by ID
+		$tickets_remaining = array();
+		// registrations that have lost their space
+		$ejected_registrations = array();
+		foreach ($registrations as $REG_ID => $registration) {
+			if ($registration->status_ID() === EEM_Registration::status_id_approved
+				|| apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
+					false,
+					$registration,
+					$revisit
+				)
+			) {
+				continue;
+			}
+			$EVT_ID = $registration->event_ID();
+			$ticket = $registration->ticket();
+			if (! isset($tickets_remaining[$ticket->ID()])) {
+				$tickets_remaining[$ticket->ID()] = $ticket->remaining();
+			}
+			if ($tickets_remaining[$ticket->ID()] > 0) {
+				if (! isset($event_reg_count[$EVT_ID])) {
+					$event_reg_count[$EVT_ID] = 0;
+				}
+				$event_reg_count[$EVT_ID]++;
+				if (! isset($event_spaces_remaining[$EVT_ID])) {
+					$event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
+				}
+			}
+			if ($revisit
+				&& ($tickets_remaining[$ticket->ID()] === 0
+					|| $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
+				)
+			) {
+				$ejected_registrations[$REG_ID] = $registration->event();
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
+					/** @type EE_Registration_Processor $registration_processor */
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+					// at this point, we should have enough details about the registrant to consider the registration
+					// NOT incomplete
+					$registration_processor->manually_update_registration_status(
+						$registration,
+						EEM_Registration::status_id_wait_list
+					);
+				}
+			}
+		}
+		return $ejected_registrations;
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _adjust_registration_status_if_event_old_sold()
+	{
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _hide_reg_step_submit_button_if_revisit()
+	{
+		if ($this->checkout->revisit) {
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
+		}
+	}
+
+
+	/**
+	 * sold_out_events
+	 * displays notices regarding events that have sold out since hte registrant first signed up
+	 *
+	 * @param \EE_Event[] $sold_out_events_array
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _sold_out_events($sold_out_events_array = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'events_sold_out';
+		$sold_out_events                            = '';
+		foreach ($sold_out_events_array as $sold_out_event) {
+			$sold_out_events .= EEH_HTML::li(
+				EEH_HTML::span(
+					'  ' . $sold_out_event->name(),
+					'',
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
+				)
+			);
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'sold_out_events'     => $sold_out_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
+									sprintf(
+										esc_html__(
+											'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
+											'event_espresso'
+										),
+										'<strong>',
+										'</strong>',
+										'<br />'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _insufficient_spaces_available
+	 * displays notices regarding events that do not have enough remaining spaces
+	 * to satisfy the current number of registrations looking to pay
+	 *
+	 * @param \EE_Event[] $insufficient_spaces_events_array
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'invoice';
+		$insufficient_space_events                  = '';
+		foreach ($insufficient_spaces_events_array as $event) {
+			if ($event instanceof EE_Event) {
+				$insufficient_space_events .= EEH_HTML::li(
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => array(
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
+				),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
+							array(
+								'sold_out_events'     => $insufficient_space_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
+									esc_html__(
+										'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
+										'event_espresso'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * registrations_requiring_pre_approval
+	 *
+	 * @param array $registrations_requiring_pre_approval
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
+	{
+		$events_requiring_pre_approval = '';
+		foreach ($registrations_requiring_pre_approval as $registration) {
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
+				$events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
+					EEH_HTML::span(
+						'',
+						'',
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
+					)
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'events_requiring_pre_approval.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
+								'events_requiring_pre_approval_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
+									esc_html__(
+										'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
+										'event_espresso'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _no_payment_required
+	 *
+	 * @param \EE_Event[] $registrations_for_free_events
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _no_payment_required($registrations_for_free_events = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
+		// generate no_payment_required form
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'no_payment_required.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
+							array(
+								'revisit'                       => $this->checkout->revisit,
+								'registrations'                 => array(),
+								'ticket_count'                  => array(),
+								'registrations_for_free_events' => $registrations_for_free_events,
+								'no_payment_required_msg'       => EEH_HTML::p(
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _display_payment_options
+	 *
+	 * @param string $transaction_details
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _display_payment_options($transaction_details = '')
+	{
+		// has method_of_payment been set by no-js user?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
+		// build payment options form
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
+			new EE_Form_Section_Proper(
+				array(
+					'subsections'     => array(
+						'before_payment_options' => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
+							new EE_Form_Section_Proper(
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
+							)
+						),
+						'payment_options'        => $this->_setup_payment_options(),
+						'after_payment_options'  => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
+							new EE_Form_Section_Proper(
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
+							)
+						),
+					),
+					'layout_strategy' => new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template,
+							'template_args'        => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
+								array(
+									'reg_count'                 => $this->line_item_display->total_items(),
+									'transaction_details'       => $transaction_details,
+									'available_payment_methods' => array(),
+								)
+							),
+						)
+					),
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _extra_hidden_inputs
+	 *
+	 * @param bool $no_payment_required
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _extra_hidden_inputs($no_payment_required = true)
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'spco_no_payment_required' => new EE_Hidden_Input(
+						array(
+							'normalization_strategy' => new EE_Boolean_Normalization(),
+							'html_name'              => 'spco_no_payment_required',
+							'html_id'                => 'spco-no-payment-required-payment_options',
+							'default'                => $no_payment_required,
+						)
+					),
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
+						array(
+							'normalization_strategy' => new EE_Int_Normalization(),
+							'html_name'              => 'spco_transaction_id',
+							'html_id'                => 'spco-transaction-id',
+							'default'                => $this->checkout->transaction->ID(),
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 *    _apply_registration_payments_to_amount_owing
+	 *
+	 * @access protected
+	 * @param array $registrations
+	 * @throws EE_Error
+	 */
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
+	{
+		$payments = array();
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
+				$payments += $registration->registration_payments();
+			}
+		}
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Registration_Payment) {
+					$this->checkout->amount_owing -= $payment->amount();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    _reset_selected_method_of_payment
+	 *
+	 * @access    private
+	 * @param    bool $force_reset
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _reset_selected_method_of_payment($force_reset = false)
+	{
+		$reset_payment_method = $force_reset
+			? true
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
+		if ($reset_payment_method) {
+			$this->checkout->selected_method_of_payment = null;
+			$this->checkout->payment_method             = null;
+			$this->checkout->billing_form               = null;
+			$this->_save_selected_method_of_payment();
+		}
+	}
+
+
+	/**
+	 * _save_selected_method_of_payment
+	 * stores the selected_method_of_payment in the session
+	 * so that it's available for all subsequent requests including AJAX
+	 *
+	 * @access        private
+	 * @param string $selected_method_of_payment
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _save_selected_method_of_payment($selected_method_of_payment = '')
+	{
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
+			? $selected_method_of_payment
+			: $this->checkout->selected_method_of_payment;
+		EE_Registry::instance()->SSN->set_session_data(
+			array('selected_method_of_payment' => $selected_method_of_payment)
+		);
+	}
+
+
+	/**
+	 * _setup_payment_options
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function _setup_payment_options()
+	{
+		// load payment method classes
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
+		if (empty($this->checkout->available_payment_methods)) {
+			EE_Error::add_error(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
+					sprintf(
+						esc_html__(
+							'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
+							'event_espresso'
+						),
+						'<br>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// switch up header depending on number of available payment methods
+		$payment_method_header     = count($this->checkout->available_payment_methods) > 1
+			? apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
+			)
+			: apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Method of Payment', 'event_espresso')
+			);
+		$available_payment_methods = array(
+			// display the "Payment Method" header
+			'payment_method_header' => new EE_Form_Section_HTML(
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
+			),
+		);
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
+		$available_payment_method_options = array();
+		$default_payment_method_option    = array();
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
+		$payment_methods_billing_info = array(
+			new EE_Form_Section_HTML(
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
+			),
+		);
+		// loop through payment methods
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$payment_method_button = EEH_HTML::img(
+					$payment_method->button_url(),
+					$payment_method->name(),
+					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+					'spco-payment-method-btn-img'
+				);
+				// check if any payment methods are set as default
+				// if payment method is already selected OR nothing is selected and this payment method should be
+				// open_by_default
+				if (($this->checkout->selected_method_of_payment === $payment_method->slug())
+					|| (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
+				) {
+					$this->checkout->selected_method_of_payment = $payment_method->slug();
+					$this->_save_selected_method_of_payment();
+					$default_payment_method_option[$payment_method->slug()] = $payment_method_button;
+				} else {
+					$available_payment_method_options[$payment_method->slug()] = $payment_method_button;
+				}
+				$payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
+					$payment_method
+				);
+			}
+		}
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
+		// of PMs
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
+		// now generate the actual form  inputs
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
+			$available_payment_method_options
+		);
+		$available_payment_methods                              += $payment_methods_billing_info;
+		// build the available payment methods form
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'spco-available-methods-of-payment-dv',
+				'subsections'     => $available_payment_methods,
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+			)
+		);
+	}
+
+
+	/**
+	 * _get_available_payment_methods
+	 *
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_available_payment_methods()
+	{
+		if (! empty($this->checkout->available_payment_methods)) {
+			return $this->checkout->available_payment_methods;
+		}
+		$available_payment_methods = array();
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		/** @type EEM_Payment_Method $EEM_Payment_Method */
+		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+		// get all active payment methods
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$available_payment_methods[$payment_method->slug()] = $payment_method;
+			}
+		}
+		return $available_payment_methods;
+	}
+
+
+	/**
+	 *    _available_payment_method_inputs
+	 *
+	 * @access    private
+	 * @param    array $available_payment_method_options
+	 * @return    \EE_Form_Section_Proper
+	 */
+	private function _available_payment_method_inputs($available_payment_method_options = array())
+	{
+		// generate inputs
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-available-payment-method-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'' => new EE_Radio_Button_Input(
+						$available_payment_method_options,
+						array(
+							'html_name'          => 'selected_method_of_payment',
+							'html_class'         => 'spco-payment-method',
+							'default'            => $this->checkout->selected_method_of_payment,
+							'label_size'         => 11,
+							'enforce_label_size' => true,
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 *    _payment_method_billing_info
+	 *
+	 * @access    private
+	 * @param    EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
+	{
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
+			? true
+			: false;
+		// generate the billing form for payment method
+		$billing_form                 = $currently_selected
+			? $this->_get_billing_form_for_payment_method($payment_method)
+			: new EE_Form_Section_HTML();
+		$this->checkout->billing_form = $currently_selected
+			? $billing_form
+			: $this->checkout->billing_form;
+		// it's all in the details
+		$info_html = EEH_HTML::h3(
+			esc_html__('Important information regarding your payment', 'event_espresso'),
+			'',
+			'spco-payment-method-hdr'
+		);
+		// add some info regarding the step, either from what's saved in the admin,
+		// or a default string depending on whether the PM has a billing form or not
+		if ($payment_method->description()) {
+			$payment_method_info = $payment_method->description();
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
+			$payment_method_info = sprintf(
+				esc_html__(
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
+					'event_espresso'
+				),
+				$this->submit_button_text()
+			);
+		} else {
+			$payment_method_info = sprintf(
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
+				$this->submit_button_text()
+			);
+		}
+		$info_html .= EEH_HTML::p(
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
+				$payment_method_info
+			),
+			'',
+			'spco-payment-method-desc ee-attention'
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+				'html_class'      => 'spco-payment-method-info-dv',
+				// only display the selected or default PM
+				'html_style'      => $currently_selected ? '' : 'display:none;',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'info'         => new EE_Form_Section_HTML($info_html),
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * get_billing_form_html_for_payment_method
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_billing_form_html_for_payment_method()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		$this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			return false;
+		}
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+			false
+		)) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// now generate billing form for selected method of payment
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
+		// fill form with attendee info if applicable
+		if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& $this->checkout->transaction_has_primary_registrant()
+		) {
+			$payment_method_billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if ($payment_method_billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$payment_method_billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$payment_method_billing_form
+				);
+		}
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
+			? $payment_method_billing_form->get_html()
+			: '';
+		$this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
+		// localize validation rules for main form
+		$this->checkout->current_step->reg_form->localize_validation_rules();
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		return true;
+	}
+
+
+	/**
+	 * _get_billing_form_for_payment_method
+	 *
+	 * @access private
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
+	{
+		$billing_form = $payment_method->type_obj()->billing_form(
+			$this->checkout->transaction,
+			array('amount_owing' => $this->checkout->amount_owing)
+		);
+		if ($billing_form instanceof EE_Billing_Info_Form) {
+			if (apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+				false
+			)
+				&& EE_Registry::instance()->REQ->is_set('payment_method')
+			) {
+				EE_Error::add_success(
+					apply_filters(
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+						sprintf(
+							esc_html__(
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
+								'event_espresso'
+							),
+							$payment_method->name()
+						)
+					)
+				);
+			}
+			return apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+				$billing_form,
+				$payment_method
+			);
+		}
+		// no actual billing form, so return empty HTML form section
+		return new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _get_selected_method_of_payment
+	 *
+	 * @access private
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
+	 *                          is not found in the incoming request
+	 * @param string  $request_param
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_selected_method_of_payment(
+		$required = false,
+		$request_param = 'selected_method_of_payment'
+	) {
+		// is selected_method_of_payment set in the request ?
+		$selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
+		if ($selected_method_of_payment) {
+			// sanitize it
+			$selected_method_of_payment = is_array($selected_method_of_payment)
+				? array_shift($selected_method_of_payment)
+				: $selected_method_of_payment;
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
+			// store it in the session so that it's available for all subsequent requests including AJAX
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
+		} else {
+			// or is is set in the session ?
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
+				'selected_method_of_payment'
+			);
+		}
+		// do ya really really gotta have it?
+		if (empty($selected_method_of_payment) && $required) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $selected_method_of_payment;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
+	/********************************************************************************************************/
+	/**
+	 * switch_payment_method
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function switch_payment_method()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return false;
+		}
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+			false
+		)) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// fill form with attendee info if applicable
+		if (apply_filters(
+			'FHEE__populate_billing_form_fields_from_attendee',
+			(
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $this->checkout->transaction_has_primary_registrant()
+			),
+			$this->checkout->billing_form,
+			$this->checkout->transaction
+		)
+		) {
+			$this->checkout->billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$this->checkout->billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$this->checkout->billing_form
+				);
+		}
+		// get html and validation rules for form
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->json_response->set_return_data(
+				array('payment_method_info' => $this->checkout->billing_form->get_html())
+			);
+			// localize validation rules for main form
+			$this->checkout->billing_form->localize_validation_rules(true);
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		} else {
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
+		}
+		//prevents advancement to next step
+		$this->checkout->continue_reg = false;
+		return true;
+	}
+
+
+	/**
+	 * _verify_payment_method_is_set
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _verify_payment_method_is_set()
+	{
+		// generate billing form for selected method of payment if it hasn't been done already
+		if (empty($this->checkout->selected_method_of_payment)) {
+			// how have they chosen to pay?
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		} else {
+			// choose your own adventure based on method_of_payment
+			switch ($this->checkout->selected_method_of_payment) {
+				case 'events_sold_out' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				case 'payments_closed' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				case 'no_payment_required' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				default:
+			}
+		}
+		// verify payment method
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			// get payment method for selected method of payment
+			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
+		}
+		return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
+	}
+
+
+
+	/********************************************************************************************************/
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * save_payer_details_via_ajax
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function save_payer_details_via_ajax()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return;
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// generate primary attendee from payer info if applicable
+		if (! $this->checkout->transaction_has_primary_registrant()) {
+			$attendee = $this->_create_attendee_from_request_data();
+			if ($attendee instanceof EE_Attendee) {
+				foreach ($this->checkout->transaction->registrations() as $registration) {
+					if ($registration->is_primary_registrant()) {
+						$this->checkout->primary_attendee_obj = $attendee;
+						$registration->_add_relation_to($attendee, 'Attendee');
+						$registration->set_attendee_id($attendee->ID());
+						$registration->update_cache_after_object_save('Attendee', $attendee);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * create_attendee_from_request_data
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _create_attendee_from_request_data()
+	{
+		// get State ID
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
+		if (! empty($STA_ID)) {
+			// can we get state object from name ?
+			EE_Registry::instance()->load_model('State');
+			$state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
+		}
+		// get Country ISO
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
+		if (! empty($CNT_ISO)) {
+			// can we get country object from name ?
+			EE_Registry::instance()->load_model('Country');
+			$country = EEM_Country::instance()->get_col(
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
+				'CNT_ISO'
+			);
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
+		}
+		// grab attendee data
+		$attendee_data = array(
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
+			'STA_ID'       => $STA_ID,
+			'CNT_ISO'      => $CNT_ISO,
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
+		);
+		// validate the email address since it is the most important piece of info
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
+			EE_Error::add_error(
+				esc_html__('An invalid email address was submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// does this attendee already exist in the db ? we're searching using a combination of first name, last name,
+		// AND email address
+		if (! empty($attendee_data['ATT_fname'])
+			&& ! empty($attendee_data['ATT_lname'])
+			&& ! empty($attendee_data['ATT_email'])
+		) {
+			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
+				array(
+					'ATT_fname' => $attendee_data['ATT_fname'],
+					'ATT_lname' => $attendee_data['ATT_lname'],
+					'ATT_email' => $attendee_data['ATT_email'],
+				)
+			);
+			if ($existing_attendee instanceof EE_Attendee) {
+				return $existing_attendee;
+			}
+		}
+		// no existing attendee? kk let's create a new one
+		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those
+		// don't exist
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
+			? $attendee_data['ATT_fname']
+			: $attendee_data['ATT_email'];
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
+			? $attendee_data['ATT_lname']
+			: $attendee_data['ATT_email'];
+		return EE_Attendee::new_instance($attendee_data);
+	}
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  *****************************************/
+	/********************************************************************************************************/
+	/**
+	 * process_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function process_reg_step()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
+			? 'no_payment_required'
+			: $this->_get_selected_method_of_payment(true);
+		// choose your own adventure based on method_of_payment
+		switch ($this->checkout->selected_method_of_payment) {
+
+			case 'events_sold_out' :
+				$this->checkout->redirect     = true;
+				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+				// mark this reg step as completed
+				$this->set_completed();
+				return false;
+				break;
+
+			case 'payments_closed' :
+				if (apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
+					false
+				)) {
+					EE_Error::add_success(
+						esc_html__('no payment required at this time.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+				break;
+
+			case 'no_payment_required' :
+				if (apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
+					false
+				)) {
+					EE_Error::add_success(
+						esc_html__('no payment required.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+				break;
+
+			default:
+				$registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+				);
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+					$registrations,
+					EE_Registry::instance()->SSN->checkout()->revisit
+				);
+				// calculate difference between the two arrays
+				$registrations = array_diff($registrations, $ejected_registrations);
+				if (empty($registrations)) {
+					$this->_redirect_because_event_sold_out();
+					return false;
+				}
+				$payment_successful = $this->_process_payment();
+				if ($payment_successful) {
+					$this->checkout->continue_reg = true;
+					$this->_maybe_set_completed($this->checkout->payment_method);
+				} else {
+					$this->checkout->continue_reg = false;
+				}
+				return $payment_successful;
+		}
+	}
+
+
+	/**
+	 * _redirect_because_event_sold_out
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _redirect_because_event_sold_out()
+	{
+		$this->checkout->continue_reg = false;
+		// set redirect URL
+		$this->checkout->redirect_url = add_query_arg(
+			array('e_reg_url_link' => $this->checkout->reg_url_link),
+			$this->checkout->current_step->reg_step_url()
+		);
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+	}
+
+
+	/**
+	 * _maybe_set_completed
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method)
+	{
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite :
+				break;
+			case EE_PMT_Base::onsite :
+			case EE_PMT_Base::offline :
+				// mark this reg step as completed
+				$this->set_completed();
+				break;
+		}
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to retry a payment
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function update_reg_step()
+	{
+		$success = true;
+		// if payment required
+		if ($this->checkout->transaction->total() > 0) {
+			do_action(
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
+				$this->checkout->transaction
+			);
+			// attempt payment via payment method
+			$success = $this->process_reg_step();
+		}
+		if ($success && ! $this->checkout->redirect) {
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
+				$this->checkout->transaction->ID()
+			);
+			// set return URL
+			$this->checkout->redirect_url = add_query_arg(
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
+				$this->checkout->thank_you_page_url
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *    _process_payment
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_payment()
+	{
+		// basically confirm that the event hasn't sold out since they hit the page
+		if (! $this->_last_second_ticket_verifications()) {
+			return false;
+		}
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$this->checkout->json_response->set_plz_select_method_of_payment(
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
+			);
+			return false;
+		}
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			return false;
+		}
+		// setup billing form
+		if ($this->checkout->payment_method->is_on_site()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+			// bad billing form ?
+			if (! $this->_billing_form_is_valid()) {
+				return false;
+			}
+		}
+		// ensure primary registrant has been fully processed
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
+			return false;
+		}
+		// if session is close to expiring (under 10 minutes by default)
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
+			// add some time to session expiration so that payment can be completed
+			EE_Registry::instance()->SSN->extend_expiration();
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		//$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
+		// for events with a default reg status of Approved
+		// $transaction_processor->toggle_registration_statuses_for_default_approved_events(
+		//      $this->checkout->transaction, $this->checkout->reg_cache_where_params
+		// );
+		// attempt payment
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
+		// process results
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
+		// verify payment
+		if ($payment instanceof EE_Payment) {
+			// store that for later
+			$this->checkout->payment = $payment;
+			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
+			$this->checkout->transaction->toggle_failed_transaction_status();
+			$payment_status = $payment->status();
+			if (
+				$payment_status === EEM_Payment::status_id_approved
+				|| $payment_status === EEM_Payment::status_id_pending
+			) {
+				return true;
+			} else {
+				return false;
+			}
+		} else if ($payment === true) {
+			// please note that offline payment methods will NOT make a payment,
+			// but instead just mark themselves as the PMD_ID on the transaction, and return true
+			$this->checkout->payment = $payment;
+			return true;
+		}
+		// where's my money?
+		return false;
+	}
+
+
+	/**
+	 * _last_second_ticket_verifications
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _last_second_ticket_verifications()
+	{
+		// don't bother re-validating if not a return visit
+		if (! $this->checkout->revisit) {
+			return true;
+		}
+		$registrations = $this->checkout->transaction->registrations();
+		if (empty($registrations)) {
+			return false;
+		}
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
+				$event = $registration->event_obj();
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
+					EE_Error::add_error(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
+							sprintf(
+								esc_html__(
+									'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
+									'event_espresso'
+								),
+								$event->name()
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * redirect_form
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function redirect_form()
+	{
+		$payment_method_billing_info = $this->_payment_method_billing_info(
+			$this->_get_payment_method_for_selected_method_of_payment()
+		);
+		$html                        = $payment_method_billing_info->get_html();
+		$html                        .= $this->checkout->redirect_form;
+		EE_Registry::instance()->REQ->add_output($html);
+		return true;
+	}
+
+
+	/**
+	 * _billing_form_is_valid
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	private function _billing_form_is_valid()
+	{
+		if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
+			return true;
+		}
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
+			if ($this->checkout->billing_form->was_submitted()) {
+				$this->checkout->billing_form->receive_form_submission();
+				if ($this->checkout->billing_form->is_valid()) {
+					return true;
+				}
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
+				$error_strings     = array();
+				foreach ($validation_errors as $validation_error) {
+					if ($validation_error instanceof EE_Validation_Error) {
+						$form_section = $validation_error->get_form_section();
+						if ($form_section instanceof EE_Form_Input_Base) {
+							$label = $form_section->html_label_text();
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
+							$label = $form_section->name();
+						} else {
+							$label = esc_html__('Validation Error', 'event_espresso');
+						}
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
+					}
+				}
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
+							'event_espresso'
+						),
+						'<br/>',
+						implode('<br/>', $error_strings)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'The billing form was not submitted or something prevented it\'s submission.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * _setup_primary_registrant_prior_to_payment
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
+	 * yet)
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _setup_primary_registrant_prior_to_payment()
+	{
+		// check if transaction has a primary registrant and that it has a related Attendee object
+		// if not, then we need to at least gather some primary registrant data before attempting payment
+		if (
+			$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& ! $this->checkout->transaction_has_primary_registrant()
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
+		) {
+			return false;
+		}
+		// because saving an object clears it's cache, we need to do the chevy shuffle
+		// grab the primary_registration object
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		// at this point we'll consider a TXN to not have been failed
+		$this->checkout->transaction->toggle_failed_transaction_status();
+		// save the TXN ( which clears cached copy of primary_registration)
+		$this->checkout->transaction->save();
+		// grab TXN ID and save it to the primary_registration
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
+		// save what we have so far
+		$primary_registration->save();
+		return true;
+	}
+
+
+	/**
+	 * _capture_primary_registration_data_from_billing_form
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _capture_primary_registration_data_from_billing_form()
+	{
+		// convert billing form data into an attendee
+		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
+		if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		if (! $primary_registration instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+			  instanceof
+			  EE_Attendee
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
+		return true;
+	}
+
+
+	/**
+	 * _get_payment_method_for_selected_method_of_payment
+	 * retrieves a valid payment method
+	 *
+	 * @access public
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_payment_method_for_selected_method_of_payment()
+	{
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
+			$this->_redirect_because_event_sold_out();
+			return null;
+		}
+		// get EE_Payment_Method object
+		if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
+			$payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
+		} else {
+			// load EEM_Payment_Method
+			EE_Registry::instance()->load_model('Payment_Method');
+			/** @type EEM_Payment_Method $EEM_Payment_Method */
+			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+			$payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
+		}
+		// verify $payment_method
+		if (! $payment_method instanceof EE_Payment_Method) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// and verify it has a valid Payment_Method Type object
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 *    _attempt_payment
+	 *
+	 * @access    private
+	 * @type    EE_Payment_Method $payment_method
+	 * @return mixed EE_Payment | boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _attempt_payment(EE_Payment_Method $payment_method)
+	{
+		$payment = null;
+		$this->checkout->transaction->save();
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		if (! $payment_processor instanceof EE_Payment_Processor) {
+			return false;
+		}
+		try {
+			$payment_processor->set_revisit($this->checkout->revisit);
+			// generate payment object
+			$payment = $payment_processor->process_payment(
+				$payment_method,
+				$this->checkout->transaction,
+				$this->checkout->amount_owing,
+				$this->checkout->billing_form,
+				$this->_get_return_url($payment_method),
+				'CART',
+				$this->checkout->admin_request,
+				true,
+				$this->reg_step_url()
+			);
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _handle_payment_processor_exception
+	 *
+	 * @access protected
+	 * @param \Exception $e
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _handle_payment_processor_exception(Exception $e)
+	{
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
+				$e->getMessage(),
+				$e->getFile(),
+				$e->getLine()
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * _get_return_url
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_return_url(EE_Payment_Method $payment_method)
+	{
+		$return_url = '';
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite :
+				$return_url = add_query_arg(
+					array(
+						'action'                     => 'process_gateway_response',
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+						'spco_txn'                   => $this->checkout->transaction->ID(),
+					),
+					$this->reg_step_url()
+				);
+				break;
+			case EE_PMT_Base::onsite :
+			case EE_PMT_Base::offline :
+				$return_url = $this->checkout->next_step->reg_step_url();
+				break;
+		}
+		return $return_url;
+	}
+
+
+	/**
+	 * _validate_payment
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _validate_payment($payment = null)
+	{
+		if ($this->checkout->payment_method->is_off_line()) {
+			return true;
+		}
+		// verify payment object
+		if (! $payment instanceof EE_Payment) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _post_payment_processing
+	 *
+	 * @access private
+	 * @param EE_Payment|bool $payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _post_payment_processing($payment = null)
+	{
+		// Off-Line payment?
+		if ($payment === true) {
+			//$this->_setup_redirect_for_next_step();
+			return true;
+			// On-Site payment?
+		} else if ($this->checkout->payment_method->is_on_site()) {
+			if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+				//$this->_setup_redirect_for_next_step();
+				$this->checkout->continue_reg = false;
+			}
+			// Off-Site payment?
+		} else if ($this->checkout->payment_method->is_off_site()) {
+			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
+			if ($payment instanceof EE_Payment && $payment->redirect_url()) {
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
+				$this->checkout->redirect      = true;
+				$this->checkout->redirect_form = $payment->redirect_form();
+				$this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
+				// set JSON response
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
+				// and lastly, let's bump the payment status to pending
+				$payment->set_status(EEM_Payment::status_id_pending);
+				$payment->save();
+			} else {
+				// not a payment
+				$this->checkout->continue_reg = false;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
+							'event_espresso'
+						),
+						'<br/>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			// ummm ya... not Off-Line, not On-Site, not off-Site ????
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    _process_payment_status
+	 *
+	 * @access private
+	 * @type    EE_Payment $payment
+	 * @param string       $payment_occurs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
+	{
+		// off-line payment? carry on
+		if ($payment_occurs === EE_PMT_Base::offline) {
+			return true;
+		}
+		// verify payment validity
+		if ($payment instanceof EE_Payment) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
+			$msg = $payment->gateway_response();
+			// check results
+			switch ($payment->status()) {
+				// good payment
+				case EEM_Payment::status_id_approved :
+					EE_Error::add_success(
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return true;
+					break;
+				// slow payment
+				case EEM_Payment::status_id_pending :
+					if (empty($msg)) {
+						$msg = esc_html__(
+							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
+							'event_espresso'
+						);
+					}
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
+					return true;
+					break;
+				// don't wanna payment
+				case EEM_Payment::status_id_cancelled :
+					if (empty($msg)) {
+						$msg = _n(
+							'Payment cancelled. Please try again.',
+							'Payment cancelled. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+					break;
+				// not enough payment
+				case EEM_Payment::status_id_declined :
+					if (empty($msg)) {
+						$msg = _n(
+							'We\'re sorry but your payment was declined. Please try again.',
+							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+					break;
+				// bad payment
+				case EEM_Payment::status_id_failed :
+					if (! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						return false;
+					}
+					// default to error below
+					break;
+			}
+		}
+		// off-site payment gateway responses are too unreliable, so let's just assume that
+		// the payment processing is just running slower than the registrant's request
+		if ($payment_occurs === EE_PMT_Base::offsite) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
+	/********************************************************************************************************/
+	/**
+	 * process_gateway_response
+	 * this is the return point for Off-Site Payment Methods
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
+	 * otherwise, it will load up the last payment made for the TXN.
+	 * If the payment retrieved looks good, it will then either:
+	 *    complete the current step and allow advancement to the next reg step
+	 *        or present the payment options again
+	 *
+	 * @access private
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public function process_gateway_response()
+	{
+		$payment = null;
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		if (! $this->checkout->payment_method->is_off_site()) {
+			return false;
+		}
+		$this->_validate_offsite_return();
+		// DEBUG LOG
+		//$this->checkout->log(
+		//	__CLASS__, __FUNCTION__, __LINE__,
+		//	array(
+		//		'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+		//		'payment_method' => $this->checkout->payment_method,
+		//	),
+		//	true
+		//);
+		// verify TXN
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+			if (! $gateway instanceof EE_Offsite_Gateway) {
+				$this->checkout->continue_reg = false;
+				return false;
+			}
+			$payment = $this->_process_off_site_payment($gateway);
+			$payment = $this->_process_cancelled_payments($payment);
+			$payment = $this->_validate_payment($payment);
+			// if payment was not declined by the payment gateway or cancelled by the registrant
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
+				//$this->_setup_redirect_for_next_step();
+				// store that for later
+				$this->checkout->payment = $payment;
+				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
+				// because we will complete this step during the IPN processing then
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
+					$this->set_completed();
+				}
+				return true;
+			}
+		}
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
+		//	array( 'payment' => $payment )
+		//);
+		$this->checkout->continue_reg = false;
+		return false;
+	}
+
+
+	/**
+	 * _validate_return
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	private function _validate_offsite_return()
+	{
+		$TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
+			// Houston... we might have a problem
+			$invalid_TXN = false;
+			// first gather some info
+			$valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$primary_registrant = $valid_TXN instanceof EE_Transaction
+				? $valid_TXN->primary_registration()
+				: null;
+			// let's start by retrieving the cart for this TXN
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
+			if ($cart instanceof EE_Cart) {
+				// verify that the current cart has tickets
+				$tickets = $cart->get_tickets();
+				if (empty($tickets)) {
+					$invalid_TXN = true;
+				}
+			} else {
+				$invalid_TXN = true;
+			}
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
+				? $primary_registrant->session_ID()
+				: null;
+			// validate current Session ID and compare against valid TXN session ID
+			if (
+				$invalid_TXN // if this is already true, then skip other checks
+				|| EE_Session::instance()->id() === null
+				|| (
+					// WARNING !!!
+					// this could be PayPal sending back duplicate requests (ya they do that)
+					// or it **could** mean someone is simply registering AGAIN after having just done so
+					// so now we need to determine if this current TXN looks valid or not
+					// and whether this reg step has even been started ?
+					EE_Session::instance()->id() === $valid_TXN_SID
+					// really? you're half way through this reg step, but you never started it ?
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
+				)
+			) {
+				$invalid_TXN = true;
+			}
+			if ($invalid_TXN) {
+				// is the valid TXN completed ?
+				if ($valid_TXN instanceof EE_Transaction) {
+					// has this step even been started ?
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
+						// so it **looks** like this is a double request from PayPal
+						// so let's try to pick up where we left off
+						$this->checkout->transaction = $valid_TXN;
+						$this->checkout->refresh_all_entities(true);
+						return;
+					}
+				}
+				// you appear to be lost?
+				$this->_redirect_wayward_request($primary_registrant);
+			}
+		}
+	}
+
+
+	/**
+	 * _redirect_wayward_request
+	 *
+	 * @access private
+	 * @param \EE_Registration|null $primary_registrant
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _redirect_wayward_request(EE_Registration $primary_registrant)
+	{
+		if (! $primary_registrant instanceof EE_Registration) {
+			// try redirecting based on the current TXN
+			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
+				? $this->checkout->transaction->primary_registration()
+				: null;
+		}
+		if (! $primary_registrant instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// make sure transaction is not locked
+		$this->checkout->transaction->unlock();
+		wp_safe_redirect(
+			add_query_arg(
+				array(
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
+				),
+				$this->checkout->thank_you_page_url
+			)
+		);
+		exit();
+	}
+
+
+	/**
+	 * _process_off_site_payment
+	 *
+	 * @access private
+	 * @param \EE_Offsite_Gateway $gateway
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
+	{
+		try {
+			$request_data = \EE_Registry::instance()->REQ->params();
+			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
+			$this->set_handle_IPN_in_this_request(
+				$gateway->handle_IPN_in_this_request($request_data, false)
+			);
+			if ($this->handle_IPN_in_this_request()) {
+				// get payment details and process results
+				/** @type EE_Payment_Processor $payment_processor */
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+				$payment           = $payment_processor->process_ipn(
+					$request_data,
+					$this->checkout->transaction,
+					$this->checkout->payment_method,
+					true,
+					false
+				);
+				//$payment_source = 'process_ipn';
+			} else {
+				$payment = $this->checkout->transaction->last_payment();
+				//$payment_source = 'last_payment';
+			}
+		} catch (Exception $e) {
+			// let's just eat the exception and try to move on using any previously set payment info
+			$payment = $this->checkout->transaction->last_payment();
+			//$payment_source = 'last_payment after Exception';
+			// but if we STILL don't have a payment object
+			if (! $payment instanceof EE_Payment) {
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
+				$this->_handle_payment_processor_exception($e);
+			}
+		}
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
+		//	array(
+		//		'process_ipn_payment' => $payment,
+		//		'payment_source'      => $payment_source,
+		//	)
+		//);
+		return $payment;
+	}
+
+
+	/**
+	 * _process_cancelled_payments
+	 * just makes sure that the payment status gets updated correctly
+	 * so tha tan error isn't generated during payment validation
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment | FALSE
+	 * @throws \EE_Error
+	 */
+	private function _process_cancelled_payments($payment = null)
+	{
+		if (
+			$payment instanceof EE_Payment
+			&& isset($_REQUEST['ee_cancel_payment'])
+			&& $payment->status() === EEM_Payment::status_id_failed
+		) {
+			$payment->set_status(EEM_Payment::status_id_cancelled);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    get_transaction_details_for_gateways
+	 *
+	 * @access    public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_transaction_details_for_gateways()
+	{
+		$txn_details = array();
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$txn_details = array(
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
+			);
+		}
+		// get EE_Payment_Method object
+		if (
+			empty($txn_details)
+			&&
+			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
+		) {
+			$txn_details = array(
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+				'error'                      => esc_html__(
+					'A valid Payment Method could not be determined.',
+					'event_espresso'
+				),
+			);
+		}
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
+			$return_url  = $this->_get_return_url($this->checkout->payment_method);
+			$txn_details = array(
+				'TXN_ID'         => $this->checkout->transaction->ID(),
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
+				'TXN_total'      => $this->checkout->transaction->total(),
+				'TXN_paid'       => $this->checkout->transaction->paid(),
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
+				'payment_amount' => $this->checkout->amount_owing,
+				'return_url'     => $return_url,
+				'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
+					array(
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
+					)
+				),
+			);
+		}
+		echo wp_json_encode($txn_details);
+		exit();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
+	}
 }

admin_pages/transactions/Transactions_Admin_Page.core.php

Indentation +2433 added lines, -2433 removed lines

@@ -16,2437 +16,2437 @@
 class Transactions_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * @var EE_Transaction
-     */
-    private $_transaction;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    /**
-     * @var array $_txn_status
-     */
-    private static $_txn_status;
-
-    /**
-     * @var array $_pay_status
-     */
-    private static $_pay_status;
-
-    /**
-     * @var array $_existing_reg_payment_REG_IDs
-     */
-    protected $_existing_reg_payment_REG_IDs = null;
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    /**
-     *    _init_page_props
-     *
-     * @return void
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = TXN_PG_SLUG;
-        $this->page_label       = esc_html__('Transactions', 'event_espresso');
-        $this->_admin_base_url  = TXN_ADMIN_URL;
-        $this->_admin_base_path = TXN_ADMIN;
-    }
-
-
-    /**
-     *    _ajax_hooks
-     *
-     * @return void
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds'));
-        add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds'));
-        add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment'));
-    }
-
-
-    /**
-     *    _define_page_props
-     *
-     * @return void
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons' => array(
-                'add'    => esc_html__('Add New Transaction', 'event_espresso'),
-                'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
-                'delete' => esc_html__('Delete Transaction', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _set_page_routes()
-    {
-
-        $this->_set_transaction_status_array();
-
-        $txn_id = ! empty($this->_req_data['TXN_ID'])
-                  && ! is_array($this->_req_data['TXN_ID'])
-            ? $this->_req_data['TXN_ID']
-            : 0;
-
-        $this->_page_routes = array(
-
-            'default' => array(
-                'func'       => '_transactions_overview_list_table',
-                'capability' => 'ee_read_transactions',
-            ),
-
-            'view_transaction' => array(
-                'func'       => '_transaction_details',
-                'capability' => 'ee_read_transaction',
-                'obj_id'     => $txn_id,
-            ),
-
-            'send_payment_reminder' => array(
-                'func'       => '_send_payment_reminder',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-
-            'espresso_apply_payment' => array(
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ),
-
-            'espresso_apply_refund' => array(
-                'func'       => 'apply_payments_or_refunds',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payments',
-            ),
-
-            'espresso_delete_payment' => array(
-                'func'       => 'delete_payment',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payments',
-            ),
-
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'          => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'EE_Admin_Transactions_List_Table',
-                'help_tabs'     => array(
-                    'transactions_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Transactions Overview', 'event_espresso'),
-                        'filename' => 'transactions_overview',
-                    ),
-                    'transactions_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
-                        'filename' => 'transactions_overview_table_column_headings',
-                    ),
-                    'transactions_overview_views_filters_help_tab'         => array(
-                        'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
-                        'filename' => 'transactions_overview_views_filters_search',
-                    ),
-                ),
-                'help_tour'     => array('Transactions_Overview_Help_Tour'),
-                /**
-                 * commented out because currently we are not displaying tips for transaction list table status but this
-                 * may change in a later iteration so want to keep the code for then.
-                 */
-                //'qtips' => array( 'Transactions_List_Table_Tips' ),
-                'require_nonce' => false,
-            ),
-            'view_transaction' => array(
-                'nav'       => array(
-                    'label'      => esc_html__('View Transaction', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => isset($this->_req_data['TXN_ID'])
-                        ? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ),
-                'help_tabs' => array(
-                    'transactions_view_transaction_help_tab'                                              => array(
-                        'title'    => esc_html__('View Transaction', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction',
-                    ),
-                    'transactions_view_transaction_transaction_details_table_help_tab'                    => array(
-                        'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_transaction_details_table',
-                    ),
-                    'transactions_view_transaction_attendees_registered_help_tab'                         => array(
-                        'title'    => esc_html__('Attendees Registered', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_attendees_registered',
-                    ),
-                    'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array(
-                        'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
-                        'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
-                    ),
-                ),
-                'qtips'     => array('Transaction_Details_Tips'),
-                'help_tour' => array('Transaction_Details_Help_Tour'),
-                'metaboxes' => array('_transaction_details_metaboxes'),
-
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-        //noop
-    }
-
-    protected function _add_feature_pointers()
-    {
-        //noop
-    }
-
-    public function admin_init()
-    {
-        // IF a registration was JUST added via the admin...
-        if (isset(
-            $this->_req_data['redirect_from'],
-            $this->_req_data['EVT_ID'],
-            $this->_req_data['event_name']
-        )) {
-            // then set a cookie so that we can block any attempts to use
-            // the back button as a way to enter another registration.
-            setcookie(
-                'ee_registration_added',
-                $this->_req_data['EVT_ID'], time() + WEEK_IN_SECONDS, '/'
-            );
-            // and update the global
-            $_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID'];
-        }
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
-            'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
-            'An error occurred! Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
-        EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
-        EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
-        EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__(
-            'This transaction has been overpaid ! Payments Total',
-            'event_espresso'
-        );
-    }
-
-    public function admin_notices()
-    {
-        //noop
-    }
-
-    public function admin_footer_scripts()
-    {
-        //noop
-    }
-
-
-    /**
-     * _set_transaction_status_array
-     * sets list of transaction statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_transaction_status_array()
-    {
-        self::$_txn_status = EEM_Transaction::instance()->status_array(true);
-    }
-
-
-    /**
-     * get_transaction_status_array
-     * return the transaction status array for wp_list_table
-     *
-     * @access public
-     * @return array
-     */
-    public function get_transaction_status_array()
-    {
-        return self::$_txn_status;
-    }
-
-
-    /**
-     *    get list of payment statuses
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_payment_status_array()
-    {
-        self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
-        $this->_template_args['payment_status'] = self::$_pay_status;
-
-    }
-
-
-    /**
-     *    _add_screen_options_default
-     *
-     * @access protected
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * load_scripts_styles
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles()
-    {
-        //enqueue style
-        wp_register_style(
-            'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_txn');
-        //scripts
-        wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array(
-            'ee_admin_js',
-            'ee-datepicker',
-            'jquery-ui-datepicker',
-            'jquery-ui-draggable',
-            'ee-dialog',
-            'ee-accounting',
-            'ee-serialize-full-array',
-        ), EVENT_ESPRESSO_VERSION, true);
-        wp_enqueue_script('espresso_txn');
-    }
-
-
-    /**
-     *    load_scripts_styles_view_transaction
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_view_transaction()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    load_scripts_styles_default
-     *
-     * @access public
-     * @return void
-     */
-    public function load_scripts_styles_default()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-    }
-
-
-    /**
-     *    _set_list_table_views_default
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all'       => array(
-                'slug'  => 'all',
-                'label' => esc_html__('View All Transactions', 'event_espresso'),
-                'count' => 0,
-            ),
-            'abandoned' => array(
-                'slug'  => 'abandoned',
-                'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
-                'count' => 0,
-            ),
-            'failed'    => array(
-                'slug'  => 'failed',
-                'label' => esc_html__('Failed Transactions', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-    /**
-     * _set_transaction_object
-     * This sets the _transaction property for the transaction details screen
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_transaction_object()
-    {
-        if ($this->_transaction instanceof EE_Transaction) {
-            return;
-        } //get out we've already set the object
-
-        $TXN_ID = ! empty($this->_req_data['TXN_ID'])
-            ? absint($this->_req_data['TXN_ID'])
-            : false;
-
-        //get transaction object
-        $this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $this->_session     = $this->_transaction instanceof EE_Transaction
-            ? $this->_transaction->get('TXN_session_data')
-            : null;
-        $this->_transaction->verify_abandoned_transaction_status();
-
-        if (! $this->_transaction instanceof EE_Transaction) {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
-                    'event_espresso'
-                ),
-                $TXN_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     *    _transaction_legend_items
-     *
-     * @access protected
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _transaction_legend_items()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $items = array();
-
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (is_array($related_for_icon)
-                && isset($related_for_icon['css_class'], $related_for_icon['label'])
-            ) {
-                $items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-
-        $items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
-            array_merge(
-                $items,
-                array(
-                    'view_details'          => array(
-                        'class' => 'dashicons dashicons-cart',
-                        'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-                    ),
-                    'view_invoice'          => array(
-                        'class' => 'dashicons dashicons-media-spreadsheet',
-                        'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-                    ),
-                    'view_receipt'          => array(
-                        'class' => 'dashicons dashicons-media-default',
-                        'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
-                    ),
-                    'view_registration'     => array(
-                        'class' => 'dashicons dashicons-clipboard',
-                        'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-                    ),
-                    'payment_overview_link' => array(
-                        'class' => 'dashicons dashicons-money',
-                        'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
-                    ),
-                )
-            )
-        );
-
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_transactions_send_payment_reminder'
-        )) {
-            if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
-                $items['send_payment_reminder'] = array(
-                    'class' => 'dashicons dashicons-email-alt',
-                    'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
-                );
-            } else {
-                $items['blank*'] = array(
-                    'class' => '',
-                    'desc'  => '',
-                );
-            }
-        } else {
-            $items['blank*'] = array(
-                'class' => '',
-                'desc'  => '',
-            );
-        }
-        $more_items = apply_filters(
-            'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
-            array(
-                'overpaid'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::overpaid_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'complete'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::complete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'incomplete' => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::incomplete_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'abandoned'  => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::abandoned_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-                'failed'     => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
-                    'desc'  => EEH_Template::pretty_status(
-                        EEM_Transaction::failed_status_code,
-                        false,
-                        'sentence'
-                    ),
-                ),
-            )
-        );
-
-        return array_merge($items, $more_items);
-    }
-
-
-    /**
-     *    _transactions_overview_list_table
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _transactions_overview_list_table()
-    {
-        $this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
-        $event = isset($this->_req_data['EVT_ID'])
-            ? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID'])
-            : null;
-        $this->_template_args['admin_page_header'] = $event instanceof EE_Event
-            ? sprintf(
-                esc_html__(
-                    '%sViewing Transactions for the Event: %s%s',
-                    'event_espresso'
-                ),
-                '<h3>',
-                '<a href="'
-                . EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'edit', 'post' => $event->ID()),
-                    EVENTS_ADMIN_URL
-                )
-                . '" title="'
-                . esc_attr__(
-                    'Click to Edit event',
-                    'event_espresso'
-                )
-                . '">' . $event->get('EVT_name') . '</a>',
-                '</h3>'
-            )
-            : '';
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *    _transaction_details
-     * generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details()
-    {
-        do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
-
-        $this->_set_transaction_status_array();
-
-        $this->_template_args                      = array();
-        $this->_template_args['transactions_page'] = $this->_wp_page_slug;
-
-        $this->_set_transaction_object();
-
-        $primary_registration = $this->_transaction->primary_registration();
-        $attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : null;
-
-        $this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
-        $this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
-
-        $this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
-        $this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
-
-        $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')];
-        $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
-
-        $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
-        $this->_template_args['total_paid']  = $this->_transaction->get('TXN_paid');
-
-        $amount_due = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid');
-        $this->_template_args['amount_due'] = EEH_Template::format_currency(
-            $amount_due,
-            true
-        );
-        if (EE_Registry::instance()->CFG->currency->sign_b4) {
-            $this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign
-                                                  . $this->_template_args['amount_due'];
-        } else {
-            $this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign;
-        }
-        $this->_template_args['amount_due_class'] = '';
-
-        if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) {
-            // paid in full
-            $this->_template_args['amount_due'] = false;
-        } elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) {
-            // overpaid
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif ($this->_transaction->get('TXN_total') > 0
-                  && $this->_transaction->get('TXN_paid') > 0
-        ) {
-            // monies owing
-            $this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn';
-        } elseif ($this->_transaction->get('TXN_total') > 0
-                  && $this->_transaction->get('TXN_paid') == 0
-        ) {
-            // no payments made yet
-            $this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
-        } elseif ($this->_transaction->get('TXN_total') == 0) {
-            // free event
-            $this->_template_args['amount_due'] = false;
-        }
-
-        $payment_method = $this->_transaction->payment_method();
-
-        $this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        // link back to overview
-        $this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER'])
-            ? $_SERVER['HTTP_REFERER']
-            : TXN_ADMIN_URL;
-
-
-        // next link
-        $next_txn                                 = $this->_transaction->next(
-            null,
-            array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
-            'TXN_ID'
-        );
-        $this->_template_args['next_transaction'] = $next_txn
-            ? $this->_next_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']),
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-right ee-icon-size-22'
-            )
-            : '';
-        // previous link
-        $previous_txn                                 = $this->_transaction->previous(
-            null,
-            array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
-            'TXN_ID'
-        );
-        $this->_template_args['previous_transaction'] = $previous_txn
-            ? $this->_previous_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']),
-                    TXN_ADMIN_URL
-                ),
-                'dashicons dashicons-arrow-left ee-icon-size-22'
-            )
-            : '';
-
-        // were we just redirected here after adding a new registration ???
-        if (isset(
-            $this->_req_data['redirect_from'],
-            $this->_req_data['EVT_ID'],
-            $this->_req_data['event_name']
-        )) {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $this->_req_data['EVT_ID']
-            )) {
-                $this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="';
-                $this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page'     => 'espresso_registrations',
-                        'action'   => 'new_registration',
-                        'return'   => 'default',
-                        'TXN_ID'   => $this->_transaction->ID(),
-                        'event_id' => $this->_req_data['EVT_ID'],
-                    ),
-                    REG_ADMIN_URL
-                );
-                $this->_admin_page_title .= '">';
-
-                $this->_admin_page_title .= sprintf(
-                    esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
-                    htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8')
-                );
-                $this->_admin_page_title .= '</a>';
-            }
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // grab messages at the last second
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        // path to template
-        $template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
-        $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-
-    }
-
-
-    /**
-     *        _transaction_details_metaboxes
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    protected function _transaction_details_metaboxes()
-    {
-
-        $this->_set_transaction_object();
-
-        add_meta_box(
-            'edit-txn-details-mbox',
-            esc_html__('Transaction Details', 'event_espresso'),
-            array($this, 'txn_details_meta_box'),
-            $this->_wp_page_slug,
-            'normal',
-            'high'
-        );
-        add_meta_box(
-            'edit-txn-attendees-mbox',
-            esc_html__('Attendees Registered in this Transaction', 'event_espresso'),
-            array($this, 'txn_attendees_meta_box'),
-            $this->_wp_page_slug,
-            'normal',
-            'high',
-            array('TXN_ID' => $this->_transaction->ID())
-        );
-        add_meta_box(
-            'edit-txn-registrant-mbox',
-            esc_html__('Primary Contact', 'event_espresso'),
-            array($this, 'txn_registrant_side_meta_box'),
-            $this->_wp_page_slug,
-            'side',
-            'high'
-        );
-        add_meta_box(
-            'edit-txn-billing-info-mbox',
-            esc_html__('Billing Information', 'event_espresso'),
-            array($this, 'txn_billing_info_side_meta_box'),
-            $this->_wp_page_slug,
-            'side',
-            'high'
-        );
-    }
-
-
-    /**
-     * Callback for transaction actions metabox.
-     *
-     * @param EE_Transaction|null $transaction
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function getActionButtons(EE_Transaction $transaction = null)
-    {
-        $content = '';
-        $actions = array();
-        if (! $transaction instanceof EE_Transaction) {
-            return $content;
-        }
-        /** @var EE_Registration $primary_registration */
-        $primary_registration = $transaction->primary_registration();
-        $attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : null;
-
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $actions['payment_reminder'] =
-                EEH_MSG_Template::is_mt_active('payment_reminder')
-                && $this->_transaction->get('STS_ID') !== EEM_Transaction::complete_status_code
-                && $this->_transaction->get('STS_ID') !== EEM_Transaction::overpaid_status_code
-                    ? EEH_Template::get_button_or_link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action'      => 'send_payment_reminder',
-                                'TXN_ID'      => $this->_transaction->ID(),
-                                'redirect_to' => 'view_transaction',
-                            ),
-                            TXN_ADMIN_URL
-                        ),
-                        esc_html__(' Send Payment Reminder', 'event_espresso'),
-                        'button secondary-button',
-                        'dashicons dashicons-email-alt'
-                    )
-                    : '';
-        }
-
-        if ($primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('receipt')
-        ) {
-            $actions['receipt'] = EEH_Template::get_button_or_link(
-                $primary_registration->receipt_url(),
-                esc_html__('View Receipt', 'event_espresso'),
-                'button secondary-button',
-                'dashicons dashicons-media-default'
-            );
-        }
-
-        if ($primary_registration instanceof EE_Registration
-            && EEH_MSG_Template::is_mt_active('invoice')
-        ) {
-            $actions['invoice'] = EEH_Template::get_button_or_link(
-                $primary_registration->invoice_url(),
-                esc_html__('View Invoice', 'event_espresso'),
-                'button secondary-button',
-                'dashicons dashicons-media-spreadsheet'
-            );
-        }
-        $actions = array_filter(
-            apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
-        );
-        if ($actions) {
-            $content = '<ul>';
-            $content .= '<li>' . implode('</li><li>', $actions) . '</li>';
-            $content .= '</uL>';
-        }
-        return $content;
-    }
-
-
-    /**
-     * txn_details_meta_box
-     * generates HTML for the Transaction main meta box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function txn_details_meta_box()
-    {
-        $this->_set_transaction_object();
-        $this->_template_args['TXN_ID']   = $this->_transaction->ID();
-        $this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration
-            ? $this->_transaction->primary_registration()->attendee()
-            : null;
-        $this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        $this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-
-        //get line table
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display                       = new EE_Line_Item_Display(
-            'admin_table',
-            'EE_Admin_Table_Line_Item_Display_Strategy'
-        );
-        $this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
-            $this->_transaction->total_line_item()
-        );
-        $this->_template_args['REG_code']        = $this->_transaction->get_first_related('Registration')
-                                                                      ->get('REG_code');
-
-        // process taxes
-        $taxes                         = $this->_transaction->get_many_related(
-            'Line_Item',
-            array(array('LIN_type' => EEM_Line_Item::type_tax))
-        );
-        $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
-
-        $this->_template_args['grand_total']     = EEH_Template::format_currency(
-            $this->_transaction->get('TXN_total'),
-            false,
-            false
-        );
-        $this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total');
-        $this->_template_args['TXN_status']      = $this->_transaction->get('STS_ID');
-
-        // process payment details
-        $payments = $this->_transaction->get_many_related('Payment');
-        if (! empty($payments)) {
-            $this->_template_args['payments']              = $payments;
-            $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
-        } else {
-            $this->_template_args['payments']              = false;
-            $this->_template_args['existing_reg_payments'] = array();
-        }
-
-        $this->_template_args['edit_payment_url']   = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL);
-        $this->_template_args['delete_payment_url'] = add_query_arg(
-            array('action' => 'espresso_delete_payment'),
-            TXN_ADMIN_URL
-        );
-
-        if (isset($txn_details['invoice_number'])) {
-            $this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
-            $this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
-                'Invoice Number',
-                'event_espresso'
-            );
-        }
-
-        $this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction
-            ->get_first_related('Registration')
-            ->get('REG_session');
-        $this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address'])
-            ? $this->_session['ip_address']
-            : '';
-        $this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
-            'Transaction placed from IP',
-            'event_espresso'
-        );
-
-        $this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent'])
-            ? $this->_session['user_agent']
-            : '';
-        $this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
-            'Registrant User Agent',
-            'event_espresso'
-        );
-
-        $reg_steps = '<ul>';
-        foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
-            if ($reg_step_status === true) {
-                $reg_steps .= '<li style="color:#70cc50">'
-                              . sprintf(
-                                  esc_html__('%1$s : Completed', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</li>';
-            } elseif (is_numeric($reg_step_status) && $reg_step_status !== false) {
-                $reg_steps .= '<li style="color:#2EA2CC">'
-                              . sprintf(
-                                  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step)),
-                                  date(
-                                      get_option('date_format') . ' ' . get_option('time_format'),
-                                      ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS))
-                                  )
-                              )
-                              . '</li>';
-            } else {
-                $reg_steps .= '<li style="color:#E76700">'
-                              . sprintf(
-                                  esc_html__('%1$s : Never Initiated', 'event_espresso'),
-                                  ucwords(str_replace('_', ' ', $reg_step))
-                              )
-                              . '</li>';
-            }
-        }
-        $reg_steps                                                 .= '</ul>';
-        $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
-        $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
-            'Registration Step Progress',
-            'event_espresso'
-        );
-
-
-        $this->_get_registrations_to_apply_payment_to();
-        $this->_get_payment_methods($payments);
-        $this->_get_payment_status_array();
-        $this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction.
-
-        $this->_template_args['transaction_form_url']    = add_query_arg(array(
-            'action'  => 'edit_transaction',
-            'process' => 'transaction',
-        ), TXN_ADMIN_URL);
-        $this->_template_args['apply_payment_form_url']  = add_query_arg(array(
-            'page'   => 'espresso_transactions',
-            'action' => 'espresso_apply_payment',
-        ), WP_AJAX_URL);
-        $this->_template_args['delete_payment_form_url'] = add_query_arg(array(
-            'page'   => 'espresso_transactions',
-            'action' => 'espresso_delete_payment',
-        ), WP_AJAX_URL);
-
-        $this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
-
-        // 'espresso_delete_payment_nonce'
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * _get_registration_payment_IDs
-     *    generates an array of Payment IDs and their corresponding Registration IDs
-     *
-     * @access protected
-     * @param EE_Payment[] $payments
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_registration_payment_IDs($payments = array())
-    {
-        $existing_reg_payments = array();
-        // get all reg payments for these payments
-        $reg_payments = EEM_Registration_Payment::instance()->get_all(array(
-            array(
-                'PAY_ID' => array(
-                    'IN',
-                    array_keys($payments),
-                ),
-            ),
-        ));
-        if (! empty($reg_payments)) {
-            foreach ($payments as $payment) {
-                if (! $payment instanceof EE_Payment) {
-                    continue;
-                } elseif (! isset($existing_reg_payments[$payment->ID()])) {
-                    $existing_reg_payments[$payment->ID()] = array();
-                }
-                foreach ($reg_payments as $reg_payment) {
-                    if ($reg_payment instanceof EE_Registration_Payment
-                        && $reg_payment->payment_ID() === $payment->ID()
-                    ) {
-                        $existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID();
-                    }
-                }
-            }
-        }
-
-        return $existing_reg_payments;
-    }
-
-
-    /**
-     * _get_registrations_to_apply_payment_to
-     *    generates HTML for displaying a series of checkboxes in the admin payment modal window
-     * which allows the admin to only apply the payment to the specific registrations
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _get_registrations_to_apply_payment_to()
-    {
-        // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params                      = array(
-            array(
-                'STS_ID' => array(
-                    'IN',
-                    array(
-                        EEM_Registration::status_id_approved,
-                        EEM_Registration::status_id_pending_payment,
-                        EEM_Registration::status_id_not_approved,
-                    ),
-                ),
-            ),
-        );
-        $registrations_to_apply_payment_to = EEH_HTML::br()
-                                             . EEH_HTML::div(
-                                                 '',
-                                                 'txn-admin-apply-payment-to-registrations-dv',
-                                                 '',
-                                                 'clear: both; margin: 1.5em 0 0; display: none;'
-                                             );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
-        $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
-        $registrations_to_apply_payment_to .= EEH_HTML::thead(
-            EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
-            )
-        );
-        $registrations_to_apply_payment_to .= EEH_HTML::tbody();
-        // get registrations for TXN
-        $registrations = $this->_transaction->registrations($query_params);
-        $existing_reg_payments = $this->_template_args['existing_reg_payments'];
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $attendee_name                     = $registration->attendee() instanceof EE_Attendee
-                    ? $registration->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $owing                             = $registration->final_price() - $registration->paid();
-                $taxable                           = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
-                    : '';
-                $checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
-                    ? ' checked="checked"'
-                    : '';
-                $disabled                          = $registration->final_price() > 0 ? '' : ' disabled';
-                $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
-                    EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
-                    EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
-                        . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
-                        '',
-                        'jst-cntr'
-                    ),
-                    'apply-payment-registration-row-' . $registration->ID()
-                );
-            }
-        }
-        $registrations_to_apply_payment_to                         .= EEH_HTML::tbodyx();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::tablex();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
-        $registrations_to_apply_payment_to                         .= EEH_HTML::p(
-            esc_html__(
-                'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
-                'event_espresso'
-            ),
-            '',
-            'clear description'
-        );
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
-        $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
-    }
-
-
-    /**
-     * _get_reg_status_selection
-     *
-     * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
-     *         instead of events.
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _get_reg_status_selection()
-    {
-        //first get all possible statuses
-        $statuses = EEM_Registration::reg_status_array(array(), true);
-        //let's add a "don't change" option.
-        $status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
-        $status_array                                        = array_merge($status_array, $statuses);
-        $this->_template_args['status_change_select']        = EEH_Form_Fields::select_input(
-            'txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'id="txn-admin-payment-reg-status-inp"',
-            'txn-reg-status-change-reg-status'
-        );
-        $this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
-            'delete_txn_reg_status_change[reg_status]',
-            $status_array,
-            'NAN',
-            'delete-txn-admin-payment-reg-status-inp',
-            'delete-txn-reg-status-change-reg-status'
-        );
-    }
-
-
-    /**
-     *    _get_payment_methods
-     * Gets all the payment methods available generally, or the ones that are already
-     * selected on these payments (in case their payment methods are no longer active).
-     * Has the side-effect of updating the template args' payment_methods item
-     *
-     * @access private
-     * @param EE_Payment[] to show on this page
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _get_payment_methods($payments = array())
-    {
-        $payment_methods_of_payments = array();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment) {
-                $payment_methods_of_payments[] = $payment->get('PMD_ID');
-            }
-        }
-        if ($payment_methods_of_payments) {
-            $query_args = array(
-                array(
-                    'OR*payment_method_for_payment' => array(
-                        'PMD_ID'    => array('IN', $payment_methods_of_payments),
-                        'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'),
-                    ),
-                ),
-            );
-        } else {
-            $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
-        }
-        $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
-    }
-
-
-    /**
-     * txn_attendees_meta_box
-     *    generates HTML for the Attendees Transaction main meta box
-     *
-     * @access public
-     * @param WP_Post $post
-     * @param array   $metabox
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function txn_attendees_meta_box($post, $metabox = array('args' => array()))
-    {
-
-        /** @noinspection NonSecureExtractUsageInspection */
-        extract($metabox['args']);
-        $this->_template_args['post']            = $post;
-        $this->_template_args['event_attendees'] = array();
-        // process items in cart
-        $line_items = $this->_transaction->get_many_related(
-            'Line_Item',
-            array(array('LIN_type' => 'line-item'))
-        );
-        if (! empty($line_items)) {
-            foreach ($line_items as $item) {
-                if ($item instanceof EE_Line_Item) {
-                    switch ($item->OBJ_type()) {
-                        case 'Event':
-                            break;
-                        case 'Ticket':
-                            $ticket = $item->ticket();
-                            //right now we're only handling tickets here.
-                            //Cause its expected that only tickets will have attendees right?
-                            if (! $ticket instanceof EE_Ticket) {
-                                continue;
-                            }
-                            try {
-                                $event_name = $ticket->get_event_name();
-                            } catch (Exception $e) {
-                                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                                $event_name = esc_html__('Unknown Event', 'event_espresso');
-                            }
-                            $event_name   .= ' - ' . $item->get('LIN_name');
-                            $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
-                            // now get all of the registrations for this transaction that use this ticket
-                            $registrations = $ticket->get_many_related(
-                                'Registration',
-                                array(array('TXN_ID' => $this->_transaction->ID()))
-                            );
-                            foreach ($registrations as $registration) {
-                                if (! $registration instanceof EE_Registration) {
-                                    continue;
-                                }
-                                $this->_template_args['event_attendees'][$registration->ID()]['STS_ID']
-                                    = $registration->status_ID();
-                                $this->_template_args['event_attendees'][$registration->ID()]['att_num']
-                                    = $registration->count();
-                                $this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name']
-                                    = $event_name;
-                                $this->_template_args['event_attendees'][$registration->ID()]['ticket_price']
-                                    = $ticket_price;
-                                // attendee info
-                                $attendee = $registration->get_first_related('Attendee');
-                                if ($attendee instanceof EE_Attendee) {
-                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id']
-                                        = $attendee->ID();
-                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee']
-                                        = $attendee->full_name();
-                                    $this->_template_args['event_attendees'][$registration->ID()]['email']
-                                        = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
-                                          . esc_html__(
-                                              ' Event',
-                                              'event_espresso'
-                                          )
-                                          . '">' . $attendee->email() . '</a>';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['address']
-                                        = EEH_Address::format($attendee, 'inline', false, false);
-                                } else {
-                                    $this->_template_args['event_attendees'][$registration->ID()]['att_id']   = '';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['attendee'] = '';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['email']    = '';
-                                    $this->_template_args['event_attendees'][$registration->ID()]['address']  = '';
-                                }
-                            }
-                            break;
-
-                    }
-                }
-            }
-
-            $this->_template_args['transaction_form_url'] = add_query_arg(
-                array(
-                    'action'  => 'edit_transaction',
-                    'process' => 'attendees',
-                ),
-                TXN_ADMIN_URL
-            );
-            echo EEH_Template::display_template(
-                TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
-                $this->_template_args,
-                true
-            );
-
-        } else {
-            echo sprintf(
-                esc_html__(
-                    '%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
-                    'event_espresso'
-                ),
-                '<p class="important-notice">',
-                '</p>'
-            );
-        }
-    }
-
-
-    /**
-     * txn_registrant_side_meta_box
-     * generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_registrant_side_meta_box()
-    {
-        $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
-            ? $this->_transaction->primary_registration()->get_first_related('Attendee')
-            : null;
-        if (! $primary_att instanceof EE_Attendee) {
-            $this->_template_args['no_attendee_message'] = esc_html__(
-                'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
-                'event_espresso'
-            );
-            $primary_att                                 = EEM_Attendee::instance()->create_default_object();
-        }
-        $this->_template_args['ATT_ID']            = $primary_att->ID();
-        $this->_template_args['prime_reg_fname']   = $primary_att->fname();
-        $this->_template_args['prime_reg_lname']   = $primary_att->lname();
-        $this->_template_args['prime_reg_email']   = $primary_att->email();
-        $this->_template_args['prime_reg_phone']   = $primary_att->phone();
-        $this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'edit_attendee',
-            'post'   => $primary_att->ID(),
-        ), REG_ADMIN_URL);
-        // get formatted address for registrant
-        $this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
-        echo EEH_Template::display_template(
-            TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * txn_billing_info_side_meta_box
-     *    generates HTML for the Edit Transaction side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function txn_billing_info_side_meta_box()
-    {
-
-        $this->_template_args['billing_form']     = $this->_transaction->billing_info();
-        $this->_template_args['billing_form_url'] = add_query_arg(
-            array('action' => 'edit_transaction', 'process' => 'billing'),
-            TXN_ADMIN_URL
-        );
-
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
-    }
-
-
-    /**
-     * apply_payments_or_refunds
-     *    registers a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function apply_payments_or_refunds()
-    {
-        $json_response_data = array('return_data' => false);
-        $valid_data         = $this->_validate_payment_request_data();
-        $has_access = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_payments',
-            'apply_payment_or_refund_from_registration_details'
-        );
-        if (! empty($valid_data) && $has_access) {
-            $PAY_ID = $valid_data['PAY_ID'];
-            //save  the new payment
-            $payment = $this->_create_payment_from_request_data($valid_data);
-            // get the TXN for this payment
-            $transaction = $payment->transaction();
-            // verify transaction
-            if ($transaction instanceof EE_Transaction) {
-                // calculate_total_payments_and_update_status
-                $this->_process_transaction_payments($transaction);
-                $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
-                $this->_remove_existing_registration_payments($payment, $PAY_ID);
-                // apply payment to registrations (if applicable)
-                if (! empty($REG_IDs)) {
-                    $this->_update_registration_payments($transaction, $payment, $REG_IDs);
-                    $this->_maybe_send_notifications();
-                    // now process status changes for the same registrations
-                    $this->_process_registration_status_change($transaction, $REG_IDs);
-                }
-                $this->_maybe_send_notifications($payment);
-                //prepare to render page
-                $json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs);
-                do_action(
-                    'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
-                    $transaction,
-                    $payment
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Transaction for this payment could not be retrieved.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            if ($has_access) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The payment form data could not be processed. Please try again.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'You do not have access to apply payments or refunds to a registration.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $notices              = EE_Error::get_notices(
-            false,
-            false,
-            false
-        );
-        $this->_template_args = array(
-            'data'    => $json_response_data,
-            'error'   => $notices['errors'],
-            'success' => $notices['success'],
-        );
-        $this->_return_json();
-    }
-
-
-    /**
-     * _validate_payment_request_data
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _validate_payment_request_data()
-    {
-        if (! isset($this->_req_data['txn_admin_payment'])) {
-            return false;
-        }
-        $payment_form = $this->_generate_payment_form_section();
-        try {
-            if ($payment_form->was_submitted()) {
-                $payment_form->receive_form_submission();
-                if (! $payment_form->is_valid()) {
-                    $submission_error_messages = array();
-                    foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
-                        if ($validation_error instanceof EE_Validation_Error) {
-                            $submission_error_messages[] = sprintf(
-                                _x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
-                                $validation_error->get_form_section()->html_label_text(),
-                                $validation_error->getMessage()
-                            );
-                        }
-                    }
-                    EE_Error::add_error(
-                        implode('<br />', $submission_error_messages),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-
-                    return array();
-                }
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-
-            return array();
-        }
-
-        return $payment_form->valid_data();
-    }
-
-
-    /**
-     * _generate_payment_form_section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _generate_payment_form_section()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'        => 'txn_admin_payment',
-                'subsections' => array(
-                    'PAY_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'TXN_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'type'            => new EE_Text_Input(
-                        array(
-                            'default'               => 1,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'amount'          => new EE_Text_Input(
-                        array(
-                            'default'               => 0,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Float_Normalization()),
-                        )
-                    ),
-                    'status'          => new EE_Text_Input(
-                        array(
-                            'default'         => EEM_Payment::status_id_approved,
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment status', 'event_espresso'),
-                        )
-                    ),
-                    'PMD_ID'          => new EE_Text_Input(
-                        array(
-                            'default'               => 2,
-                            'required'              => true,
-                            'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
-                            'validation_strategies' => array(new EE_Int_Normalization()),
-                        )
-                    ),
-                    'date'            => new EE_Text_Input(
-                        array(
-                            'default'         => time(),
-                            'required'        => true,
-                            'html_label_text' => esc_html__('Payment date', 'event_espresso'),
-                        )
-                    ),
-                    'txn_id_chq_nmbr' => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ),
-                        )
-                    ),
-                    'po_number'       => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ),
-                        )
-                    ),
-                    'accounting'      => new EE_Text_Input(
-                        array(
-                            'default'               => '',
-                            'required'              => false,
-                            'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
-                            'validation_strategies' => array(
-                                new EE_Max_Length_Validation_Strategy(
-                                    esc_html__('Input too long', 'event_espresso'),
-                                    100
-                                ),
-                            ),
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _create_payment_from_request_data
-     *
-     * @param array $valid_data
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    protected function _create_payment_from_request_data($valid_data)
-    {
-        $PAY_ID = $valid_data['PAY_ID'];
-        // get payment amount
-        $amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
-        // payments have a type value of 1 and refunds have a type value of -1
-        // so multiplying amount by type will give a positive value for payments, and negative values for refunds
-        $amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
-        // for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
-        $date    = $valid_data['date']
-            ? preg_replace('/\s+/', ' ', $valid_data['date'])
-            : date('Y-m-d g:i a', current_time('timestamp'));
-        $payment = EE_Payment::new_instance(
-            array(
-                'TXN_ID'              => $valid_data['TXN_ID'],
-                'STS_ID'              => $valid_data['status'],
-                'PAY_timestamp'       => $date,
-                'PAY_source'          => EEM_Payment_Method::scope_admin,
-                'PMD_ID'              => $valid_data['PMD_ID'],
-                'PAY_amount'          => $amount,
-                'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
-                'PAY_po_number'       => $valid_data['po_number'],
-                'PAY_extra_accntng'   => $valid_data['accounting'],
-                'PAY_details'         => $valid_data,
-                'PAY_ID'              => $PAY_ID,
-            ),
-            '',
-            array('Y-m-d', 'g:i a')
-        );
-
-        if (! $payment->save()) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
-                    $payment->ID()
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * _process_transaction_payments
-     *
-     * @param \EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_transaction_payments(EE_Transaction $transaction)
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        //update the transaction with this payment
-        if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_success(esc_html__(
-                'The payment has been processed successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'The payment was processed successfully but the amount paid for the transaction was not updated.',
-                    'event_espresso'
-                )
-                ,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _get_REG_IDs_to_apply_payment_to
-     * returns a list of registration IDs that the payment will apply to
-     *
-     * @param \EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
-    {
-        $REG_IDs = array();
-        // grab array of IDs for specific registrations to apply changes to
-        if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
-            $REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations'];
-        }
-        //nothing specified ? then get all reg IDs
-        if (empty($REG_IDs)) {
-            $registrations = $payment->transaction()->registrations();
-            $REG_IDs       = ! empty($registrations)
-                ? array_keys($registrations)
-                : $this->_get_existing_reg_payment_REG_IDs($payment);
-        }
-
-        // ensure that REG_IDs are integers and NOT strings
-        return array_map('intval', $REG_IDs);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function existing_reg_payment_REG_IDs()
-    {
-        return $this->_existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * @param array $existing_reg_payment_REG_IDs
-     */
-    public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
-    {
-        $this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
-    }
-
-
-    /**
-     * _get_existing_reg_payment_REG_IDs
-     * returns a list of registration IDs that the payment is currently related to
-     * as recorded in the database
-     *
-     * @param \EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
-    {
-        if ($this->existing_reg_payment_REG_IDs() === null) {
-            // let's get any existing reg payment records for this payment
-            $existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
-            // but we only want the REG IDs, so grab the array keys
-            $existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
-                ? array_keys($existing_reg_payment_REG_IDs)
-                : array();
-            $this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
-        }
-
-        return $this->existing_reg_payment_REG_IDs();
-    }
-
-
-    /**
-     * _remove_existing_registration_payments
-     * this calculates the difference between existing relations
-     * to the supplied payment and the new list registration IDs,
-     * removes any related registrations that no longer apply,
-     * and then updates the registration paid fields
-     *
-     * @param \EE_Payment $payment
-     * @param int         $PAY_ID
-     * @return bool;
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
-    {
-        // newly created payments will have nothing recorded for $PAY_ID
-        if ($PAY_ID == 0) {
-            return false;
-        }
-        $existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-        if (empty($existing_reg_payment_REG_IDs)) {
-            return false;
-        }
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-
-        return $transaction_payments->delete_registration_payments_and_update_registrations(
-            $payment,
-            array(
-                array(
-                    'PAY_ID' => $payment->ID(),
-                    'REG_ID' => array('IN', $existing_reg_payment_REG_IDs),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _update_registration_payments
-     * this applies the payments to the selected registrations
-     * but only if they have not already been paid for
-     *
-     * @param  EE_Transaction $transaction
-     * @param \EE_Payment     $payment
-     * @param array           $REG_IDs
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $REG_IDs = array()
-    ) {
-        // we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
-        // so let's do that using our set of REG_IDs from the form
-        $registration_query_where_params = array(
-            'REG_ID' => array('IN', $REG_IDs),
-        );
-        // but add in some conditions regarding payment,
-        // so that we don't apply payments to registrations that are free or have already been paid for
-        // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if (! $payment->is_a_refund()) {
-            $registration_query_where_params['REG_final_price']  = array('!=', 0);
-            $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
-        }
-        $registrations = $transaction->registrations(array($registration_query_where_params));
-        if (! empty($registrations)) {
-            /** @type EE_Payment_Processor $payment_processor */
-            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-            $payment_processor->process_registration_payments($transaction, $payment, $registrations);
-        }
-    }
-
-
-    /**
-     * _process_registration_status_change
-     * This processes requested registration status changes for all the registrations
-     * on a given transaction and (optionally) sends out notifications for the changes.
-     *
-     * @param  EE_Transaction $transaction
-     * @param array           $REG_IDs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array())
-    {
-        // first if there is no change in status then we get out.
-        if (
-            ! isset($this->_req_data['txn_reg_status_change']['reg_status'])
-            || $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN'
-        ) {
-            //no error message, no change requested, just nothing to do man.
-            return false;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        // made it here dude?  Oh WOW.  K, let's take care of changing the statuses
-        return $transaction_processor->manually_update_registration_statuses(
-            $transaction,
-            sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']),
-            array(array('REG_ID' => array('IN', $REG_IDs)))
-        );
-    }
-
-
-    /**
-     * _build_payment_json_response
-     *
-     * @access public
-     * @param \EE_Payment $payment
-     * @param array       $REG_IDs
-     * @param bool | null $delete_txn_reg_status_change
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _build_payment_json_response(
-        EE_Payment $payment,
-        $REG_IDs = array(),
-        $delete_txn_reg_status_change = null
-    ) {
-        // was the payment deleted ?
-        if (is_bool($delete_txn_reg_status_change)) {
-            return array(
-                'PAY_ID'                       => $payment->ID(),
-                'amount'                       => $payment->amount(),
-                'total_paid'                   => $payment->transaction()->paid(),
-                'txn_status'                   => $payment->transaction()->status_ID(),
-                'pay_status'                   => $payment->STS_ID(),
-                'registrations'                => $this->_registration_payment_data_array($REG_IDs),
-                'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
-            );
-        } else {
-            $this->_get_payment_status_array();
-
-            return array(
-                'amount'           => $payment->amount(),
-                'total_paid'       => $payment->transaction()->paid(),
-                'txn_status'       => $payment->transaction()->status_ID(),
-                'pay_status'       => $payment->STS_ID(),
-                'PAY_ID'           => $payment->ID(),
-                'STS_ID'           => $payment->STS_ID(),
-                'status'           => self::$_pay_status[$payment->STS_ID()],
-                'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
-                'method'           => strtoupper($payment->source()),
-                'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
-                'gateway'          => $payment->payment_method()
-                    ? $payment->payment_method()->admin_name()
-                    : esc_html__("Unknown", 'event_espresso'),
-                'gateway_response' => $payment->gateway_response(),
-                'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
-                'po_number'        => $payment->po_number(),
-                'extra_accntng'    => $payment->extra_accntng(),
-                'registrations'    => $this->_registration_payment_data_array($REG_IDs),
-            );
-        }
-    }
-
-
-    /**
-     * delete_payment
-     *    delete a payment or refund made towards a transaction
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_payment()
-    {
-        $json_response_data = array('return_data' => false);
-        $PAY_ID             = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
-            ? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
-            : 0;
-        $can_delete = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_payments',
-            'delete_payment_from_registration_details'
-        );
-        if ($PAY_ID && $can_delete) {
-            $delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change'])
-                ? $this->_req_data['delete_txn_reg_status_change']
-                : false;
-            $payment                      = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            if ($payment instanceof EE_Payment) {
-                $REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
-                    $json_response_data['return_data'] = $this->_build_payment_json_response(
-                        $payment,
-                        $REG_IDs,
-                        $delete_txn_reg_status_change
-                    );
-                    if ($delete_txn_reg_status_change) {
-                        $this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change;
-                        //MAKE sure we also add the delete_txn_req_status_change to the
-                        //$_REQUEST global because that's how messages will be looking for it.
-                        $_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change;
-                        $this->_maybe_send_notifications();
-                        $this->_process_registration_status_change($payment->transaction(), $REG_IDs);
-                    }
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        } else {
-            if ($can_delete) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'A valid Payment ID was not received, therefore payment form data could not be loaded.',
-                        'event_espresso'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'You do not have access to delete a payment.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $notices              = EE_Error::get_notices(false, false, false);
-        $this->_template_args = array(
-            'data'      => $json_response_data,
-            'success'   => $notices['success'],
-            'error'     => $notices['errors'],
-            'attention' => $notices['attention'],
-        );
-        $this->_return_json();
-    }
-
-
-    /**
-     * _registration_payment_data_array
-     * adds info for 'owing' and 'paid' for each registration to the json response
-     *
-     * @access protected
-     * @param array $REG_IDs
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _registration_payment_data_array($REG_IDs)
-    {
-        $registration_payment_data = array();
-        //if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if (! empty($REG_IDs)) {
-            $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration_payment_data[$registration->ID()] = array(
-                        'paid'  => $registration->pretty_paid(),
-                        'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
-                    );
-                }
-            }
-        }
-
-        return $registration_payment_data;
-    }
-
-
-    /**
-     * _maybe_send_notifications
-     * determines whether or not the admin has indicated that notifications should be sent.
-     * If so, will toggle a filter switch for delivering registration notices.
-     * If passed an EE_Payment object, then it will trigger payment notifications instead.
-     *
-     * @access protected
-     * @param \EE_Payment | null $payment
-     */
-    protected function _maybe_send_notifications($payment = null)
-    {
-        switch ($payment instanceof EE_Payment) {
-            // payment notifications
-            case true :
-                if (
-                    isset(
-                        $this->_req_data['txn_payments'],
-                        $this->_req_data['txn_payments']['send_notifications']
-                    ) &&
-                    filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
-                ) {
-                    $this->_process_payment_notification($payment);
-                }
-                break;
-            // registration notifications
-            case false :
-                if (
-                    isset(
-                        $this->_req_data['txn_reg_status_change'],
-                        $this->_req_data['txn_reg_status_change']['send_notifications']
-                    ) &&
-                    filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
-                ) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                }
-                break;
-        }
-    }
-
-
-    /**
-     * _send_payment_reminder
-     *    generates HTML for the View Transaction Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _send_payment_reminder()
-    {
-        $TXN_ID      = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false;
-        $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-        $query_args  = isset($this->_req_data['redirect_to']) ? array(
-            'action' => $this->_req_data['redirect_to'],
-            'TXN_ID' => $this->_req_data['TXN_ID'],
-        ) : array();
-        do_action(
-            'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            $transaction
-        );
-        $this->_redirect_after_action(
-            false,
-            esc_html__('payment reminder', 'event_espresso'),
-            esc_html__('sent', 'event_espresso'),
-            $query_args,
-            true
-        );
-    }
-
-
-    /**
-     *  get_transactions
-     *    get transactions for given parameters (used by list table)
-     *
-     * @param  int     $perpage how many transactions displayed per page
-     * @param  boolean $count   return the count or objects
-     * @param string   $view
-     * @return mixed int = count || array of transaction objects
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transactions($perpage, $count = false, $view = '')
-    {
-
-        $TXN = EEM_Transaction::instance();
-
-        $start_date = isset($this->_req_data['txn-filter-start-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
-            : date(
-                'm/d/Y',
-                strtotime('-10 year')
-            );
-        $end_date   = isset($this->_req_data['txn-filter-end-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
-            : date('m/d/Y');
-
-        //make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-
-
-        //convert to timestamps
-        $start_date = strtotime($start_date);
-        $end_date   = strtotime($end_date);
-
-        //makes sure start date is the lowest value and vice versa
-        $start_date = min($start_date, $end_date);
-        $end_date   = max($start_date, $end_date);
-
-        //convert to correct format for query
-        $start_date = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $start_date),
-            'Y-m-d H:i:s'
-        );
-        $end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', $end_date),
-            'Y-m-d H:i:s'
-        );
-
-
-        //set orderby
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-
-        switch ($this->_req_data['orderby']) {
-            case 'TXN_ID':
-                $orderby = 'TXN_ID';
-                break;
-            case 'ATT_fname':
-                $orderby = 'Registration.Attendee.ATT_fname';
-                break;
-            case 'event_name':
-                $orderby = 'Registration.Event.EVT_name';
-                break;
-            default: //'TXN_timestamp'
-                $orderby = 'TXN_timestamp';
-        }
-
-        $sort         = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        $current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
-        $per_page     = ! empty($perpage) ? $perpage : 10;
-        $per_page     = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page;
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = array($offset, $per_page);
-
-        $_where = array(
-            'TXN_timestamp'          => array('BETWEEN', array($start_date, $end_date)),
-            'Registration.REG_count' => 1,
-        );
-
-        if (isset($this->_req_data['EVT_ID'])) {
-            $_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID'];
-        }
-
-        if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $_where['OR']  = array(
-                'Registration.Event.EVT_name'         => array('LIKE', $search_string),
-                'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
-                'Registration.Event.EVT_short_desc'   => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_fname'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_lname'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_email'     => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_address'   => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_address2'  => array('LIKE', $search_string),
-                'Registration.Attendee.ATT_city'      => array('LIKE', $search_string),
-                'Registration.REG_final_price'        => array('LIKE', $search_string),
-                'Registration.REG_code'               => array('LIKE', $search_string),
-                'Registration.REG_count'              => array('LIKE', $search_string),
-                'Registration.REG_group_size'         => array('LIKE', $search_string),
-                'Registration.Ticket.TKT_name'        => array('LIKE', $search_string),
-                'Registration.Ticket.TKT_description' => array('LIKE', $search_string),
-                'Payment.PAY_source'                  => array('LIKE', $search_string),
-                'Payment.Payment_Method.PMD_name'     => array('LIKE', $search_string),
-                'TXN_session_data'                    => array('LIKE', $search_string),
-                'Payment.PAY_txn_id_chq_nmbr'         => array('LIKE', $search_string),
-            );
-        }
-
-        //failed transactions
-        $failed    = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
-                     || ($count && $view === 'failed');
-        $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
-                     || ($count && $view === 'abandoned');
-
-        if ($failed) {
-            $_where['STS_ID'] = EEM_Transaction::failed_status_code;
-        } else if ($abandoned) {
-            $_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
-        } else {
-            $_where['STS_ID']  = array('!=', EEM_Transaction::failed_status_code);
-            $_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code);
-        }
-
-        $query_params = array(
-            $_where,
-            'order_by'                 => array($orderby => $sort),
-            'limit'                    => $limit,
-            'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
-        );
-
-        $transactions = $count
-            ? $TXN->count(array($_where), 'TXN_ID', true)
-            : $TXN->get_all($query_params);
-
-        return $transactions;
-    }
+	/**
+	 * @var EE_Transaction
+	 */
+	private $_transaction;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	/**
+	 * @var array $_txn_status
+	 */
+	private static $_txn_status;
+
+	/**
+	 * @var array $_pay_status
+	 */
+	private static $_pay_status;
+
+	/**
+	 * @var array $_existing_reg_payment_REG_IDs
+	 */
+	protected $_existing_reg_payment_REG_IDs = null;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	/**
+	 *    _init_page_props
+	 *
+	 * @return void
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = TXN_PG_SLUG;
+		$this->page_label       = esc_html__('Transactions', 'event_espresso');
+		$this->_admin_base_url  = TXN_ADMIN_URL;
+		$this->_admin_base_path = TXN_ADMIN;
+	}
+
+
+	/**
+	 *    _ajax_hooks
+	 *
+	 * @return void
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_apply_payment', array($this, 'apply_payments_or_refunds'));
+		add_action('wp_ajax_espresso_apply_refund', array($this, 'apply_payments_or_refunds'));
+		add_action('wp_ajax_espresso_delete_payment', array($this, 'delete_payment'));
+	}
+
+
+	/**
+	 *    _define_page_props
+	 *
+	 * @return void
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons' => array(
+				'add'    => esc_html__('Add New Transaction', 'event_espresso'),
+				'edit'   => esc_html__('Edit Transaction', 'event_espresso'),
+				'delete' => esc_html__('Delete Transaction', 'event_espresso'),
+			),
+		);
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _set_page_routes()
+	{
+
+		$this->_set_transaction_status_array();
+
+		$txn_id = ! empty($this->_req_data['TXN_ID'])
+				  && ! is_array($this->_req_data['TXN_ID'])
+			? $this->_req_data['TXN_ID']
+			: 0;
+
+		$this->_page_routes = array(
+
+			'default' => array(
+				'func'       => '_transactions_overview_list_table',
+				'capability' => 'ee_read_transactions',
+			),
+
+			'view_transaction' => array(
+				'func'       => '_transaction_details',
+				'capability' => 'ee_read_transaction',
+				'obj_id'     => $txn_id,
+			),
+
+			'send_payment_reminder' => array(
+				'func'       => '_send_payment_reminder',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+
+			'espresso_apply_payment' => array(
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			),
+
+			'espresso_apply_refund' => array(
+				'func'       => 'apply_payments_or_refunds',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payments',
+			),
+
+			'espresso_delete_payment' => array(
+				'func'       => 'delete_payment',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payments',
+			),
+
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'          => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'EE_Admin_Transactions_List_Table',
+				'help_tabs'     => array(
+					'transactions_overview_help_tab'                       => array(
+						'title'    => esc_html__('Transactions Overview', 'event_espresso'),
+						'filename' => 'transactions_overview',
+					),
+					'transactions_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Transactions Table Column Headings', 'event_espresso'),
+						'filename' => 'transactions_overview_table_column_headings',
+					),
+					'transactions_overview_views_filters_help_tab'         => array(
+						'title'    => esc_html__('Transaction Views & Filters & Search', 'event_espresso'),
+						'filename' => 'transactions_overview_views_filters_search',
+					),
+				),
+				'help_tour'     => array('Transactions_Overview_Help_Tour'),
+				/**
+				 * commented out because currently we are not displaying tips for transaction list table status but this
+				 * may change in a later iteration so want to keep the code for then.
+				 */
+				//'qtips' => array( 'Transactions_List_Table_Tips' ),
+				'require_nonce' => false,
+			),
+			'view_transaction' => array(
+				'nav'       => array(
+					'label'      => esc_html__('View Transaction', 'event_espresso'),
+					'order'      => 5,
+					'url'        => isset($this->_req_data['TXN_ID'])
+						? add_query_arg(array('TXN_ID' => $this->_req_data['TXN_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				),
+				'help_tabs' => array(
+					'transactions_view_transaction_help_tab'                                              => array(
+						'title'    => esc_html__('View Transaction', 'event_espresso'),
+						'filename' => 'transactions_view_transaction',
+					),
+					'transactions_view_transaction_transaction_details_table_help_tab'                    => array(
+						'title'    => esc_html__('Transaction Details Table', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_transaction_details_table',
+					),
+					'transactions_view_transaction_attendees_registered_help_tab'                         => array(
+						'title'    => esc_html__('Attendees Registered', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_attendees_registered',
+					),
+					'transactions_view_transaction_views_primary_registrant_billing_information_help_tab' => array(
+						'title'    => esc_html__('Primary Registrant & Billing Information', 'event_espresso'),
+						'filename' => 'transactions_view_transaction_primary_registrant_billing_information',
+					),
+				),
+				'qtips'     => array('Transaction_Details_Tips'),
+				'help_tour' => array('Transaction_Details_Help_Tour'),
+				'metaboxes' => array('_transaction_details_metaboxes'),
+
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+		//noop
+	}
+
+	protected function _add_feature_pointers()
+	{
+		//noop
+	}
+
+	public function admin_init()
+	{
+		// IF a registration was JUST added via the admin...
+		if (isset(
+			$this->_req_data['redirect_from'],
+			$this->_req_data['EVT_ID'],
+			$this->_req_data['event_name']
+		)) {
+			// then set a cookie so that we can block any attempts to use
+			// the back button as a way to enter another registration.
+			setcookie(
+				'ee_registration_added',
+				$this->_req_data['EVT_ID'], time() + WEEK_IN_SECONDS, '/'
+			);
+			// and update the global
+			$_COOKIE['ee_registration_added'] = $this->_req_data['EVT_ID'];
+		}
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = esc_html__(
+			'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
+			'An error occurred! Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['txn_status_array']        = self::$_txn_status;
+		EE_Registry::$i18n_js_strings['pay_status_array']        = self::$_pay_status;
+		EE_Registry::$i18n_js_strings['payments_total']          = esc_html__('Payments Total', 'event_espresso');
+		EE_Registry::$i18n_js_strings['transaction_overpaid']    = esc_html__(
+			'This transaction has been overpaid ! Payments Total',
+			'event_espresso'
+		);
+	}
+
+	public function admin_notices()
+	{
+		//noop
+	}
+
+	public function admin_footer_scripts()
+	{
+		//noop
+	}
+
+
+	/**
+	 * _set_transaction_status_array
+	 * sets list of transaction statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_transaction_status_array()
+	{
+		self::$_txn_status = EEM_Transaction::instance()->status_array(true);
+	}
+
+
+	/**
+	 * get_transaction_status_array
+	 * return the transaction status array for wp_list_table
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_transaction_status_array()
+	{
+		return self::$_txn_status;
+	}
+
+
+	/**
+	 *    get list of payment statuses
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_payment_status_array()
+	{
+		self::$_pay_status                      = EEM_Payment::instance()->status_array(true);
+		$this->_template_args['payment_status'] = self::$_pay_status;
+
+	}
+
+
+	/**
+	 *    _add_screen_options_default
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * load_scripts_styles
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles()
+	{
+		//enqueue style
+		wp_register_style(
+			'espresso_txn',
+			TXN_ASSETS_URL . 'espresso_transactions_admin.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_txn');
+		//scripts
+		wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array(
+			'ee_admin_js',
+			'ee-datepicker',
+			'jquery-ui-datepicker',
+			'jquery-ui-draggable',
+			'ee-dialog',
+			'ee-accounting',
+			'ee-serialize-full-array',
+		), EVENT_ESPRESSO_VERSION, true);
+		wp_enqueue_script('espresso_txn');
+	}
+
+
+	/**
+	 *    load_scripts_styles_view_transaction
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_view_transaction()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    load_scripts_styles_default
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_scripts_styles_default()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+	}
+
+
+	/**
+	 *    _set_list_table_views_default
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all'       => array(
+				'slug'  => 'all',
+				'label' => esc_html__('View All Transactions', 'event_espresso'),
+				'count' => 0,
+			),
+			'abandoned' => array(
+				'slug'  => 'abandoned',
+				'label' => esc_html__('Abandoned Transactions', 'event_espresso'),
+				'count' => 0,
+			),
+			'failed'    => array(
+				'slug'  => 'failed',
+				'label' => esc_html__('Failed Transactions', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+	/**
+	 * _set_transaction_object
+	 * This sets the _transaction property for the transaction details screen
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_transaction_object()
+	{
+		if ($this->_transaction instanceof EE_Transaction) {
+			return;
+		} //get out we've already set the object
+
+		$TXN_ID = ! empty($this->_req_data['TXN_ID'])
+			? absint($this->_req_data['TXN_ID'])
+			: false;
+
+		//get transaction object
+		$this->_transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$this->_session     = $this->_transaction instanceof EE_Transaction
+			? $this->_transaction->get('TXN_session_data')
+			: null;
+		$this->_transaction->verify_abandoned_transaction_status();
+
+		if (! $this->_transaction instanceof EE_Transaction) {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
+					'event_espresso'
+				),
+				$TXN_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 *    _transaction_legend_items
+	 *
+	 * @access protected
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _transaction_legend_items()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$items = array();
+
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (is_array($related_for_icon)
+				&& isset($related_for_icon['css_class'], $related_for_icon['label'])
+			) {
+				$items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+
+		$items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__items',
+			array_merge(
+				$items,
+				array(
+					'view_details'          => array(
+						'class' => 'dashicons dashicons-cart',
+						'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+					),
+					'view_invoice'          => array(
+						'class' => 'dashicons dashicons-media-spreadsheet',
+						'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+					),
+					'view_receipt'          => array(
+						'class' => 'dashicons dashicons-media-default',
+						'desc'  => esc_html__('View Transaction Receipt', 'event_espresso'),
+					),
+					'view_registration'     => array(
+						'class' => 'dashicons dashicons-clipboard',
+						'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+					),
+					'payment_overview_link' => array(
+						'class' => 'dashicons dashicons-money',
+						'desc'  => esc_html__('Make Payment on Frontend', 'event_espresso'),
+					),
+				)
+			)
+		);
+
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_transactions_send_payment_reminder'
+		)) {
+			if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
+				$items['send_payment_reminder'] = array(
+					'class' => 'dashicons dashicons-email-alt',
+					'desc'  => esc_html__('Send Payment Reminder', 'event_espresso'),
+				);
+			} else {
+				$items['blank*'] = array(
+					'class' => '',
+					'desc'  => '',
+				);
+			}
+		} else {
+			$items['blank*'] = array(
+				'class' => '',
+				'desc'  => '',
+			);
+		}
+		$more_items = apply_filters(
+			'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
+			array(
+				'overpaid'   => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::overpaid_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'complete'   => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::complete_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'incomplete' => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::incomplete_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'abandoned'  => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::abandoned_status_code,
+						false,
+						'sentence'
+					),
+				),
+				'failed'     => array(
+					'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
+					'desc'  => EEH_Template::pretty_status(
+						EEM_Transaction::failed_status_code,
+						false,
+						'sentence'
+					),
+				),
+			)
+		);
+
+		return array_merge($items, $more_items);
+	}
+
+
+	/**
+	 *    _transactions_overview_list_table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _transactions_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Transactions', 'event_espresso');
+		$event = isset($this->_req_data['EVT_ID'])
+			? EEM_Event::instance()->get_one_by_ID($this->_req_data['EVT_ID'])
+			: null;
+		$this->_template_args['admin_page_header'] = $event instanceof EE_Event
+			? sprintf(
+				esc_html__(
+					'%sViewing Transactions for the Event: %s%s',
+					'event_espresso'
+				),
+				'<h3>',
+				'<a href="'
+				. EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'edit', 'post' => $event->ID()),
+					EVENTS_ADMIN_URL
+				)
+				. '" title="'
+				. esc_attr__(
+					'Click to Edit event',
+					'event_espresso'
+				)
+				. '">' . $event->get('EVT_name') . '</a>',
+				'</h3>'
+			)
+			: '';
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *    _transaction_details
+	 * generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details()
+	{
+		do_action('AHEE__Transactions_Admin_Page__transaction_details__start', $this->_transaction);
+
+		$this->_set_transaction_status_array();
+
+		$this->_template_args                      = array();
+		$this->_template_args['transactions_page'] = $this->_wp_page_slug;
+
+		$this->_set_transaction_object();
+
+		$primary_registration = $this->_transaction->primary_registration();
+		$attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: null;
+
+		$this->_template_args['txn_nmbr']['value'] = $this->_transaction->ID();
+		$this->_template_args['txn_nmbr']['label'] = esc_html__('Transaction Number', 'event_espresso');
+
+		$this->_template_args['txn_datetime']['value'] = $this->_transaction->get_i18n_datetime('TXN_timestamp');
+		$this->_template_args['txn_datetime']['label'] = esc_html__('Date', 'event_espresso');
+
+		$this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')];
+		$this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
+		$this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
+
+		$this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
+		$this->_template_args['total_paid']  = $this->_transaction->get('TXN_paid');
+
+		$amount_due = $this->_transaction->get('TXN_total') - $this->_transaction->get('TXN_paid');
+		$this->_template_args['amount_due'] = EEH_Template::format_currency(
+			$amount_due,
+			true
+		);
+		if (EE_Registry::instance()->CFG->currency->sign_b4) {
+			$this->_template_args['amount_due'] = EE_Registry::instance()->CFG->currency->sign
+												  . $this->_template_args['amount_due'];
+		} else {
+			$this->_template_args['amount_due'] .= EE_Registry::instance()->CFG->currency->sign;
+		}
+		$this->_template_args['amount_due_class'] = '';
+
+		if ($this->_transaction->get('TXN_paid') == $this->_transaction->get('TXN_total')) {
+			// paid in full
+			$this->_template_args['amount_due'] = false;
+		} elseif ($this->_transaction->get('TXN_paid') > $this->_transaction->get('TXN_total')) {
+			// overpaid
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif ($this->_transaction->get('TXN_total') > 0
+				  && $this->_transaction->get('TXN_paid') > 0
+		) {
+			// monies owing
+			$this->_template_args['amount_due_class'] = 'txn-overview-part-payment-spn';
+		} elseif ($this->_transaction->get('TXN_total') > 0
+				  && $this->_transaction->get('TXN_paid') == 0
+		) {
+			// no payments made yet
+			$this->_template_args['amount_due_class'] = 'txn-overview-no-payment-spn';
+		} elseif ($this->_transaction->get('TXN_total') == 0) {
+			// free event
+			$this->_template_args['amount_due'] = false;
+		}
+
+		$payment_method = $this->_transaction->payment_method();
+
+		$this->_template_args['method_of_payment_name'] = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		// link back to overview
+		$this->_template_args['txn_overview_url'] = ! empty($_SERVER['HTTP_REFERER'])
+			? $_SERVER['HTTP_REFERER']
+			: TXN_ADMIN_URL;
+
+
+		// next link
+		$next_txn                                 = $this->_transaction->next(
+			null,
+			array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
+			'TXN_ID'
+		);
+		$this->_template_args['next_transaction'] = $next_txn
+			? $this->_next_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $next_txn['TXN_ID']),
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-right ee-icon-size-22'
+			)
+			: '';
+		// previous link
+		$previous_txn                                 = $this->_transaction->previous(
+			null,
+			array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
+			'TXN_ID'
+		);
+		$this->_template_args['previous_transaction'] = $previous_txn
+			? $this->_previous_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $previous_txn['TXN_ID']),
+					TXN_ADMIN_URL
+				),
+				'dashicons dashicons-arrow-left ee-icon-size-22'
+			)
+			: '';
+
+		// were we just redirected here after adding a new registration ???
+		if (isset(
+			$this->_req_data['redirect_from'],
+			$this->_req_data['EVT_ID'],
+			$this->_req_data['event_name']
+		)) {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$this->_req_data['EVT_ID']
+			)) {
+				$this->_admin_page_title .= '<a id="add-new-registration" class="add-new-h2 button-primary" href="';
+				$this->_admin_page_title .= EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page'     => 'espresso_registrations',
+						'action'   => 'new_registration',
+						'return'   => 'default',
+						'TXN_ID'   => $this->_transaction->ID(),
+						'event_id' => $this->_req_data['EVT_ID'],
+					),
+					REG_ADMIN_URL
+				);
+				$this->_admin_page_title .= '">';
+
+				$this->_admin_page_title .= sprintf(
+					esc_html__('Add Another New Registration to Event: "%1$s" ?', 'event_espresso'),
+					htmlentities(urldecode($this->_req_data['event_name']), ENT_QUOTES, 'UTF-8')
+				);
+				$this->_admin_page_title .= '</a>';
+			}
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// grab messages at the last second
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		// path to template
+		$template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+		$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+
+	}
+
+
+	/**
+	 *        _transaction_details_metaboxes
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	protected function _transaction_details_metaboxes()
+	{
+
+		$this->_set_transaction_object();
+
+		add_meta_box(
+			'edit-txn-details-mbox',
+			esc_html__('Transaction Details', 'event_espresso'),
+			array($this, 'txn_details_meta_box'),
+			$this->_wp_page_slug,
+			'normal',
+			'high'
+		);
+		add_meta_box(
+			'edit-txn-attendees-mbox',
+			esc_html__('Attendees Registered in this Transaction', 'event_espresso'),
+			array($this, 'txn_attendees_meta_box'),
+			$this->_wp_page_slug,
+			'normal',
+			'high',
+			array('TXN_ID' => $this->_transaction->ID())
+		);
+		add_meta_box(
+			'edit-txn-registrant-mbox',
+			esc_html__('Primary Contact', 'event_espresso'),
+			array($this, 'txn_registrant_side_meta_box'),
+			$this->_wp_page_slug,
+			'side',
+			'high'
+		);
+		add_meta_box(
+			'edit-txn-billing-info-mbox',
+			esc_html__('Billing Information', 'event_espresso'),
+			array($this, 'txn_billing_info_side_meta_box'),
+			$this->_wp_page_slug,
+			'side',
+			'high'
+		);
+	}
+
+
+	/**
+	 * Callback for transaction actions metabox.
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function getActionButtons(EE_Transaction $transaction = null)
+	{
+		$content = '';
+		$actions = array();
+		if (! $transaction instanceof EE_Transaction) {
+			return $content;
+		}
+		/** @var EE_Registration $primary_registration */
+		$primary_registration = $transaction->primary_registration();
+		$attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: null;
+
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$actions['payment_reminder'] =
+				EEH_MSG_Template::is_mt_active('payment_reminder')
+				&& $this->_transaction->get('STS_ID') !== EEM_Transaction::complete_status_code
+				&& $this->_transaction->get('STS_ID') !== EEM_Transaction::overpaid_status_code
+					? EEH_Template::get_button_or_link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action'      => 'send_payment_reminder',
+								'TXN_ID'      => $this->_transaction->ID(),
+								'redirect_to' => 'view_transaction',
+							),
+							TXN_ADMIN_URL
+						),
+						esc_html__(' Send Payment Reminder', 'event_espresso'),
+						'button secondary-button',
+						'dashicons dashicons-email-alt'
+					)
+					: '';
+		}
+
+		if ($primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('receipt')
+		) {
+			$actions['receipt'] = EEH_Template::get_button_or_link(
+				$primary_registration->receipt_url(),
+				esc_html__('View Receipt', 'event_espresso'),
+				'button secondary-button',
+				'dashicons dashicons-media-default'
+			);
+		}
+
+		if ($primary_registration instanceof EE_Registration
+			&& EEH_MSG_Template::is_mt_active('invoice')
+		) {
+			$actions['invoice'] = EEH_Template::get_button_or_link(
+				$primary_registration->invoice_url(),
+				esc_html__('View Invoice', 'event_espresso'),
+				'button secondary-button',
+				'dashicons dashicons-media-spreadsheet'
+			);
+		}
+		$actions = array_filter(
+			apply_filters('FHEE__Transactions_Admin_Page__getActionButtons__actions', $actions, $transaction)
+		);
+		if ($actions) {
+			$content = '<ul>';
+			$content .= '<li>' . implode('</li><li>', $actions) . '</li>';
+			$content .= '</uL>';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * txn_details_meta_box
+	 * generates HTML for the Transaction main meta box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function txn_details_meta_box()
+	{
+		$this->_set_transaction_object();
+		$this->_template_args['TXN_ID']   = $this->_transaction->ID();
+		$this->_template_args['attendee'] = $this->_transaction->primary_registration() instanceof EE_Registration
+			? $this->_transaction->primary_registration()->attendee()
+			: null;
+		$this->_template_args['can_edit_payments'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		$this->_template_args['can_delete_payments'] = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+
+		//get line table
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display                       = new EE_Line_Item_Display(
+			'admin_table',
+			'EE_Admin_Table_Line_Item_Display_Strategy'
+		);
+		$this->_template_args['line_item_table'] = $Line_Item_Display->display_line_item(
+			$this->_transaction->total_line_item()
+		);
+		$this->_template_args['REG_code']        = $this->_transaction->get_first_related('Registration')
+																	  ->get('REG_code');
+
+		// process taxes
+		$taxes                         = $this->_transaction->get_many_related(
+			'Line_Item',
+			array(array('LIN_type' => EEM_Line_Item::type_tax))
+		);
+		$this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
+
+		$this->_template_args['grand_total']     = EEH_Template::format_currency(
+			$this->_transaction->get('TXN_total'),
+			false,
+			false
+		);
+		$this->_template_args['grand_raw_total'] = $this->_transaction->get('TXN_total');
+		$this->_template_args['TXN_status']      = $this->_transaction->get('STS_ID');
+
+		// process payment details
+		$payments = $this->_transaction->get_many_related('Payment');
+		if (! empty($payments)) {
+			$this->_template_args['payments']              = $payments;
+			$this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
+		} else {
+			$this->_template_args['payments']              = false;
+			$this->_template_args['existing_reg_payments'] = array();
+		}
+
+		$this->_template_args['edit_payment_url']   = add_query_arg(array('action' => 'edit_payment'), TXN_ADMIN_URL);
+		$this->_template_args['delete_payment_url'] = add_query_arg(
+			array('action' => 'espresso_delete_payment'),
+			TXN_ADMIN_URL
+		);
+
+		if (isset($txn_details['invoice_number'])) {
+			$this->_template_args['txn_details']['invoice_number']['value'] = $this->_template_args['REG_code'];
+			$this->_template_args['txn_details']['invoice_number']['label'] = esc_html__(
+				'Invoice Number',
+				'event_espresso'
+			);
+		}
+
+		$this->_template_args['txn_details']['registration_session']['value'] = $this->_transaction
+			->get_first_related('Registration')
+			->get('REG_session');
+		$this->_template_args['txn_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['ip_address']['value'] = isset($this->_session['ip_address'])
+			? $this->_session['ip_address']
+			: '';
+		$this->_template_args['txn_details']['ip_address']['label'] = esc_html__(
+			'Transaction placed from IP',
+			'event_espresso'
+		);
+
+		$this->_template_args['txn_details']['user_agent']['value'] = isset($this->_session['user_agent'])
+			? $this->_session['user_agent']
+			: '';
+		$this->_template_args['txn_details']['user_agent']['label'] = esc_html__(
+			'Registrant User Agent',
+			'event_espresso'
+		);
+
+		$reg_steps = '<ul>';
+		foreach ($this->_transaction->reg_steps() as $reg_step => $reg_step_status) {
+			if ($reg_step_status === true) {
+				$reg_steps .= '<li style="color:#70cc50">'
+							  . sprintf(
+								  esc_html__('%1$s : Completed', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</li>';
+			} elseif (is_numeric($reg_step_status) && $reg_step_status !== false) {
+				$reg_steps .= '<li style="color:#2EA2CC">'
+							  . sprintf(
+								  esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step)),
+								  date(
+									  get_option('date_format') . ' ' . get_option('time_format'),
+									  ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS))
+								  )
+							  )
+							  . '</li>';
+			} else {
+				$reg_steps .= '<li style="color:#E76700">'
+							  . sprintf(
+								  esc_html__('%1$s : Never Initiated', 'event_espresso'),
+								  ucwords(str_replace('_', ' ', $reg_step))
+							  )
+							  . '</li>';
+			}
+		}
+		$reg_steps                                                 .= '</ul>';
+		$this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
+		$this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
+			'Registration Step Progress',
+			'event_espresso'
+		);
+
+
+		$this->_get_registrations_to_apply_payment_to();
+		$this->_get_payment_methods($payments);
+		$this->_get_payment_status_array();
+		$this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction.
+
+		$this->_template_args['transaction_form_url']    = add_query_arg(array(
+			'action'  => 'edit_transaction',
+			'process' => 'transaction',
+		), TXN_ADMIN_URL);
+		$this->_template_args['apply_payment_form_url']  = add_query_arg(array(
+			'page'   => 'espresso_transactions',
+			'action' => 'espresso_apply_payment',
+		), WP_AJAX_URL);
+		$this->_template_args['delete_payment_form_url'] = add_query_arg(array(
+			'page'   => 'espresso_transactions',
+			'action' => 'espresso_delete_payment',
+		), WP_AJAX_URL);
+
+		$this->_template_args['action_buttons'] = $this->getActionButtons($this->_transaction);
+
+		// 'espresso_delete_payment_nonce'
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * _get_registration_payment_IDs
+	 *    generates an array of Payment IDs and their corresponding Registration IDs
+	 *
+	 * @access protected
+	 * @param EE_Payment[] $payments
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_registration_payment_IDs($payments = array())
+	{
+		$existing_reg_payments = array();
+		// get all reg payments for these payments
+		$reg_payments = EEM_Registration_Payment::instance()->get_all(array(
+			array(
+				'PAY_ID' => array(
+					'IN',
+					array_keys($payments),
+				),
+			),
+		));
+		if (! empty($reg_payments)) {
+			foreach ($payments as $payment) {
+				if (! $payment instanceof EE_Payment) {
+					continue;
+				} elseif (! isset($existing_reg_payments[$payment->ID()])) {
+					$existing_reg_payments[$payment->ID()] = array();
+				}
+				foreach ($reg_payments as $reg_payment) {
+					if ($reg_payment instanceof EE_Registration_Payment
+						&& $reg_payment->payment_ID() === $payment->ID()
+					) {
+						$existing_reg_payments[$payment->ID()][] = $reg_payment->registration_ID();
+					}
+				}
+			}
+		}
+
+		return $existing_reg_payments;
+	}
+
+
+	/**
+	 * _get_registrations_to_apply_payment_to
+	 *    generates HTML for displaying a series of checkboxes in the admin payment modal window
+	 * which allows the admin to only apply the payment to the specific registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _get_registrations_to_apply_payment_to()
+	{
+		// we want any registration with an active status (ie: not deleted or cancelled)
+		$query_params                      = array(
+			array(
+				'STS_ID' => array(
+					'IN',
+					array(
+						EEM_Registration::status_id_approved,
+						EEM_Registration::status_id_pending_payment,
+						EEM_Registration::status_id_not_approved,
+					),
+				),
+			),
+		);
+		$registrations_to_apply_payment_to = EEH_HTML::br()
+											 . EEH_HTML::div(
+												 '',
+												 'txn-admin-apply-payment-to-registrations-dv',
+												 '',
+												 'clear: both; margin: 1.5em 0 0; display: none;'
+											 );
+		$registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+		$registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
+		$registrations_to_apply_payment_to .= EEH_HTML::thead(
+			EEH_HTML::tr(
+				EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
+				EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+				EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
+			)
+		);
+		$registrations_to_apply_payment_to .= EEH_HTML::tbody();
+		// get registrations for TXN
+		$registrations = $this->_transaction->registrations($query_params);
+		$existing_reg_payments = $this->_template_args['existing_reg_payments'];
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$attendee_name                     = $registration->attendee() instanceof EE_Attendee
+					? $registration->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$owing                             = $registration->final_price() - $registration->paid();
+				$taxable                           = $registration->ticket()->taxable()
+					? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+					: '';
+				$checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
+					? ' checked="checked"'
+					: '';
+				$disabled                          = $registration->final_price() > 0 ? '' : ' disabled';
+				$registrations_to_apply_payment_to .= EEH_HTML::tr(
+					EEH_HTML::td($registration->ID()) .
+					EEH_HTML::td($attendee_name) .
+					EEH_HTML::td(
+						$registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
+					) .
+					EEH_HTML::td($registration->event_name()) .
+					EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
+					EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
+					EEH_HTML::td(
+						'<input type="checkbox" value="' . $registration->ID()
+						. '" name="txn_admin_payment[registrations]"'
+						. $checked . $disabled . '>',
+						'',
+						'jst-cntr'
+					),
+					'apply-payment-registration-row-' . $registration->ID()
+				);
+			}
+		}
+		$registrations_to_apply_payment_to                         .= EEH_HTML::tbodyx();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::tablex();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+		$registrations_to_apply_payment_to                         .= EEH_HTML::p(
+			esc_html__(
+				'The payment will only be applied to the registrations that have a check mark in their corresponding check box. Checkboxes for free registrations have been disabled.',
+				'event_espresso'
+			),
+			'',
+			'clear description'
+		);
+		$registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+		$this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
+	}
+
+
+	/**
+	 * _get_reg_status_selection
+	 *
+	 * @todo   this will need to be adjusted either once MER comes along OR we move default reg status to tickets
+	 *         instead of events.
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _get_reg_status_selection()
+	{
+		//first get all possible statuses
+		$statuses = EEM_Registration::reg_status_array(array(), true);
+		//let's add a "don't change" option.
+		$status_array['NAN']                                 = esc_html__('Leave the Same', 'event_espresso');
+		$status_array                                        = array_merge($status_array, $statuses);
+		$this->_template_args['status_change_select']        = EEH_Form_Fields::select_input(
+			'txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'id="txn-admin-payment-reg-status-inp"',
+			'txn-reg-status-change-reg-status'
+		);
+		$this->_template_args['delete_status_change_select'] = EEH_Form_Fields::select_input(
+			'delete_txn_reg_status_change[reg_status]',
+			$status_array,
+			'NAN',
+			'delete-txn-admin-payment-reg-status-inp',
+			'delete-txn-reg-status-change-reg-status'
+		);
+	}
+
+
+	/**
+	 *    _get_payment_methods
+	 * Gets all the payment methods available generally, or the ones that are already
+	 * selected on these payments (in case their payment methods are no longer active).
+	 * Has the side-effect of updating the template args' payment_methods item
+	 *
+	 * @access private
+	 * @param EE_Payment[] to show on this page
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _get_payment_methods($payments = array())
+	{
+		$payment_methods_of_payments = array();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment) {
+				$payment_methods_of_payments[] = $payment->get('PMD_ID');
+			}
+		}
+		if ($payment_methods_of_payments) {
+			$query_args = array(
+				array(
+					'OR*payment_method_for_payment' => array(
+						'PMD_ID'    => array('IN', $payment_methods_of_payments),
+						'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'),
+					),
+				),
+			);
+		} else {
+			$query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
+		}
+		$this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
+	}
+
+
+	/**
+	 * txn_attendees_meta_box
+	 *    generates HTML for the Attendees Transaction main meta box
+	 *
+	 * @access public
+	 * @param WP_Post $post
+	 * @param array   $metabox
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function txn_attendees_meta_box($post, $metabox = array('args' => array()))
+	{
+
+		/** @noinspection NonSecureExtractUsageInspection */
+		extract($metabox['args']);
+		$this->_template_args['post']            = $post;
+		$this->_template_args['event_attendees'] = array();
+		// process items in cart
+		$line_items = $this->_transaction->get_many_related(
+			'Line_Item',
+			array(array('LIN_type' => 'line-item'))
+		);
+		if (! empty($line_items)) {
+			foreach ($line_items as $item) {
+				if ($item instanceof EE_Line_Item) {
+					switch ($item->OBJ_type()) {
+						case 'Event':
+							break;
+						case 'Ticket':
+							$ticket = $item->ticket();
+							//right now we're only handling tickets here.
+							//Cause its expected that only tickets will have attendees right?
+							if (! $ticket instanceof EE_Ticket) {
+								continue;
+							}
+							try {
+								$event_name = $ticket->get_event_name();
+							} catch (Exception $e) {
+								EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+								$event_name = esc_html__('Unknown Event', 'event_espresso');
+							}
+							$event_name   .= ' - ' . $item->get('LIN_name');
+							$ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
+							// now get all of the registrations for this transaction that use this ticket
+							$registrations = $ticket->get_many_related(
+								'Registration',
+								array(array('TXN_ID' => $this->_transaction->ID()))
+							);
+							foreach ($registrations as $registration) {
+								if (! $registration instanceof EE_Registration) {
+									continue;
+								}
+								$this->_template_args['event_attendees'][$registration->ID()]['STS_ID']
+									= $registration->status_ID();
+								$this->_template_args['event_attendees'][$registration->ID()]['att_num']
+									= $registration->count();
+								$this->_template_args['event_attendees'][$registration->ID()]['event_ticket_name']
+									= $event_name;
+								$this->_template_args['event_attendees'][$registration->ID()]['ticket_price']
+									= $ticket_price;
+								// attendee info
+								$attendee = $registration->get_first_related('Attendee');
+								if ($attendee instanceof EE_Attendee) {
+									$this->_template_args['event_attendees'][$registration->ID()]['att_id']
+										= $attendee->ID();
+									$this->_template_args['event_attendees'][$registration->ID()]['attendee']
+										= $attendee->full_name();
+									$this->_template_args['event_attendees'][$registration->ID()]['email']
+										= '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
+										  . esc_html__(
+											  ' Event',
+											  'event_espresso'
+										  )
+										  . '">' . $attendee->email() . '</a>';
+									$this->_template_args['event_attendees'][$registration->ID()]['address']
+										= EEH_Address::format($attendee, 'inline', false, false);
+								} else {
+									$this->_template_args['event_attendees'][$registration->ID()]['att_id']   = '';
+									$this->_template_args['event_attendees'][$registration->ID()]['attendee'] = '';
+									$this->_template_args['event_attendees'][$registration->ID()]['email']    = '';
+									$this->_template_args['event_attendees'][$registration->ID()]['address']  = '';
+								}
+							}
+							break;
+
+					}
+				}
+			}
+
+			$this->_template_args['transaction_form_url'] = add_query_arg(
+				array(
+					'action'  => 'edit_transaction',
+					'process' => 'attendees',
+				),
+				TXN_ADMIN_URL
+			);
+			echo EEH_Template::display_template(
+				TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+				$this->_template_args,
+				true
+			);
+
+		} else {
+			echo sprintf(
+				esc_html__(
+					'%1$sFor some reason, there are no attendees registered for this transaction. Likely the registration was abandoned in process.%2$s',
+					'event_espresso'
+				),
+				'<p class="important-notice">',
+				'</p>'
+			);
+		}
+	}
+
+
+	/**
+	 * txn_registrant_side_meta_box
+	 * generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_registrant_side_meta_box()
+	{
+		$primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
+			? $this->_transaction->primary_registration()->get_first_related('Attendee')
+			: null;
+		if (! $primary_att instanceof EE_Attendee) {
+			$this->_template_args['no_attendee_message'] = esc_html__(
+				'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
+				'event_espresso'
+			);
+			$primary_att                                 = EEM_Attendee::instance()->create_default_object();
+		}
+		$this->_template_args['ATT_ID']            = $primary_att->ID();
+		$this->_template_args['prime_reg_fname']   = $primary_att->fname();
+		$this->_template_args['prime_reg_lname']   = $primary_att->lname();
+		$this->_template_args['prime_reg_email']   = $primary_att->email();
+		$this->_template_args['prime_reg_phone']   = $primary_att->phone();
+		$this->_template_args['edit_attendee_url'] = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'edit_attendee',
+			'post'   => $primary_att->ID(),
+		), REG_ADMIN_URL);
+		// get formatted address for registrant
+		$this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
+		echo EEH_Template::display_template(
+			TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * txn_billing_info_side_meta_box
+	 *    generates HTML for the Edit Transaction side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function txn_billing_info_side_meta_box()
+	{
+
+		$this->_template_args['billing_form']     = $this->_transaction->billing_info();
+		$this->_template_args['billing_form_url'] = add_query_arg(
+			array('action' => 'edit_transaction', 'process' => 'billing'),
+			TXN_ADMIN_URL
+		);
+
+		$template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
+	}
+
+
+	/**
+	 * apply_payments_or_refunds
+	 *    registers a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function apply_payments_or_refunds()
+	{
+		$json_response_data = array('return_data' => false);
+		$valid_data         = $this->_validate_payment_request_data();
+		$has_access = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_payments',
+			'apply_payment_or_refund_from_registration_details'
+		);
+		if (! empty($valid_data) && $has_access) {
+			$PAY_ID = $valid_data['PAY_ID'];
+			//save  the new payment
+			$payment = $this->_create_payment_from_request_data($valid_data);
+			// get the TXN for this payment
+			$transaction = $payment->transaction();
+			// verify transaction
+			if ($transaction instanceof EE_Transaction) {
+				// calculate_total_payments_and_update_status
+				$this->_process_transaction_payments($transaction);
+				$REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
+				$this->_remove_existing_registration_payments($payment, $PAY_ID);
+				// apply payment to registrations (if applicable)
+				if (! empty($REG_IDs)) {
+					$this->_update_registration_payments($transaction, $payment, $REG_IDs);
+					$this->_maybe_send_notifications();
+					// now process status changes for the same registrations
+					$this->_process_registration_status_change($transaction, $REG_IDs);
+				}
+				$this->_maybe_send_notifications($payment);
+				//prepare to render page
+				$json_response_data['return_data'] = $this->_build_payment_json_response($payment, $REG_IDs);
+				do_action(
+					'AHEE__Transactions_Admin_Page__apply_payments_or_refund__after_recording',
+					$transaction,
+					$payment
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Transaction for this payment could not be retrieved.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			if ($has_access) {
+				EE_Error::add_error(
+					esc_html__(
+						'The payment form data could not be processed. Please try again.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'You do not have access to apply payments or refunds to a registration.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$notices              = EE_Error::get_notices(
+			false,
+			false,
+			false
+		);
+		$this->_template_args = array(
+			'data'    => $json_response_data,
+			'error'   => $notices['errors'],
+			'success' => $notices['success'],
+		);
+		$this->_return_json();
+	}
+
+
+	/**
+	 * _validate_payment_request_data
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _validate_payment_request_data()
+	{
+		if (! isset($this->_req_data['txn_admin_payment'])) {
+			return false;
+		}
+		$payment_form = $this->_generate_payment_form_section();
+		try {
+			if ($payment_form->was_submitted()) {
+				$payment_form->receive_form_submission();
+				if (! $payment_form->is_valid()) {
+					$submission_error_messages = array();
+					foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
+						if ($validation_error instanceof EE_Validation_Error) {
+							$submission_error_messages[] = sprintf(
+								_x('%s : %s', 'Form Section Name : Form Validation Error', 'event_espresso'),
+								$validation_error->get_form_section()->html_label_text(),
+								$validation_error->getMessage()
+							);
+						}
+					}
+					EE_Error::add_error(
+						implode('<br />', $submission_error_messages),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+
+					return array();
+				}
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+
+			return array();
+		}
+
+		return $payment_form->valid_data();
+	}
+
+
+	/**
+	 * _generate_payment_form_section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _generate_payment_form_section()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'        => 'txn_admin_payment',
+				'subsections' => array(
+					'PAY_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => false,
+							'html_label_text'       => esc_html__('Payment ID', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'TXN_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Transaction ID', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'type'            => new EE_Text_Input(
+						array(
+							'default'               => 1,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment or Refund', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'amount'          => new EE_Text_Input(
+						array(
+							'default'               => 0,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment amount', 'event_espresso'),
+							'validation_strategies' => array(new EE_Float_Normalization()),
+						)
+					),
+					'status'          => new EE_Text_Input(
+						array(
+							'default'         => EEM_Payment::status_id_approved,
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment status', 'event_espresso'),
+						)
+					),
+					'PMD_ID'          => new EE_Text_Input(
+						array(
+							'default'               => 2,
+							'required'              => true,
+							'html_label_text'       => esc_html__('Payment Method', 'event_espresso'),
+							'validation_strategies' => array(new EE_Int_Normalization()),
+						)
+					),
+					'date'            => new EE_Text_Input(
+						array(
+							'default'         => time(),
+							'required'        => true,
+							'html_label_text' => esc_html__('Payment date', 'event_espresso'),
+						)
+					),
+					'txn_id_chq_nmbr' => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Transaction or Cheque Number', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							),
+						)
+					),
+					'po_number'       => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Purchase Order Number', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							),
+						)
+					),
+					'accounting'      => new EE_Text_Input(
+						array(
+							'default'               => '',
+							'required'              => false,
+							'html_label_text'       => esc_html__('Extra Field for Accounting', 'event_espresso'),
+							'validation_strategies' => array(
+								new EE_Max_Length_Validation_Strategy(
+									esc_html__('Input too long', 'event_espresso'),
+									100
+								),
+							),
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _create_payment_from_request_data
+	 *
+	 * @param array $valid_data
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	protected function _create_payment_from_request_data($valid_data)
+	{
+		$PAY_ID = $valid_data['PAY_ID'];
+		// get payment amount
+		$amount = $valid_data['amount'] ? abs($valid_data['amount']) : 0;
+		// payments have a type value of 1 and refunds have a type value of -1
+		// so multiplying amount by type will give a positive value for payments, and negative values for refunds
+		$amount = $valid_data['type'] < 0 ? $amount * -1 : $amount;
+		// for some reason the date string coming in has extra spaces between the date and time.  This fixes that.
+		$date    = $valid_data['date']
+			? preg_replace('/\s+/', ' ', $valid_data['date'])
+			: date('Y-m-d g:i a', current_time('timestamp'));
+		$payment = EE_Payment::new_instance(
+			array(
+				'TXN_ID'              => $valid_data['TXN_ID'],
+				'STS_ID'              => $valid_data['status'],
+				'PAY_timestamp'       => $date,
+				'PAY_source'          => EEM_Payment_Method::scope_admin,
+				'PMD_ID'              => $valid_data['PMD_ID'],
+				'PAY_amount'          => $amount,
+				'PAY_txn_id_chq_nmbr' => $valid_data['txn_id_chq_nmbr'],
+				'PAY_po_number'       => $valid_data['po_number'],
+				'PAY_extra_accntng'   => $valid_data['accounting'],
+				'PAY_details'         => $valid_data,
+				'PAY_ID'              => $PAY_ID,
+			),
+			'',
+			array('Y-m-d', 'g:i a')
+		);
+
+		if (! $payment->save()) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
+					$payment->ID()
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * _process_transaction_payments
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_transaction_payments(EE_Transaction $transaction)
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		//update the transaction with this payment
+		if ($transaction_payments->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_success(esc_html__(
+				'The payment has been processed successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'The payment was processed successfully but the amount paid for the transaction was not updated.',
+					'event_espresso'
+				)
+				,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _get_REG_IDs_to_apply_payment_to
+	 * returns a list of registration IDs that the payment will apply to
+	 *
+	 * @param \EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_REG_IDs_to_apply_payment_to(EE_Payment $payment)
+	{
+		$REG_IDs = array();
+		// grab array of IDs for specific registrations to apply changes to
+		if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
+			$REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations'];
+		}
+		//nothing specified ? then get all reg IDs
+		if (empty($REG_IDs)) {
+			$registrations = $payment->transaction()->registrations();
+			$REG_IDs       = ! empty($registrations)
+				? array_keys($registrations)
+				: $this->_get_existing_reg_payment_REG_IDs($payment);
+		}
+
+		// ensure that REG_IDs are integers and NOT strings
+		return array_map('intval', $REG_IDs);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function existing_reg_payment_REG_IDs()
+	{
+		return $this->_existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * @param array $existing_reg_payment_REG_IDs
+	 */
+	public function set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs = null)
+	{
+		$this->_existing_reg_payment_REG_IDs = $existing_reg_payment_REG_IDs;
+	}
+
+
+	/**
+	 * _get_existing_reg_payment_REG_IDs
+	 * returns a list of registration IDs that the payment is currently related to
+	 * as recorded in the database
+	 *
+	 * @param \EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_existing_reg_payment_REG_IDs(EE_Payment $payment)
+	{
+		if ($this->existing_reg_payment_REG_IDs() === null) {
+			// let's get any existing reg payment records for this payment
+			$existing_reg_payment_REG_IDs = $payment->get_many_related('Registration');
+			// but we only want the REG IDs, so grab the array keys
+			$existing_reg_payment_REG_IDs = ! empty($existing_reg_payment_REG_IDs)
+				? array_keys($existing_reg_payment_REG_IDs)
+				: array();
+			$this->set_existing_reg_payment_REG_IDs($existing_reg_payment_REG_IDs);
+		}
+
+		return $this->existing_reg_payment_REG_IDs();
+	}
+
+
+	/**
+	 * _remove_existing_registration_payments
+	 * this calculates the difference between existing relations
+	 * to the supplied payment and the new list registration IDs,
+	 * removes any related registrations that no longer apply,
+	 * and then updates the registration paid fields
+	 *
+	 * @param \EE_Payment $payment
+	 * @param int         $PAY_ID
+	 * @return bool;
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _remove_existing_registration_payments(EE_Payment $payment, $PAY_ID = 0)
+	{
+		// newly created payments will have nothing recorded for $PAY_ID
+		if ($PAY_ID == 0) {
+			return false;
+		}
+		$existing_reg_payment_REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+		if (empty($existing_reg_payment_REG_IDs)) {
+			return false;
+		}
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+
+		return $transaction_payments->delete_registration_payments_and_update_registrations(
+			$payment,
+			array(
+				array(
+					'PAY_ID' => $payment->ID(),
+					'REG_ID' => array('IN', $existing_reg_payment_REG_IDs),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _update_registration_payments
+	 * this applies the payments to the selected registrations
+	 * but only if they have not already been paid for
+	 *
+	 * @param  EE_Transaction $transaction
+	 * @param \EE_Payment     $payment
+	 * @param array           $REG_IDs
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$REG_IDs = array()
+	) {
+		// we can pass our own custom set of registrations to EE_Payment_Processor::process_registration_payments()
+		// so let's do that using our set of REG_IDs from the form
+		$registration_query_where_params = array(
+			'REG_ID' => array('IN', $REG_IDs),
+		);
+		// but add in some conditions regarding payment,
+		// so that we don't apply payments to registrations that are free or have already been paid for
+		// but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
+		if (! $payment->is_a_refund()) {
+			$registration_query_where_params['REG_final_price']  = array('!=', 0);
+			$registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
+		}
+		$registrations = $transaction->registrations(array($registration_query_where_params));
+		if (! empty($registrations)) {
+			/** @type EE_Payment_Processor $payment_processor */
+			$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+			$payment_processor->process_registration_payments($transaction, $payment, $registrations);
+		}
+	}
+
+
+	/**
+	 * _process_registration_status_change
+	 * This processes requested registration status changes for all the registrations
+	 * on a given transaction and (optionally) sends out notifications for the changes.
+	 *
+	 * @param  EE_Transaction $transaction
+	 * @param array           $REG_IDs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_registration_status_change(EE_Transaction $transaction, $REG_IDs = array())
+	{
+		// first if there is no change in status then we get out.
+		if (
+			! isset($this->_req_data['txn_reg_status_change']['reg_status'])
+			|| $this->_req_data['txn_reg_status_change']['reg_status'] === 'NAN'
+		) {
+			//no error message, no change requested, just nothing to do man.
+			return false;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		// made it here dude?  Oh WOW.  K, let's take care of changing the statuses
+		return $transaction_processor->manually_update_registration_statuses(
+			$transaction,
+			sanitize_text_field($this->_req_data['txn_reg_status_change']['reg_status']),
+			array(array('REG_ID' => array('IN', $REG_IDs)))
+		);
+	}
+
+
+	/**
+	 * _build_payment_json_response
+	 *
+	 * @access public
+	 * @param \EE_Payment $payment
+	 * @param array       $REG_IDs
+	 * @param bool | null $delete_txn_reg_status_change
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _build_payment_json_response(
+		EE_Payment $payment,
+		$REG_IDs = array(),
+		$delete_txn_reg_status_change = null
+	) {
+		// was the payment deleted ?
+		if (is_bool($delete_txn_reg_status_change)) {
+			return array(
+				'PAY_ID'                       => $payment->ID(),
+				'amount'                       => $payment->amount(),
+				'total_paid'                   => $payment->transaction()->paid(),
+				'txn_status'                   => $payment->transaction()->status_ID(),
+				'pay_status'                   => $payment->STS_ID(),
+				'registrations'                => $this->_registration_payment_data_array($REG_IDs),
+				'delete_txn_reg_status_change' => $delete_txn_reg_status_change,
+			);
+		} else {
+			$this->_get_payment_status_array();
+
+			return array(
+				'amount'           => $payment->amount(),
+				'total_paid'       => $payment->transaction()->paid(),
+				'txn_status'       => $payment->transaction()->status_ID(),
+				'pay_status'       => $payment->STS_ID(),
+				'PAY_ID'           => $payment->ID(),
+				'STS_ID'           => $payment->STS_ID(),
+				'status'           => self::$_pay_status[$payment->STS_ID()],
+				'date'             => $payment->timestamp('Y-m-d', 'h:i a'),
+				'method'           => strtoupper($payment->source()),
+				'PM_ID'            => $payment->payment_method() ? $payment->payment_method()->ID() : 1,
+				'gateway'          => $payment->payment_method()
+					? $payment->payment_method()->admin_name()
+					: esc_html__("Unknown", 'event_espresso'),
+				'gateway_response' => $payment->gateway_response(),
+				'txn_id_chq_nmbr'  => $payment->txn_id_chq_nmbr(),
+				'po_number'        => $payment->po_number(),
+				'extra_accntng'    => $payment->extra_accntng(),
+				'registrations'    => $this->_registration_payment_data_array($REG_IDs),
+			);
+		}
+	}
+
+
+	/**
+	 * delete_payment
+	 *    delete a payment or refund made towards a transaction
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_payment()
+	{
+		$json_response_data = array('return_data' => false);
+		$PAY_ID             = isset($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
+			? absint($this->_req_data['delete_txn_admin_payment']['PAY_ID'])
+			: 0;
+		$can_delete = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_payments',
+			'delete_payment_from_registration_details'
+		);
+		if ($PAY_ID && $can_delete) {
+			$delete_txn_reg_status_change = isset($this->_req_data['delete_txn_reg_status_change'])
+				? $this->_req_data['delete_txn_reg_status_change']
+				: false;
+			$payment                      = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			if ($payment instanceof EE_Payment) {
+				$REG_IDs = $this->_get_existing_reg_payment_REG_IDs($payment);
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				if ($transaction_payments->delete_payment_and_update_transaction($payment)) {
+					$json_response_data['return_data'] = $this->_build_payment_json_response(
+						$payment,
+						$REG_IDs,
+						$delete_txn_reg_status_change
+					);
+					if ($delete_txn_reg_status_change) {
+						$this->_req_data['txn_reg_status_change'] = $delete_txn_reg_status_change;
+						//MAKE sure we also add the delete_txn_req_status_change to the
+						//$_REQUEST global because that's how messages will be looking for it.
+						$_REQUEST['txn_reg_status_change'] = $delete_txn_reg_status_change;
+						$this->_maybe_send_notifications();
+						$this->_process_registration_status_change($payment->transaction(), $REG_IDs);
+					}
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__('Valid Payment data could not be retrieved from the database.', 'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		} else {
+			if ($can_delete) {
+				EE_Error::add_error(
+					esc_html__(
+						'A valid Payment ID was not received, therefore payment form data could not be loaded.',
+						'event_espresso'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'You do not have access to delete a payment.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$notices              = EE_Error::get_notices(false, false, false);
+		$this->_template_args = array(
+			'data'      => $json_response_data,
+			'success'   => $notices['success'],
+			'error'     => $notices['errors'],
+			'attention' => $notices['attention'],
+		);
+		$this->_return_json();
+	}
+
+
+	/**
+	 * _registration_payment_data_array
+	 * adds info for 'owing' and 'paid' for each registration to the json response
+	 *
+	 * @access protected
+	 * @param array $REG_IDs
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _registration_payment_data_array($REG_IDs)
+	{
+		$registration_payment_data = array();
+		//if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
+		if (! empty($REG_IDs)) {
+			$registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration_payment_data[$registration->ID()] = array(
+						'paid'  => $registration->pretty_paid(),
+						'owing' => EEH_Template::format_currency($registration->final_price() - $registration->paid()),
+					);
+				}
+			}
+		}
+
+		return $registration_payment_data;
+	}
+
+
+	/**
+	 * _maybe_send_notifications
+	 * determines whether or not the admin has indicated that notifications should be sent.
+	 * If so, will toggle a filter switch for delivering registration notices.
+	 * If passed an EE_Payment object, then it will trigger payment notifications instead.
+	 *
+	 * @access protected
+	 * @param \EE_Payment | null $payment
+	 */
+	protected function _maybe_send_notifications($payment = null)
+	{
+		switch ($payment instanceof EE_Payment) {
+			// payment notifications
+			case true :
+				if (
+					isset(
+						$this->_req_data['txn_payments'],
+						$this->_req_data['txn_payments']['send_notifications']
+					) &&
+					filter_var($this->_req_data['txn_payments']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
+				) {
+					$this->_process_payment_notification($payment);
+				}
+				break;
+			// registration notifications
+			case false :
+				if (
+					isset(
+						$this->_req_data['txn_reg_status_change'],
+						$this->_req_data['txn_reg_status_change']['send_notifications']
+					) &&
+					filter_var($this->_req_data['txn_reg_status_change']['send_notifications'], FILTER_VALIDATE_BOOLEAN)
+				) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				}
+				break;
+		}
+	}
+
+
+	/**
+	 * _send_payment_reminder
+	 *    generates HTML for the View Transaction Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _send_payment_reminder()
+	{
+		$TXN_ID      = ! empty($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : false;
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+		$query_args  = isset($this->_req_data['redirect_to']) ? array(
+			'action' => $this->_req_data['redirect_to'],
+			'TXN_ID' => $this->_req_data['TXN_ID'],
+		) : array();
+		do_action(
+			'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			$transaction
+		);
+		$this->_redirect_after_action(
+			false,
+			esc_html__('payment reminder', 'event_espresso'),
+			esc_html__('sent', 'event_espresso'),
+			$query_args,
+			true
+		);
+	}
+
+
+	/**
+	 *  get_transactions
+	 *    get transactions for given parameters (used by list table)
+	 *
+	 * @param  int     $perpage how many transactions displayed per page
+	 * @param  boolean $count   return the count or objects
+	 * @param string   $view
+	 * @return mixed int = count || array of transaction objects
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transactions($perpage, $count = false, $view = '')
+	{
+
+		$TXN = EEM_Transaction::instance();
+
+		$start_date = isset($this->_req_data['txn-filter-start-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
+			: date(
+				'm/d/Y',
+				strtotime('-10 year')
+			);
+		$end_date   = isset($this->_req_data['txn-filter-end-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
+			: date('m/d/Y');
+
+		//make sure our timestamps start and end right at the boundaries for each day
+		$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+		$end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+
+
+		//convert to timestamps
+		$start_date = strtotime($start_date);
+		$end_date   = strtotime($end_date);
+
+		//makes sure start date is the lowest value and vice versa
+		$start_date = min($start_date, $end_date);
+		$end_date   = max($start_date, $end_date);
+
+		//convert to correct format for query
+		$start_date = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $start_date),
+			'Y-m-d H:i:s'
+		);
+		$end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', $end_date),
+			'Y-m-d H:i:s'
+		);
+
+
+		//set orderby
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+
+		switch ($this->_req_data['orderby']) {
+			case 'TXN_ID':
+				$orderby = 'TXN_ID';
+				break;
+			case 'ATT_fname':
+				$orderby = 'Registration.Attendee.ATT_fname';
+				break;
+			case 'event_name':
+				$orderby = 'Registration.Event.EVT_name';
+				break;
+			default: //'TXN_timestamp'
+				$orderby = 'TXN_timestamp';
+		}
+
+		$sort         = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		$current_page = ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
+		$per_page     = ! empty($perpage) ? $perpage : 10;
+		$per_page     = ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $per_page;
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = array($offset, $per_page);
+
+		$_where = array(
+			'TXN_timestamp'          => array('BETWEEN', array($start_date, $end_date)),
+			'Registration.REG_count' => 1,
+		);
+
+		if (isset($this->_req_data['EVT_ID'])) {
+			$_where['Registration.EVT_ID'] = $this->_req_data['EVT_ID'];
+		}
+
+		if (isset($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$_where['OR']  = array(
+				'Registration.Event.EVT_name'         => array('LIKE', $search_string),
+				'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
+				'Registration.Event.EVT_short_desc'   => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_full_name' => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_fname'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_lname'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_short_bio' => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_email'     => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_address'   => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_address2'  => array('LIKE', $search_string),
+				'Registration.Attendee.ATT_city'      => array('LIKE', $search_string),
+				'Registration.REG_final_price'        => array('LIKE', $search_string),
+				'Registration.REG_code'               => array('LIKE', $search_string),
+				'Registration.REG_count'              => array('LIKE', $search_string),
+				'Registration.REG_group_size'         => array('LIKE', $search_string),
+				'Registration.Ticket.TKT_name'        => array('LIKE', $search_string),
+				'Registration.Ticket.TKT_description' => array('LIKE', $search_string),
+				'Payment.PAY_source'                  => array('LIKE', $search_string),
+				'Payment.Payment_Method.PMD_name'     => array('LIKE', $search_string),
+				'TXN_session_data'                    => array('LIKE', $search_string),
+				'Payment.PAY_txn_id_chq_nmbr'         => array('LIKE', $search_string),
+			);
+		}
+
+		//failed transactions
+		$failed    = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
+					 || ($count && $view === 'failed');
+		$abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
+					 || ($count && $view === 'abandoned');
+
+		if ($failed) {
+			$_where['STS_ID'] = EEM_Transaction::failed_status_code;
+		} else if ($abandoned) {
+			$_where['STS_ID'] = EEM_Transaction::abandoned_status_code;
+		} else {
+			$_where['STS_ID']  = array('!=', EEM_Transaction::failed_status_code);
+			$_where['STS_ID*'] = array('!=', EEM_Transaction::abandoned_status_code);
+		}
+
+		$query_params = array(
+			$_where,
+			'order_by'                 => array($orderby => $sort),
+			'limit'                    => $limit,
+			'default_where_conditions' => EEM_Base::default_where_conditions_this_only,
+		);
+
+		$transactions = $count
+			? $TXN->count(array($_where), 'TXN_ID', true)
+			: $TXN->get_all($query_params);
+
+		return $transactions;
+	}
 }

Spacing +81 added lines, -81 removed lines

@@ -266,7 +266,7 @@ 
             'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['error_occurred']          = esc_html__(
+        EE_Registry::$i18n_js_strings['error_occurred'] = esc_html__(
             'An error occurred! Please refresh the page and try again.',
             'event_espresso'
         );
@@ -364,13 +364,13 @@ 
         //enqueue style
         wp_register_style(
             'espresso_txn',
-            TXN_ASSETS_URL . 'espresso_transactions_admin.css',
+            TXN_ASSETS_URL.'espresso_transactions_admin.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style('espresso_txn');
         //scripts
-        wp_register_script('espresso_txn', TXN_ASSETS_URL . 'espresso_transactions_admin.js', array(
+        wp_register_script('espresso_txn', TXN_ASSETS_URL.'espresso_transactions_admin.js', array(
             'ee_admin_js',
             'ee-datepicker',
             'jquery-ui-datepicker',
@@ -467,7 +467,7 @@ 
             : null;
         $this->_transaction->verify_abandoned_transaction_status();
 
-        if (! $this->_transaction instanceof EE_Transaction) {
+        if ( ! $this->_transaction instanceof EE_Transaction) {
             $error_msg = sprintf(
                 esc_html__(
                     'An error occurred and the details for the transaction with the ID # %d could not be retrieved.',
@@ -565,7 +565,7 @@ 
             'FHEE__Transactions_Admin_Page___transaction_legend_items__more_items',
             array(
                 'overpaid'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::overpaid_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::overpaid_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::overpaid_status_code,
                         false,
@@ -573,7 +573,7 @@ 
                     ),
                 ),
                 'complete'   => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::complete_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::complete_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::complete_status_code,
                         false,
@@ -581,7 +581,7 @@ 
                     ),
                 ),
                 'incomplete' => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::incomplete_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::incomplete_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::incomplete_status_code,
                         false,
@@ -589,7 +589,7 @@ 
                     ),
                 ),
                 'abandoned'  => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::abandoned_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::abandoned_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::abandoned_status_code,
                         false,
@@ -597,7 +597,7 @@ 
                     ),
                 ),
                 'failed'     => array(
-                    'class' => 'ee-status-legend ee-status-legend-' . EEM_Transaction::failed_status_code,
+                    'class' => 'ee-status-legend ee-status-legend-'.EEM_Transaction::failed_status_code,
                     'desc'  => EEH_Template::pretty_status(
                         EEM_Transaction::failed_status_code,
                         false,
@@ -646,11 +646,11 @@ 
                     'Click to Edit event',
                     'event_espresso'
                 )
-                . '">' . $event->get('EVT_name') . '</a>',
+                . '">'.$event->get('EVT_name').'</a>',
                 '</h3>'
             )
             : '';
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_transaction_legend_items());
+        $this->_template_args['after_list_table'] = $this->_display_legend($this->_transaction_legend_items());
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -693,7 +693,7 @@ 
 
         $this->_template_args['txn_status']['value'] = self::$_txn_status[$this->_transaction->get('STS_ID')];
         $this->_template_args['txn_status']['label'] = esc_html__('Transaction Status', 'event_espresso');
-        $this->_template_args['txn_status']['class'] = 'status-' . $this->_transaction->get('STS_ID');
+        $this->_template_args['txn_status']['class'] = 'status-'.$this->_transaction->get('STS_ID');
 
         $this->_template_args['grand_total'] = $this->_transaction->get('TXN_total');
         $this->_template_args['total_paid']  = $this->_transaction->get('TXN_paid');
@@ -746,7 +746,7 @@ 
 
 
         // next link
-        $next_txn                                 = $this->_transaction->next(
+        $next_txn = $this->_transaction->next(
             null,
             array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
             'TXN_ID'
@@ -761,7 +761,7 @@ 
             )
             : '';
         // previous link
-        $previous_txn                                 = $this->_transaction->previous(
+        $previous_txn = $this->_transaction->previous(
             null,
             array(array('STS_ID' => array('!=', EEM_Transaction::failed_status_code))),
             'TXN_ID'
@@ -811,7 +811,7 @@ 
         // grab messages at the last second
         $this->_template_args['notices'] = EE_Error::get_notices();
         // path to template
-        $template_path                             = TXN_TEMPLATE_PATH . 'txn_admin_details_header.template.php';
+        $template_path                             = TXN_TEMPLATE_PATH.'txn_admin_details_header.template.php';
         $this->_template_args['admin_page_header'] = EEH_Template::display_template(
             $template_path,
             $this->_template_args,
@@ -893,7 +893,7 @@ 
     {
         $content = '';
         $actions = array();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return $content;
         }
         /** @var EE_Registration $primary_registration */
@@ -954,7 +954,7 @@ 
         );
         if ($actions) {
             $content = '<ul>';
-            $content .= '<li>' . implode('</li><li>', $actions) . '</li>';
+            $content .= '<li>'.implode('</li><li>', $actions).'</li>';
             $content .= '</uL>';
         }
         return $content;
@@ -992,7 +992,7 @@ 
 
         //get line table
         EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display                       = new EE_Line_Item_Display(
+        $Line_Item_Display = new EE_Line_Item_Display(
             'admin_table',
             'EE_Admin_Table_Line_Item_Display_Strategy'
         );
@@ -1003,13 +1003,13 @@ 
                                                                       ->get('REG_code');
 
         // process taxes
-        $taxes                         = $this->_transaction->get_many_related(
+        $taxes = $this->_transaction->get_many_related(
             'Line_Item',
             array(array('LIN_type' => EEM_Line_Item::type_tax))
         );
         $this->_template_args['taxes'] = ! empty($taxes) ? $taxes : false;
 
-        $this->_template_args['grand_total']     = EEH_Template::format_currency(
+        $this->_template_args['grand_total'] = EEH_Template::format_currency(
             $this->_transaction->get('TXN_total'),
             false,
             false
@@ -1019,7 +1019,7 @@ 
 
         // process payment details
         $payments = $this->_transaction->get_many_related('Payment');
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             $this->_template_args['payments']              = $payments;
             $this->_template_args['existing_reg_payments'] = $this->_get_registration_payment_IDs($payments);
         } else {
@@ -1080,7 +1080,7 @@ 
                                   esc_html__('%1$s : Initiated %2$s', 'event_espresso'),
                                   ucwords(str_replace('_', ' ', $reg_step)),
                                   date(
-                                      get_option('date_format') . ' ' . get_option('time_format'),
+                                      get_option('date_format').' '.get_option('time_format'),
                                       ($reg_step_status + (get_option('gmt_offset') * HOUR_IN_SECONDS))
                                   )
                               )
@@ -1094,7 +1094,7 @@ 
                               . '</li>';
             }
         }
-        $reg_steps                                                 .= '</ul>';
+        $reg_steps .= '</ul>';
         $this->_template_args['txn_details']['reg_steps']['value'] = $reg_steps;
         $this->_template_args['txn_details']['reg_steps']['label'] = esc_html__(
             'Registration Step Progress',
@@ -1107,11 +1107,11 @@ 
         $this->_get_payment_status_array();
         $this->_get_reg_status_selection(); //sets up the template args for the reg status array for the transaction.
 
-        $this->_template_args['transaction_form_url']    = add_query_arg(array(
+        $this->_template_args['transaction_form_url'] = add_query_arg(array(
             'action'  => 'edit_transaction',
             'process' => 'transaction',
         ), TXN_ADMIN_URL);
-        $this->_template_args['apply_payment_form_url']  = add_query_arg(array(
+        $this->_template_args['apply_payment_form_url'] = add_query_arg(array(
             'page'   => 'espresso_transactions',
             'action' => 'espresso_apply_payment',
         ), WP_AJAX_URL);
@@ -1124,7 +1124,7 @@ 
 
         // 'espresso_delete_payment_nonce'
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_txn_details.template.php';
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_txn_details.template.php';
         echo EEH_Template::display_template($template_path, $this->_template_args, true);
     }
 
@@ -1154,11 +1154,11 @@ 
                 ),
             ),
         ));
-        if (! empty($reg_payments)) {
+        if ( ! empty($reg_payments)) {
             foreach ($payments as $payment) {
-                if (! $payment instanceof EE_Payment) {
+                if ( ! $payment instanceof EE_Payment) {
                     continue;
-                } elseif (! isset($existing_reg_payments[$payment->ID()])) {
+                } elseif ( ! isset($existing_reg_payments[$payment->ID()])) {
                     $existing_reg_payments[$payment->ID()] = array();
                 }
                 foreach ($reg_payments as $reg_payment) {
@@ -1187,7 +1187,7 @@ 
     protected function _get_registrations_to_apply_payment_to()
     {
         // we want any registration with an active status (ie: not deleted or cancelled)
-        $query_params                      = array(
+        $query_params = array(
             array(
                 'STS_ID' => array(
                     'IN',
@@ -1206,16 +1206,16 @@ 
                                                  '',
                                                  'clear: both; margin: 1.5em 0 0; display: none;'
                                              );
-        $registrations_to_apply_payment_to .= EEH_HTML::br() . EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
+        $registrations_to_apply_payment_to .= EEH_HTML::br().EEH_HTML::div('', '', 'admin-primary-mbox-tbl-wrap');
         $registrations_to_apply_payment_to .= EEH_HTML::table('', '', 'admin-primary-mbox-tbl');
         $registrations_to_apply_payment_to .= EEH_HTML::thead(
             EEH_HTML::tr(
-                EEH_HTML::th(esc_html__('ID', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Event', 'event_espresso')) .
-                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr') .
-                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr') .
+                EEH_HTML::th(esc_html__('ID', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Registrant', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Ticket', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Event', 'event_espresso')).
+                EEH_HTML::th(esc_html__('Paid', 'event_espresso'), '', 'txn-admin-payment-paid-td jst-cntr').
+                EEH_HTML::th(esc_html__('Owing', 'event_espresso'), '', 'txn-admin-payment-owing-td jst-cntr').
                 EEH_HTML::th(esc_html__('Apply', 'event_espresso'), '', 'jst-cntr')
             )
         );
@@ -1230,29 +1230,29 @@ 
                     : esc_html__('Unknown Attendee', 'event_espresso');
                 $owing                             = $registration->final_price() - $registration->paid();
                 $taxable                           = $registration->ticket()->taxable()
-                    ? ' <span class="smaller-text lt-grey-text"> ' . esc_html__('+ tax', 'event_espresso') . '</span>'
+                    ? ' <span class="smaller-text lt-grey-text"> '.esc_html__('+ tax', 'event_espresso').'</span>'
                     : '';
                 $checked = empty($existing_reg_payments) || in_array($registration->ID(), $existing_reg_payments)
                     ? ' checked="checked"'
                     : '';
-                $disabled                          = $registration->final_price() > 0 ? '' : ' disabled';
+                $disabled = $registration->final_price() > 0 ? '' : ' disabled';
                 $registrations_to_apply_payment_to .= EEH_HTML::tr(
-                    EEH_HTML::td($registration->ID()) .
-                    EEH_HTML::td($attendee_name) .
+                    EEH_HTML::td($registration->ID()).
+                    EEH_HTML::td($attendee_name).
                     EEH_HTML::td(
-                        $registration->ticket()->name() . ' : ' . $registration->ticket()->pretty_price() . $taxable
-                    ) .
-                    EEH_HTML::td($registration->event_name()) .
-                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr') .
-                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr') .
+                        $registration->ticket()->name().' : '.$registration->ticket()->pretty_price().$taxable
+                    ).
+                    EEH_HTML::td($registration->event_name()).
+                    EEH_HTML::td($registration->pretty_paid(), '', 'txn-admin-payment-paid-td jst-cntr').
+                    EEH_HTML::td(EEH_Template::format_currency($owing), '', 'txn-admin-payment-owing-td jst-cntr').
                     EEH_HTML::td(
-                        '<input type="checkbox" value="' . $registration->ID()
+                        '<input type="checkbox" value="'.$registration->ID()
                         . '" name="txn_admin_payment[registrations]"'
-                        . $checked . $disabled . '>',
+                        . $checked.$disabled.'>',
                         '',
                         'jst-cntr'
                     ),
-                    'apply-payment-registration-row-' . $registration->ID()
+                    'apply-payment-registration-row-'.$registration->ID()
                 );
             }
         }
@@ -1267,7 +1267,7 @@ 
             '',
             'clear description'
         );
-        $registrations_to_apply_payment_to                         .= EEH_HTML::divx();
+        $registrations_to_apply_payment_to .= EEH_HTML::divx();
         $this->_template_args['registrations_to_apply_payment_to'] = $registrations_to_apply_payment_to;
     }
 
@@ -1333,12 +1333,12 @@ 
                 array(
                     'OR*payment_method_for_payment' => array(
                         'PMD_ID'    => array('IN', $payment_methods_of_payments),
-                        'PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%'),
+                        'PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%'),
                     ),
                 ),
             );
         } else {
-            $query_args = array(array('PMD_scope' => array('LIKE', '%' . EEM_Payment_Method::scope_admin . '%')));
+            $query_args = array(array('PMD_scope' => array('LIKE', '%'.EEM_Payment_Method::scope_admin.'%')));
         }
         $this->_template_args['payment_methods'] = EEM_Payment_Method::instance()->get_all($query_args);
     }
@@ -1367,7 +1367,7 @@ 
             'Line_Item',
             array(array('LIN_type' => 'line-item'))
         );
-        if (! empty($line_items)) {
+        if ( ! empty($line_items)) {
             foreach ($line_items as $item) {
                 if ($item instanceof EE_Line_Item) {
                     switch ($item->OBJ_type()) {
@@ -1377,7 +1377,7 @@ 
                             $ticket = $item->ticket();
                             //right now we're only handling tickets here.
                             //Cause its expected that only tickets will have attendees right?
-                            if (! $ticket instanceof EE_Ticket) {
+                            if ( ! $ticket instanceof EE_Ticket) {
                                 continue;
                             }
                             try {
@@ -1386,7 +1386,7 @@ 
                                 EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
                                 $event_name = esc_html__('Unknown Event', 'event_espresso');
                             }
-                            $event_name   .= ' - ' . $item->get('LIN_name');
+                            $event_name   .= ' - '.$item->get('LIN_name');
                             $ticket_price = EEH_Template::format_currency($item->get('LIN_unit_price'));
                             // now get all of the registrations for this transaction that use this ticket
                             $registrations = $ticket->get_many_related(
@@ -1394,7 +1394,7 @@ 
                                 array(array('TXN_ID' => $this->_transaction->ID()))
                             );
                             foreach ($registrations as $registration) {
-                                if (! $registration instanceof EE_Registration) {
+                                if ( ! $registration instanceof EE_Registration) {
                                     continue;
                                 }
                                 $this->_template_args['event_attendees'][$registration->ID()]['STS_ID']
@@ -1413,12 +1413,12 @@ 
                                     $this->_template_args['event_attendees'][$registration->ID()]['attendee']
                                         = $attendee->full_name();
                                     $this->_template_args['event_attendees'][$registration->ID()]['email']
-                                        = '<a href="mailto:' . $attendee->email() . '?subject=' . $event_name
+                                        = '<a href="mailto:'.$attendee->email().'?subject='.$event_name
                                           . esc_html__(
                                               ' Event',
                                               'event_espresso'
                                           )
-                                          . '">' . $attendee->email() . '</a>';
+                                          . '">'.$attendee->email().'</a>';
                                     $this->_template_args['event_attendees'][$registration->ID()]['address']
                                         = EEH_Address::format($attendee, 'inline', false, false);
                                 } else {
@@ -1442,7 +1442,7 @@ 
                 TXN_ADMIN_URL
             );
             echo EEH_Template::display_template(
-                TXN_TEMPLATE_PATH . 'txn_admin_details_main_meta_box_attendees.template.php',
+                TXN_TEMPLATE_PATH.'txn_admin_details_main_meta_box_attendees.template.php',
                 $this->_template_args,
                 true
             );
@@ -1478,12 +1478,12 @@ 
         $primary_att = $this->_transaction->primary_registration() instanceof EE_Registration
             ? $this->_transaction->primary_registration()->get_first_related('Attendee')
             : null;
-        if (! $primary_att instanceof EE_Attendee) {
+        if ( ! $primary_att instanceof EE_Attendee) {
             $this->_template_args['no_attendee_message'] = esc_html__(
                 'There is no attached contact for this transaction.  The transaction either failed due to an error or was abandoned.',
                 'event_espresso'
             );
-            $primary_att                                 = EEM_Attendee::instance()->create_default_object();
+            $primary_att = EEM_Attendee::instance()->create_default_object();
         }
         $this->_template_args['ATT_ID']            = $primary_att->ID();
         $this->_template_args['prime_reg_fname']   = $primary_att->fname();
@@ -1497,7 +1497,7 @@ 
         // get formatted address for registrant
         $this->_template_args['formatted_address'] = EEH_Address::format($primary_att);
         echo EEH_Template::display_template(
-            TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_registrant.template.php',
+            TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_registrant.template.php',
             $this->_template_args,
             true
         );
@@ -1522,8 +1522,8 @@ 
             TXN_ADMIN_URL
         );
 
-        $template_path = TXN_TEMPLATE_PATH . 'txn_admin_details_side_meta_box_billing_info.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);/**/
+        $template_path = TXN_TEMPLATE_PATH.'txn_admin_details_side_meta_box_billing_info.template.php';
+        echo EEH_Template::display_template($template_path, $this->_template_args, true); /**/
     }
 
 
@@ -1548,7 +1548,7 @@ 
             'ee_edit_payments',
             'apply_payment_or_refund_from_registration_details'
         );
-        if (! empty($valid_data) && $has_access) {
+        if ( ! empty($valid_data) && $has_access) {
             $PAY_ID = $valid_data['PAY_ID'];
             //save  the new payment
             $payment = $this->_create_payment_from_request_data($valid_data);
@@ -1561,7 +1561,7 @@ 
                 $REG_IDs = $this->_get_REG_IDs_to_apply_payment_to($payment);
                 $this->_remove_existing_registration_payments($payment, $PAY_ID);
                 // apply payment to registrations (if applicable)
-                if (! empty($REG_IDs)) {
+                if ( ! empty($REG_IDs)) {
                     $this->_update_registration_payments($transaction, $payment, $REG_IDs);
                     $this->_maybe_send_notifications();
                     // now process status changes for the same registrations
@@ -1609,7 +1609,7 @@ 
                 );
             }
         }
-        $notices              = EE_Error::get_notices(
+        $notices = EE_Error::get_notices(
             false,
             false,
             false
@@ -1631,14 +1631,14 @@ 
      */
     protected function _validate_payment_request_data()
     {
-        if (! isset($this->_req_data['txn_admin_payment'])) {
+        if ( ! isset($this->_req_data['txn_admin_payment'])) {
             return false;
         }
         $payment_form = $this->_generate_payment_form_section();
         try {
             if ($payment_form->was_submitted()) {
                 $payment_form->receive_form_submission();
-                if (! $payment_form->is_valid()) {
+                if ( ! $payment_form->is_valid()) {
                     $submission_error_messages = array();
                     foreach ($payment_form->get_validation_errors_accumulated() as $validation_error) {
                         if ($validation_error instanceof EE_Validation_Error) {
@@ -1817,7 +1817,7 @@ 
             array('Y-m-d', 'g:i a')
         );
 
-        if (! $payment->save()) {
+        if ( ! $payment->save()) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('Payment %1$d has not been successfully saved to the database.', 'event_espresso'),
@@ -1882,7 +1882,7 @@ 
         $REG_IDs = array();
         // grab array of IDs for specific registrations to apply changes to
         if (isset($this->_req_data['txn_admin_payment']['registrations'])) {
-            $REG_IDs = (array)$this->_req_data['txn_admin_payment']['registrations'];
+            $REG_IDs = (array) $this->_req_data['txn_admin_payment']['registrations'];
         }
         //nothing specified ? then get all reg IDs
         if (empty($REG_IDs)) {
@@ -2010,12 +2010,12 @@ 
         // but add in some conditions regarding payment,
         // so that we don't apply payments to registrations that are free or have already been paid for
         // but ONLY if the payment is NOT a refund ( ie: the payment amount is not negative )
-        if (! $payment->is_a_refund()) {
+        if ( ! $payment->is_a_refund()) {
             $registration_query_where_params['REG_final_price']  = array('!=', 0);
             $registration_query_where_params['REG_final_price*'] = array('!=', 'REG_paid', true);
         }
         $registrations = $transaction->registrations(array($registration_query_where_params));
-        if (! empty($registrations)) {
+        if ( ! empty($registrations)) {
             /** @type EE_Payment_Processor $payment_processor */
             $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
             $payment_processor->process_registration_payments($transaction, $payment, $registrations);
@@ -2217,7 +2217,7 @@ 
     {
         $registration_payment_data = array();
         //if non empty reg_ids lets get an array of registrations and update the values for the apply_payment/refund rows.
-        if (! empty($REG_IDs)) {
+        if ( ! empty($REG_IDs)) {
             $registrations = EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $REG_IDs))));
             foreach ($registrations as $registration) {
                 if ($registration instanceof EE_Registration) {
@@ -2330,13 +2330,13 @@ 
                 'm/d/Y',
                 strtotime('-10 year')
             );
-        $end_date   = isset($this->_req_data['txn-filter-end-date'])
+        $end_date = isset($this->_req_data['txn-filter-end-date'])
             ? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
             : date('m/d/Y');
 
         //make sure our timestamps start and end right at the boundaries for each day
-        $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-        $end_date   = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+        $start_date = date('Y-m-d', strtotime($start_date)).' 00:00:00';
+        $end_date   = date('Y-m-d', strtotime($end_date)).' 23:59:59';
 
 
         //convert to timestamps
@@ -2353,7 +2353,7 @@ 
             date('Y-m-d H:i:s', $start_date),
             'Y-m-d H:i:s'
         );
-        $end_date   = EEM_Transaction::instance()->convert_datetime_for_query(
+        $end_date = EEM_Transaction::instance()->convert_datetime_for_query(
             'TXN_timestamp',
             date('Y-m-d H:i:s', $end_date),
             'Y-m-d H:i:s'
@@ -2395,7 +2395,7 @@ 
         }
 
         if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
+            $search_string = '%'.$this->_req_data['s'].'%';
             $_where['OR']  = array(
                 'Registration.Event.EVT_name'         => array('LIKE', $search_string),
                 'Registration.Event.EVT_desc'         => array('LIKE', $search_string),
@@ -2422,9 +2422,9 @@ 
         }
 
         //failed transactions
-        $failed    = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
+        $failed    = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'failed' && ! $count)
                      || ($count && $view === 'failed');
-        $abandoned = (! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
+        $abandoned = ( ! empty($this->_req_data['status']) && $this->_req_data['status'] === 'abandoned' && ! $count)
                      || ($count && $view === 'abandoned');
 
         if ($failed) {

core/EE_System.core.php

Indentation +1250 added lines, -1250 removed lines

@@ -24,1256 +24,1256 @@
 {
 
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * A Context DTO dedicated solely to identifying the current request type.
-     *
-     * @var RequestTypeContextCheckerInterface $request_type
-     */
-    private $request_type;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param RequestInterface|null          $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        RequestInterface $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        //make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        //we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param RequestInterface          $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry         = $registry;
-        $this->loader           = $loader;
-        $this->request          = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'load_espresso_addons')
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'),
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            array($this, 'brew_espresso'),
-            9
-        );
-        //other housekeeping
-        //exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($this, 'remove_pages_from_wp_list_pages'),
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function ()
-            {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        do_action('AHEE__EE_System__load_espresso_addons');
-        //if the WP API basic auth plugin isn't already loaded, load it now.
-        //We want it for mobile apps. Just include the entire plugin
-        //also, don't load the basic auth when a plugin is getting activated, because
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        //and causes a fatal error
-        if (
-            $this->request->getRequestParam('activate') !== 'true'
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! in_array(
-                $this->request->getRequestParam('action'),
-                array('activate', 'activate-selected'),
-                true
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        //first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                //detect teh request type for that addon
-                $addon->detect_activation_or_upgrade();
-            }
-        }
-    }
-
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type       = $this->detect_req_type($espresso_db_update);
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                //migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                //				echo "done upgrade";die;
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                //its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    //the key is an int, and the value IS NOT an array
-                    //so it must be numerically-indexed, where values are versions installed...
-                    //fix it!
-                    $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
-                } else {
-                    //ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        //only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            update_option('ee_flush_rewrite_rules', true);
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update          = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type             = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation', espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history)
-    {
-        $previous_version       = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts  = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            //it exists, so this isn't a completely new install
-            //check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
-                //it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            //brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        //find the most recently-activated version
-        $most_recently_active_version =
-            EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version            = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                //check there is a record of when this version was activated. Otherwise,
-                //mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation !== 'unknown-date'
-                        && $an_activation
-                           > $most_recently_active_version_activation) {
-                        $most_recently_active_version            = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        //if current user is an admin and it's not an ajax or rest request
-        if (
-            ! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($config->admin->use_full_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        //load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        //get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
-        $model_names            = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name      = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     */
-    private function _maybe_brew_regular()
-    {
-        if ((! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        if ($this->request->isFrontend() || $this->request->isIframe()) {
-            try {
-                // load, register, and add shortcodes the new way
-                $this->loader->getShared(
-                    'EventEspresso\core\services\shortcodes\ShortcodesManager',
-                    array(
-                        // and the old way, but we'll put it under control of the new system
-                        EE_Config::getLegacyShortcodesManager(),
-                    )
-                );
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = __(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(
-                        array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name
-                    ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->loader->getShared('EE_PUE');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        //caps need to be initialized on every request so that capability maps are set.
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-
-    /**
-     *    load_CPTs_and_session
-     *
-     * @access public
-     * @return    void
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        // register Custom Post Types
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if (
-            ! $this->maintenance_mode->level()
-            && ($this->request->isFrontend() || $this->request->isFrontAjax())
-        ) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_Admin');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     */
-    public function core_loaded_and_ready()
-    {
-        if (
-            $this->request->isAdmin()
-            || $this->request->isEeAjax()
-            || $this->request->isFrontend()
-        ) {
-            $this->loader->getShared('EE_Session');
-        }
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // load_espresso_template_tags
-        if (
-            is_readable(EE_PUBLIC . 'template_tags.php')
-            && ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isFeed())
-        ) {
-            require_once EE_PUBLIC . 'template_tags.php';
-        }
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-        if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) {
-            $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-        }
-    }
-
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * A Context DTO dedicated solely to identifying the current request type.
+	 *
+	 * @var RequestTypeContextCheckerInterface $request_type
+	 */
+	private $request_type;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param RequestInterface|null          $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		RequestInterface $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		//make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		//we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface          $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry         = $registry;
+		$this->loader           = $loader;
+		$this->request          = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'load_espresso_addons')
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'),
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			array($this, 'brew_espresso'),
+			9
+		);
+		//other housekeeping
+		//exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($this, 'remove_pages_from_wp_list_pages'),
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function ()
+			{
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		do_action('AHEE__EE_System__load_espresso_addons');
+		//if the WP API basic auth plugin isn't already loaded, load it now.
+		//We want it for mobile apps. Just include the entire plugin
+		//also, don't load the basic auth when a plugin is getting activated, because
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		//and causes a fatal error
+		if (
+			$this->request->getRequestParam('activate') !== 'true'
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! in_array(
+				$this->request->getRequestParam('action'),
+				array('activate', 'activate-selected'),
+				true
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		//first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				//detect teh request type for that addon
+				$addon->detect_activation_or_upgrade();
+			}
+		}
+	}
+
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type       = $this->detect_req_type($espresso_db_update);
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				//migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				//				echo "done upgrade";die;
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				//its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					//the key is an int, and the value IS NOT an array
+					//so it must be numerically-indexed, where values are versions installed...
+					//fix it!
+					$version_string                         = $should_be_array;
+					$corrected_db_update[ $version_string ] = array('unknown-date');
+				} else {
+					//ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		//only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			update_option('ee_flush_rewrite_rules', true);
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update          = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type             = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation', espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history)
+	{
+		$previous_version       = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts  = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			//it exists, so this isn't a completely new install
+			//check if this version already in that list of previously installed versions
+			if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+				//it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					//we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			//brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		//find the most recently-activated version
+		$most_recently_active_version =
+			EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version            = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				//check there is a record of when this version was activated. Otherwise,
+				//mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation !== 'unknown-date'
+						&& $an_activation
+						   > $most_recently_active_version_activation) {
+						$most_recently_active_version            = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		//if current user is an admin and it's not an ajax or rest request
+		if (
+			! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($config->admin->use_full_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		//load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		//get all the files in the EE_MODELS folder that end in .model.php
+		$models                 = glob(EE_MODELS . '*.model.php');
+		$model_names            = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name      = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 */
+	private function _maybe_brew_regular()
+	{
+		if ((! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		if ($this->request->isFrontend() || $this->request->isIframe()) {
+			try {
+				// load, register, and add shortcodes the new way
+				$this->loader->getShared(
+					'EventEspresso\core\services\shortcodes\ShortcodesManager',
+					array(
+						// and the old way, but we'll put it under control of the new system
+						EE_Config::getLegacyShortcodesManager(),
+					)
+				);
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = __(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - ' . str_replace(
+						array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+						$class_name
+					) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->loader->getShared('EE_PUE');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		//caps need to be initialized on every request so that capability maps are set.
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+
+	/**
+	 *    load_CPTs_and_session
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		// register Custom Post Types
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if (
+			! $this->maintenance_mode->level()
+			&& ($this->request->isFrontend() || $this->request->isFrontAjax())
+		) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_Admin');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function core_loaded_and_ready()
+	{
+		if (
+			$this->request->isAdmin()
+			|| $this->request->isEeAjax()
+			|| $this->request->isFrontend()
+		) {
+			$this->loader->getShared('EE_Session');
+		}
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// load_espresso_template_tags
+		if (
+			is_readable(EE_PUBLIC . 'template_tags.php')
+			&& ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isFeed())
+		) {
+			require_once EE_PUBLIC . 'template_tags.php';
+		}
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+		if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) {
+			$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+		}
+	}
+
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 
 
 

core/EE_Dependency_Map.core.php

Indentation +849 added lines, -849 removed lines

@@ -8,7 +8,7 @@ 
 use EventEspresso\core\services\request\ResponseInterface;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -25,854 +25,854 @@ 
 class EE_Dependency_Map
 {
 
-    /**
-     * This means that the requested class dependency is not present in the dependency map
-     */
-    const not_registered = 0;
-
-    /**
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
-     */
-    const load_new_object = 1;
-
-    /**
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
-     */
-    const load_from_cache = 2;
-
-    /**
-     * When registering a dependency,
-     * this indicates to keep any existing dependencies that already exist,
-     * and simply discard any new dependencies declared in the incoming data
-     */
-    const KEEP_EXISTING_DEPENDENCIES = 0;
-
-    /**
-     * When registering a dependency,
-     * this indicates to overwrite any existing dependencies that already exist using the incoming data
-     */
-    const OVERWRITE_DEPENDENCIES = 1;
-
-
-
-    /**
-     * @type EE_Dependency_Map $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * @type RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @type LegacyRequestInterface $legacy_request
-     */
-    protected $legacy_request;
-
-    /**
-     * @type ResponseInterface $response
-     */
-    protected $response;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @type array $_dependency_map
-     */
-    protected $_dependency_map = array();
-
-    /**
-     * @type array $_class_loaders
-     */
-    protected $_class_loaders = array();
-
-    /**
-     * @type array $_aliases
-     */
-    protected $_aliases = array();
-
-
-
-    /**
-     * EE_Dependency_Map constructor.
-     */
-    protected function __construct()
-    {
-        // add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-        do_action('EE_Dependency_Map____construct');
-    }
-
-
-
-    /**
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function initialize()
-    {
-        $this->_register_core_dependencies();
-        $this->_register_core_class_loaders();
-        $this->_register_core_aliases();
-    }
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Dependency_Map
-     */
-    public static function instance() {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map) {
-            self::$_instance = new EE_Dependency_Map(/*$request, $response, $legacy_request*/);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param LegacyRequestInterface $legacy_request
-     */
-    public function setLegacyRequest(LegacyRequestInterface $legacy_request)
-    {
-        $this->legacy_request = $legacy_request;
-    }
-
-
-    /**
-     * @param ResponseInterface $response
-     */
-    public function setResponse(ResponseInterface $response)
-    {
-        $this->response = $response;
-    }
-
-
-
-    /**
-     * @param LoaderInterface $loader
-     */
-    public function setLoader(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-
-    /**
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public static function register_dependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
-    }
-
-
-
-    /**
-     * Assigns an array of class names and corresponding load sources (new or cached)
-     * to the class specified by the first parameter.
-     * IMPORTANT !!!
-     * The order of elements in the incoming $dependencies array MUST match
-     * the order of the constructor parameters for the class in question.
-     * This is especially important when overriding any existing dependencies that are registered.
-     * the third parameter controls whether any duplicate dependencies are overwritten or not.
-     *
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public function registerDependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        $class = trim($class, '\\');
-        $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
-        }
-        // we need to make sure that any aliases used when registering a dependency
-        // get resolved to the correct class name
-        foreach ($dependencies as $dependency => $load_source) {
-            $alias = self::$_instance->get_alias($dependency);
-            if (
-                $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
-            ) {
-                unset($dependencies[$dependency]);
-                $dependencies[$alias] = $load_source;
-                $registered = true;
-            }
-        }
-        // now add our two lists of dependencies together.
-        // using Union (+=) favours the arrays in precedence from left to right,
-        // so $dependencies is NOT overwritten because it is listed first
-        // ie: with A = B + C, entries in B take precedence over duplicate entries in C
-        // Union is way faster than array_merge() but should be used with caution...
-        // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
-        // now we need to ensure that the resulting dependencies
-        // array only has the entries that are required for the class
-        // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
-        // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
-            // then truncate the  final array to match that count
-            ? array_slice($dependencies, 0, $dependency_count)
-            // otherwise just take the incoming array because nothing previously existed
-            : $dependencies;
-        return $registered;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param string $loader
-     * @return bool
-     * @throws DomainException
-     */
-    public static function register_class_loader($class_name, $loader = 'load_core')
-    {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
-            throw new DomainException(
-                esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
-            );
-        }
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (
-            ! is_callable($loader)
-            && (
-                strpos($loader, 'load_') !== 0
-                || ! method_exists('EE_Registry', $loader)
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid loader method on EE_Registry.',
-                        'event_espresso'
-                    ),
-                    $loader
-                )
-            );
-        }
-        $class_name = self::$_instance->get_alias($class_name);
-        if (! isset(self::$_instance->_class_loaders[$class_name])) {
-            self::$_instance->_class_loaders[$class_name] = $loader;
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function dependency_map()
-    {
-        return $this->_dependency_map;
-    }
-
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name
-     *
-     * @param string $class_name
-     * @return boolean
-     */
-    public function has($class_name = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        return isset($this->_dependency_map[$class_name]) ? true : false;
-    }
-
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return bool
-     */
-    public function has_dependency_for_class($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->get_alias($dependency);
-        return isset($this->_dependency_map[$class_name][$dependency])
-            ? true
-            : false;
-    }
-
-
-
-    /**
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return int
-     */
-    public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->get_alias($dependency);
-        return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[$class_name][$dependency]
-            : EE_Dependency_Map::not_registered;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @return string | Closure
-     */
-    public function class_loader($class_name)
-    {
-        // all legacy models use load_model()
-        if(strpos($class_name, 'EEM_') === 0){
-            return 'load_model';
-        }
-        $class_name = $this->get_alias($class_name);
-        return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function class_loaders()
-    {
-        return $this->_class_loaders;
-    }
-
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $class_name the class name that should be used (concrete class to replace interface)
-     * @param string $alias      the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class  the class that has the dependency (is type hinting for the interface)
-     */
-    public function add_alias($class_name, $alias, $for_class = '')
-    {
-        if ($for_class !== '') {
-            if (! isset($this->_aliases[$for_class])) {
-                $this->_aliases[$for_class] = array();
-            }
-            $this->_aliases[$for_class][$class_name] = $alias;
-        }
-        $this->_aliases[$class_name] = $alias;
-    }
-
-
-
-    /**
-     * returns TRUE if the provided class name has an alias
-     *
-     * @param string $class_name
-     * @param string $for_class
-     * @return bool
-     */
-    public function has_alias($class_name = '', $for_class = '')
-    {
-        return isset($this->_aliases[$for_class][$class_name])
-               || (
-                   isset($this->_aliases[$class_name])
-                   && ! is_array($this->_aliases[$class_name])
-               );
-    }
-
-
-
-    /**
-     * returns alias for class name if one exists, otherwise returns the original classname
-     * functions recursively, so that multiple aliases can be used to drill down to a classname
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $class_name
-     * @param string $for_class
-     * @return string
-     */
-    public function get_alias($class_name = '', $for_class = '')
-    {
-        if (! $this->has_alias($class_name, $for_class)) {
-            return $class_name;
-        }
-        if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) {
-            return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
-        }
-        return $this->get_alias($this->_aliases[$class_name]);
-    }
-
-
-
-    /**
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
-     * This is done by using the following class constants:
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
-     */
-    protected function _register_core_dependencies()
-    {
-        $this->_dependency_map = array(
-            'EE_Request_Handler'                                                                                          => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_System'                                                                                                   => array(
-                'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Session'                                                                                                  => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
-                'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Cart'                                                                                                     => array(
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Front_Controller'                                                                                         => array(
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messenger_Collection_Loader'                                                                              => array(
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Type_Collection_Loader'                                                                           => array(
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Resource_Manager'                                                                                 => array(
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_Factory'                                                                                          => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_messages'                                                                                                 => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Generator'                                                                                       => array(
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Processor'                                                                                       => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Queue'                                                                                           => array(
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Messages_Template_Defaults'                                                                               => array(
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_To_Generate_From_Request'                                                                         => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandBus'                                                             => array(
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\services\commands\CommandHandler'                                                              => array(
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\database\TableManager'                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Data_Migration_Class_Base'                                                                                => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_1_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_2_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_3_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_4_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_5_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_6_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_7_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_8_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_9_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\assets\Registry'                                                                 => array(
-                'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\BasicCacheManager'                        => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                  => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array(
-                'EE_Registration_Config'                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\values\EmailAddress'                              => array(
-                null,
-                'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\orm\ModelFieldFactory' => array(
-                'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
-            ),
-            'LEGACY_MODELS'                                                   => array(
-                null,
-                'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Module_Request_Router' => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Registration_Processor' => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array(
-                null,
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Admin_Transactions_List_Table' => array(
-                null,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\modules\ticket_selector\ProcessTicketSelector' => array(
-                'EE_Core_Config' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => array(
-                'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
-            ),
-        );
-    }
-
-
-
-    /**
-     * Registers how core classes are loaded.
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
-     *        'EE_Request_Handler' => 'load_core'
-     *        'EE_Messages_Queue'  => 'load_lib'
-     *        'EEH_Debug_Tools'    => 'load_helper'
-     * or, if greater control is required, by providing a custom closure. For example:
-     *        'Some_Class' => function () {
-     *            return new Some_Class();
-     *        },
-     * This is required for instantiating dependencies
-     * where an interface has been type hinted in a class constructor. For example:
-     *        'Required_Interface' => function () {
-     *            return new A_Class_That_Implements_Required_Interface();
-     *        },
-     *
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _register_core_class_loaders()
-    {
-        //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
-        //be used in a closure.
-        $request = &$this->request;
-        $response = &$this->response;
-        $legacy_request = &$this->legacy_request;
-        // $loader = &$this->loader;
-        $this->_class_loaders = array(
-            //load_core
-            'EE_Capabilities'          => 'load_core',
-            'EE_Encryption'            => 'load_core',
-            'EE_Front_Controller'      => 'load_core',
-            'EE_Module_Request_Router' => 'load_core',
-            'EE_Registry'              => 'load_core',
-            'EE_Request'               => function () use (&$legacy_request) {
-                return $legacy_request;
-            },
-            'EventEspresso\core\services\request\Request' => function () use (&$request) {
-                return $request;
-            },
-            'EventEspresso\core\services\request\Response' => function () use (&$response) {
-                return $response;
-            },
-            'EE_Request_Handler'       => 'load_core',
-            'EE_Session'               => 'load_core',
-            'EE_Cron_Tasks'            => 'load_core',
-            'EE_System'                => 'load_core',
-            'EE_Maintenance_Mode'      => 'load_core',
-            'EE_Register_CPTs'         => 'load_core',
-            'EE_Admin'                 => 'load_core',
-            //load_lib
-            'EE_Message_Resource_Manager'          => 'load_lib',
-            'EE_Message_Type_Collection'           => 'load_lib',
-            'EE_Message_Type_Collection_Loader'    => 'load_lib',
-            'EE_Messenger_Collection'              => 'load_lib',
-            'EE_Messenger_Collection_Loader'       => 'load_lib',
-            'EE_Messages_Processor'                => 'load_lib',
-            'EE_Message_Repository'                => 'load_lib',
-            'EE_Messages_Queue'                    => 'load_lib',
-            'EE_Messages_Data_Handler_Collection'  => 'load_lib',
-            'EE_Message_Template_Group_Collection' => 'load_lib',
-            'EE_Payment_Method_Manager'            => 'load_lib',
-            'EE_Messages_Generator'                => function () {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Generator',
-                    array(),
-                    false,
-                    false
-                );
-            },
-            'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Template_Defaults',
-                    $arguments,
-                    false,
-                    false
-                );
-            },
-            //load_model
-            // 'EEM_Attendee'                         => 'load_model',
-            // 'EEM_Message_Template_Group'           => 'load_model',
-            // 'EEM_Message_Template'                 => 'load_model',
-            //load_helper
-            'EEH_Parse_Shortcodes'                 => function () {
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
-                    return new EEH_Parse_Shortcodes();
-                }
-                return null;
-            },
-            'EE_Template_Config'                   => function () {
-                return EE_Config::instance()->template_settings;
-            },
-            'EE_Currency_Config'                   => function () {
-                return EE_Config::instance()->currency;
-            },
-            'EE_Registration_Config'                   => function () {
-                return EE_Config::instance()->registration;
-            },
-            'EE_Core_Config'                   => function () {
-                return EE_Config::instance()->core;
-            },
-            'EventEspresso\core\services\loaders\Loader' => function () {
-                return LoaderFactory::getLoader();
-            },
-        );
-    }
-
-
-
-    /**
-     * can be used for supplying alternate names for classes,
-     * or for connecting interface names to instantiable classes
-     */
-    protected function _register_core_aliases()
-    {
-        $this->_aliases = array(
-            'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
-            'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
-            'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
-            'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
-            'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
-            'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
-            'CreateRegCodeCommandHandler'                                                  => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand',
-            'CreateRegUrlLinkCommandHandler'                                               => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand',
-            'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-            'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
-            'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
-            'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
-            'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
-            'CreateTransactionCommandHandler'                                     => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
-            'CreateAttendeeCommandHandler'                                        => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
-            'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
-            'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
-            'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
-            'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
-            'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
-            'CommandFactoryInterface'                                                     => 'EventEspresso\core\services\commands\CommandFactoryInterface',
-            'EventEspresso\core\services\commands\CommandFactoryInterface'                => 'EventEspresso\core\services\commands\CommandFactory',
-            'EventEspresso\core\domain\services\session\SessionIdentifierInterface'       => 'EE_Session',
-            'EmailValidatorInterface'                                                     => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
-            'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
-            'NoticeConverterInterface'                                            => 'EventEspresso\core\services\notices\NoticeConverterInterface',
-            'EventEspresso\core\services\notices\NoticeConverterInterface'        => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
-            'NoticesContainerInterface'                                           => 'EventEspresso\core\services\notices\NoticesContainerInterface',
-            'EventEspresso\core\services\notices\NoticesContainerInterface'       => 'EventEspresso\core\services\notices\NoticesContainer',
-            'EventEspresso\core\services\request\RequestInterface'                => 'EventEspresso\core\services\request\Request',
-            'EventEspresso\core\services\request\ResponseInterface'               => 'EventEspresso\core\services\request\Response',
-            'EventEspresso\core\domain\DomainInterface'                           => 'EventEspresso\core\domain\Domain',
-        );
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            $this->_aliases['EventEspresso\core\services\notices\NoticeConverterInterface'] = 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices';
-        }
-    }
-
-
-
-    /**
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
-     * request Primarily used by unit tests.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function reset()
-    {
-        $this->_register_core_class_loaders();
-        $this->_register_core_dependencies();
-    }
+	/**
+	 * This means that the requested class dependency is not present in the dependency map
+	 */
+	const not_registered = 0;
+
+	/**
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
+	 */
+	const load_new_object = 1;
+
+	/**
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
+	 */
+	const load_from_cache = 2;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to keep any existing dependencies that already exist,
+	 * and simply discard any new dependencies declared in the incoming data
+	 */
+	const KEEP_EXISTING_DEPENDENCIES = 0;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to overwrite any existing dependencies that already exist using the incoming data
+	 */
+	const OVERWRITE_DEPENDENCIES = 1;
+
+
+
+	/**
+	 * @type EE_Dependency_Map $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * @type RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @type LegacyRequestInterface $legacy_request
+	 */
+	protected $legacy_request;
+
+	/**
+	 * @type ResponseInterface $response
+	 */
+	protected $response;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @type array $_dependency_map
+	 */
+	protected $_dependency_map = array();
+
+	/**
+	 * @type array $_class_loaders
+	 */
+	protected $_class_loaders = array();
+
+	/**
+	 * @type array $_aliases
+	 */
+	protected $_aliases = array();
+
+
+
+	/**
+	 * EE_Dependency_Map constructor.
+	 */
+	protected function __construct()
+	{
+		// add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+		do_action('EE_Dependency_Map____construct');
+	}
+
+
+
+	/**
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function initialize()
+	{
+		$this->_register_core_dependencies();
+		$this->_register_core_class_loaders();
+		$this->_register_core_aliases();
+	}
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Dependency_Map
+	 */
+	public static function instance() {
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Dependency_Map) {
+			self::$_instance = new EE_Dependency_Map(/*$request, $response, $legacy_request*/);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param LegacyRequestInterface $legacy_request
+	 */
+	public function setLegacyRequest(LegacyRequestInterface $legacy_request)
+	{
+		$this->legacy_request = $legacy_request;
+	}
+
+
+	/**
+	 * @param ResponseInterface $response
+	 */
+	public function setResponse(ResponseInterface $response)
+	{
+		$this->response = $response;
+	}
+
+
+
+	/**
+	 * @param LoaderInterface $loader
+	 */
+	public function setLoader(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+
+	/**
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public static function register_dependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
+	}
+
+
+
+	/**
+	 * Assigns an array of class names and corresponding load sources (new or cached)
+	 * to the class specified by the first parameter.
+	 * IMPORTANT !!!
+	 * The order of elements in the incoming $dependencies array MUST match
+	 * the order of the constructor parameters for the class in question.
+	 * This is especially important when overriding any existing dependencies that are registered.
+	 * the third parameter controls whether any duplicate dependencies are overwritten or not.
+	 *
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public function registerDependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		$class = trim($class, '\\');
+		$registered = false;
+		if (empty(self::$_instance->_dependency_map[ $class ])) {
+			self::$_instance->_dependency_map[ $class ] = array();
+		}
+		// we need to make sure that any aliases used when registering a dependency
+		// get resolved to the correct class name
+		foreach ($dependencies as $dependency => $load_source) {
+			$alias = self::$_instance->get_alias($dependency);
+			if (
+				$overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
+				|| ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+			) {
+				unset($dependencies[$dependency]);
+				$dependencies[$alias] = $load_source;
+				$registered = true;
+			}
+		}
+		// now add our two lists of dependencies together.
+		// using Union (+=) favours the arrays in precedence from left to right,
+		// so $dependencies is NOT overwritten because it is listed first
+		// ie: with A = B + C, entries in B take precedence over duplicate entries in C
+		// Union is way faster than array_merge() but should be used with caution...
+		// especially with numerically indexed arrays
+		$dependencies += self::$_instance->_dependency_map[ $class ];
+		// now we need to ensure that the resulting dependencies
+		// array only has the entries that are required for the class
+		// so first count how many dependencies were originally registered for the class
+		$dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+		// if that count is non-zero (meaning dependencies were already registered)
+		self::$_instance->_dependency_map[ $class ] = $dependency_count
+			// then truncate the  final array to match that count
+			? array_slice($dependencies, 0, $dependency_count)
+			// otherwise just take the incoming array because nothing previously existed
+			: $dependencies;
+		return $registered;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $loader
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function register_class_loader($class_name, $loader = 'load_core')
+	{
+		if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+			throw new DomainException(
+				esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
+			);
+		}
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
+		if (
+			! is_callable($loader)
+			&& (
+				strpos($loader, 'load_') !== 0
+				|| ! method_exists('EE_Registry', $loader)
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid loader method on EE_Registry.',
+						'event_espresso'
+					),
+					$loader
+				)
+			);
+		}
+		$class_name = self::$_instance->get_alias($class_name);
+		if (! isset(self::$_instance->_class_loaders[$class_name])) {
+			self::$_instance->_class_loaders[$class_name] = $loader;
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function dependency_map()
+	{
+		return $this->_dependency_map;
+	}
+
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name
+	 *
+	 * @param string $class_name
+	 * @return boolean
+	 */
+	public function has($class_name = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		return isset($this->_dependency_map[$class_name]) ? true : false;
+	}
+
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return bool
+	 */
+	public function has_dependency_for_class($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->get_alias($dependency);
+		return isset($this->_dependency_map[$class_name][$dependency])
+			? true
+			: false;
+	}
+
+
+
+	/**
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return int
+	 */
+	public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->get_alias($dependency);
+		return $this->has_dependency_for_class($class_name, $dependency)
+			? $this->_dependency_map[$class_name][$dependency]
+			: EE_Dependency_Map::not_registered;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @return string | Closure
+	 */
+	public function class_loader($class_name)
+	{
+		// all legacy models use load_model()
+		if(strpos($class_name, 'EEM_') === 0){
+			return 'load_model';
+		}
+		$class_name = $this->get_alias($class_name);
+		return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function class_loaders()
+	{
+		return $this->_class_loaders;
+	}
+
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $class_name the class name that should be used (concrete class to replace interface)
+	 * @param string $alias      the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class  the class that has the dependency (is type hinting for the interface)
+	 */
+	public function add_alias($class_name, $alias, $for_class = '')
+	{
+		if ($for_class !== '') {
+			if (! isset($this->_aliases[$for_class])) {
+				$this->_aliases[$for_class] = array();
+			}
+			$this->_aliases[$for_class][$class_name] = $alias;
+		}
+		$this->_aliases[$class_name] = $alias;
+	}
+
+
+
+	/**
+	 * returns TRUE if the provided class name has an alias
+	 *
+	 * @param string $class_name
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function has_alias($class_name = '', $for_class = '')
+	{
+		return isset($this->_aliases[$for_class][$class_name])
+			   || (
+				   isset($this->_aliases[$class_name])
+				   && ! is_array($this->_aliases[$class_name])
+			   );
+	}
+
+
+
+	/**
+	 * returns alias for class name if one exists, otherwise returns the original classname
+	 * functions recursively, so that multiple aliases can be used to drill down to a classname
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $class_name
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function get_alias($class_name = '', $for_class = '')
+	{
+		if (! $this->has_alias($class_name, $for_class)) {
+			return $class_name;
+		}
+		if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) {
+			return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
+		}
+		return $this->get_alias($this->_aliases[$class_name]);
+	}
+
+
+
+	/**
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
+	 * This is done by using the following class constants:
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
+	 */
+	protected function _register_core_dependencies()
+	{
+		$this->_dependency_map = array(
+			'EE_Request_Handler'                                                                                          => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_System'                                                                                                   => array(
+				'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Session'                                                                                                  => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
+				'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Cart'                                                                                                     => array(
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Front_Controller'                                                                                         => array(
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messenger_Collection_Loader'                                                                              => array(
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Type_Collection_Loader'                                                                           => array(
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Resource_Manager'                                                                                 => array(
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_Factory'                                                                                          => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_messages'                                                                                                 => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Generator'                                                                                       => array(
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Processor'                                                                                       => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Queue'                                                                                           => array(
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Messages_Template_Defaults'                                                                               => array(
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_To_Generate_From_Request'                                                                         => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandBus'                                                             => array(
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\services\commands\CommandHandler'                                                              => array(
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\database\TableManager'                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Data_Migration_Class_Base'                                                                                => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_1_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_2_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_3_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_4_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_5_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_6_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_7_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_8_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_9_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\assets\Registry'                                                                 => array(
+				'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\BasicCacheManager'                        => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                  => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array(
+				'EE_Registration_Config'                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\values\EmailAddress'                              => array(
+				null,
+				'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\orm\ModelFieldFactory' => array(
+				'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
+			),
+			'LEGACY_MODELS'                                                   => array(
+				null,
+				'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Module_Request_Router' => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Registration_Processor' => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array(
+				null,
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Admin_Transactions_List_Table' => array(
+				null,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\modules\ticket_selector\ProcessTicketSelector' => array(
+				'EE_Core_Config' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => array(
+				'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
+			),
+		);
+	}
+
+
+
+	/**
+	 * Registers how core classes are loaded.
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
+	 *        'EE_Request_Handler' => 'load_core'
+	 *        'EE_Messages_Queue'  => 'load_lib'
+	 *        'EEH_Debug_Tools'    => 'load_helper'
+	 * or, if greater control is required, by providing a custom closure. For example:
+	 *        'Some_Class' => function () {
+	 *            return new Some_Class();
+	 *        },
+	 * This is required for instantiating dependencies
+	 * where an interface has been type hinted in a class constructor. For example:
+	 *        'Required_Interface' => function () {
+	 *            return new A_Class_That_Implements_Required_Interface();
+	 *        },
+	 *
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _register_core_class_loaders()
+	{
+		//for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
+		//be used in a closure.
+		$request = &$this->request;
+		$response = &$this->response;
+		$legacy_request = &$this->legacy_request;
+		// $loader = &$this->loader;
+		$this->_class_loaders = array(
+			//load_core
+			'EE_Capabilities'          => 'load_core',
+			'EE_Encryption'            => 'load_core',
+			'EE_Front_Controller'      => 'load_core',
+			'EE_Module_Request_Router' => 'load_core',
+			'EE_Registry'              => 'load_core',
+			'EE_Request'               => function () use (&$legacy_request) {
+				return $legacy_request;
+			},
+			'EventEspresso\core\services\request\Request' => function () use (&$request) {
+				return $request;
+			},
+			'EventEspresso\core\services\request\Response' => function () use (&$response) {
+				return $response;
+			},
+			'EE_Request_Handler'       => 'load_core',
+			'EE_Session'               => 'load_core',
+			'EE_Cron_Tasks'            => 'load_core',
+			'EE_System'                => 'load_core',
+			'EE_Maintenance_Mode'      => 'load_core',
+			'EE_Register_CPTs'         => 'load_core',
+			'EE_Admin'                 => 'load_core',
+			//load_lib
+			'EE_Message_Resource_Manager'          => 'load_lib',
+			'EE_Message_Type_Collection'           => 'load_lib',
+			'EE_Message_Type_Collection_Loader'    => 'load_lib',
+			'EE_Messenger_Collection'              => 'load_lib',
+			'EE_Messenger_Collection_Loader'       => 'load_lib',
+			'EE_Messages_Processor'                => 'load_lib',
+			'EE_Message_Repository'                => 'load_lib',
+			'EE_Messages_Queue'                    => 'load_lib',
+			'EE_Messages_Data_Handler_Collection'  => 'load_lib',
+			'EE_Message_Template_Group_Collection' => 'load_lib',
+			'EE_Payment_Method_Manager'            => 'load_lib',
+			'EE_Messages_Generator'                => function () {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Generator',
+					array(),
+					false,
+					false
+				);
+			},
+			'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Template_Defaults',
+					$arguments,
+					false,
+					false
+				);
+			},
+			//load_model
+			// 'EEM_Attendee'                         => 'load_model',
+			// 'EEM_Message_Template_Group'           => 'load_model',
+			// 'EEM_Message_Template'                 => 'load_model',
+			//load_helper
+			'EEH_Parse_Shortcodes'                 => function () {
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
+					return new EEH_Parse_Shortcodes();
+				}
+				return null;
+			},
+			'EE_Template_Config'                   => function () {
+				return EE_Config::instance()->template_settings;
+			},
+			'EE_Currency_Config'                   => function () {
+				return EE_Config::instance()->currency;
+			},
+			'EE_Registration_Config'                   => function () {
+				return EE_Config::instance()->registration;
+			},
+			'EE_Core_Config'                   => function () {
+				return EE_Config::instance()->core;
+			},
+			'EventEspresso\core\services\loaders\Loader' => function () {
+				return LoaderFactory::getLoader();
+			},
+		);
+	}
+
+
+
+	/**
+	 * can be used for supplying alternate names for classes,
+	 * or for connecting interface names to instantiable classes
+	 */
+	protected function _register_core_aliases()
+	{
+		$this->_aliases = array(
+			'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
+			'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
+			'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
+			'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
+			'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
+			'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
+			'CreateRegCodeCommandHandler'                                                  => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand',
+			'CreateRegUrlLinkCommandHandler'                                               => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand',
+			'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+			'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
+			'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
+			'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
+			'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
+			'CreateTransactionCommandHandler'                                     => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
+			'CreateAttendeeCommandHandler'                                        => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
+			'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
+			'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
+			'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
+			'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
+			'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
+			'CommandFactoryInterface'                                                     => 'EventEspresso\core\services\commands\CommandFactoryInterface',
+			'EventEspresso\core\services\commands\CommandFactoryInterface'                => 'EventEspresso\core\services\commands\CommandFactory',
+			'EventEspresso\core\domain\services\session\SessionIdentifierInterface'       => 'EE_Session',
+			'EmailValidatorInterface'                                                     => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
+			'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
+			'NoticeConverterInterface'                                            => 'EventEspresso\core\services\notices\NoticeConverterInterface',
+			'EventEspresso\core\services\notices\NoticeConverterInterface'        => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
+			'NoticesContainerInterface'                                           => 'EventEspresso\core\services\notices\NoticesContainerInterface',
+			'EventEspresso\core\services\notices\NoticesContainerInterface'       => 'EventEspresso\core\services\notices\NoticesContainer',
+			'EventEspresso\core\services\request\RequestInterface'                => 'EventEspresso\core\services\request\Request',
+			'EventEspresso\core\services\request\ResponseInterface'               => 'EventEspresso\core\services\request\Response',
+			'EventEspresso\core\domain\DomainInterface'                           => 'EventEspresso\core\domain\Domain',
+		);
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			$this->_aliases['EventEspresso\core\services\notices\NoticeConverterInterface'] = 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices';
+		}
+	}
+
+
+
+	/**
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
+	 * request Primarily used by unit tests.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function reset()
+	{
+		$this->_register_core_class_loaders();
+		$this->_register_core_dependencies();
+	}
 
 
 }

core/services/Benchmark.php

Indentation +328 added lines, -328 removed lines

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

Spacing +10 added lines, -10 removed lines

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